Skip to main content
Invite User With Access Role Stay organized with collections
Save and categorize content based on your preferences.
Java
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package
com.google.ads.googleads.examples.accountmanagement
;
import
com.beust.jcommander.Parameter
;
import
com.google.ads.googleads.examples.utils.ArgumentNames
;
import
com.google.ads.googleads.examples.utils.CodeSampleParams
;
import
com.google.ads.googleads.lib.GoogleAdsClient
;
import
com.google.ads.googleads.v21.enums.AccessRoleEnum.AccessRole
;
import
com.google.ads.googleads.v21.errors.GoogleAdsError
;
import
com.google.ads.googleads.v21.errors.GoogleAdsException
;
import
com.google.ads.googleads.v21.resources.CustomerUserAccessInvitation
;
import
com.google.ads.googleads.v21.services.CustomerUserAccessInvitationOperation
;
import
com.google.ads.googleads.v21.services.CustomerUserAccessInvitationServiceClient
;
import
com.google.ads.googleads.v21.services.MutateCustomerUserAccessInvitationResponse
;
import
java.io.FileNotFoundException
;
import
java.io.IOException
;
/** Sends an invitation email to a user to manage a customer account with a desired access role. */
public
class
InviteUserWithAccessRole
{
private
static
class
InviteUserWithAccessRoleParams
extends
CodeSampleParams
{
@Parameter
(
names
=
ArgumentNames
.
CUSTOMER_ID
,
required
=
true
)
private
long
customerId
;
@Parameter
(
names
=
ArgumentNames
.
EMAIL_ADDRESS
,
required
=
true
)
private
String
emailAddress
;
@Parameter
(
names
=
ArgumentNames
.
ACCESS_ROLE
,
required
=
true
)
private
AccessRole
accessRole
;
}
public
static
void
main
(
String
[]
args
)
{
InviteUserWithAccessRoleParams
params
=
new
InviteUserWithAccessRoleParams
();
if
(
!
params
.
parseArguments
(
args
))
{
// Either pass the required parameters for this example on the command line, or insert them
// into the code here. See the parameter class definition above for descriptions.
params
.
customerId
=
Long
.
parseLong
(
"INSERT_CUSTOMER_ID_HERE"
);
params
.
emailAddress
=
"INSERT_EMAIL_ADDRESS_HERE"
;
params
.
accessRole
=
AccessRole
.
valueOf
(
"INSERT_ACCESS_ROLE_HERE"
);
}
GoogleAdsClient
googleAdsClient
=
null
;
try
{
googleAdsClient
=
GoogleAdsClient
.
newBuilder
().
fromPropertiesFile
().
build
();
}
catch
(
FileNotFoundException
fnfe
)
{
System
.
err
.
printf
(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n"
,
fnfe
);
System
.
exit
(
1
);
}
catch
(
IOException
ioe
)
{
System
.
err
.
printf
(
"Failed to create GoogleAdsClient. Exception: %s%n"
,
ioe
);
System
.
exit
(
1
);
}
try
{
new
InviteUserWithAccessRole
()
.
runExample
(
googleAdsClient
,
params
.
customerId
,
params
.
emailAddress
,
params
.
accessRole
);
}
catch
(
GoogleAdsException
gae
)
{
// GoogleAdsException is the base class for most exceptions thrown by an API request.
// Instances of this exception have a message and a GoogleAdsFailure that contains a
// collection of GoogleAdsErrors that indicate the underlying causes of the
// GoogleAdsException.
System
.
err
.
printf
(
"Request ID %s failed due to GoogleAdsException. Underlying errors:%n"
,
gae
.
getRequestId
());
int
i
=
0
;
for
(
GoogleAdsError
googleAdsError
:
gae
.
getGoogleAdsFailure
().
getErrorsList
())
{
System
.
err
.
printf
(
" Error %d: %s%n"
,
i
++
,
googleAdsError
);
}
System
.
exit
(
1
);
}
}
/** Runs the exmaple. */
private
void
runExample
(
GoogleAdsClient
googleAdsClient
,
Long
customerId
,
String
emailAddress
,
AccessRole
accessRole
)
{
// Constructs an access invitation.
CustomerUserAccessInvitation
invitation
=
CustomerUserAccessInvitation
.
newBuilder
()
.
setEmailAddress
(
emailAddress
)
.
setAccessRole
(
accessRole
)
.
build
();
// Constructs an operation to send the invitation.
CustomerUserAccessInvitationOperation
operation
=
CustomerUserAccessInvitationOperation
.
newBuilder
().
setCreate
(
invitation
).
build
();
// Creates a CustomerUserAccessInvitationServiceClient.
try
(
CustomerUserAccessInvitationServiceClient
client
=
googleAdsClient
.
getLatestVersion
().
createCustomerUserAccessInvitationServiceClient
())
{
// Issues the request.
MutateCustomerUserAccessInvitationResponse
response
=
client
.
mutateCustomerUserAccessInvitation
(
String
.
valueOf
(
customerId
),
operation
);
// Prints some information about the result.
System
.
out
.
printf
(
"Customer user access invitation was sent for customerId = "
+
"%d to email address = '%s' and access role = '%s'. The invitation resource "
+
"name is '%s'.%n"
,
customerId
,
emailAddress
,
accessRole
,
response
.
getResult
().
getResourceName
());
}
}
}
C#
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using
CommandLine
;
using
Google.Ads.Gax.Examples
;
using
Google.Ads.GoogleAds.Lib
;
using
Google.Ads.GoogleAds.V21.Errors
;
using
Google.Ads.GoogleAds.V21.Resources
;
using
Google.Ads.GoogleAds.V21.Services
;
using
System
;
using
System.Collections.Generic
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
AccessRoleEnum
.
Types
;
namespace
Google.Ads.GoogleAds.Examples.V21
{
/// <summary>
/// This code example sends an invitation email to a user to manage a customer
/// account with a desired access role.
/// </summary>
public
class
InviteUserWithAccessRole
:
ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="InviteUserWithAccessRole"/> example.
/// </summary>
public
class
Options
:
OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the call is made.")]
public
long
CustomerId
{
get
;
set
;
}
/// <summary>
/// Email address of the user to send the invitation to.
/// </summary>
[Option("emailAddress", Required = true, HelpText =
"Email address of the user to send the invitation to.")]
public
string
EmailAddress
{
get
;
set
;
}
/// <summary>
/// The access role for which the user is invited.
/// </summary>
[Option("accessRole", Required = true, HelpText =
"The access role for which the user is invited.")]
public
AccessRole
AccessRole
{
get
;
set
;
}
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public
static
void
Main
(
string
[]
args
)
{
Options
options
=
ExampleUtilities
.
ParseCommandLine<Options>
(
args
);
InviteUserWithAccessRole
codeExample
=
new
InviteUserWithAccessRole
();
Console
.
WriteLine
(
codeExample
.
Description
);
codeExample
.
Run
(
new
GoogleAdsClient
(),
options
.
CustomerId
,
options
.
EmailAddress
,
options
.
AccessRole
);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public
override
string
Description
=
> "This code example sends an invitation email to a user to manage a customer account "
+
"with a desired access role."
;
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="emailAddress">Email address of the user to send the invitation to.</param>
/// <param name="accessRole">The access role for which the user is invited.</param>
public
void
Run
(
GoogleAdsClient
client
,
long
customerId
,
string
emailAddress
,
AccessRole
accessRole
)
{
// Get the CustomerUserAccessInvitationService.
CustomerUserAccessInvitationServiceClient
service
=
client
.
GetService
(
Services
.
V21
.
CustomerUserAccessInvitationService
);
MutateCustomerUserAccessInvitationRequest
invitationRequest
=
new
MutateCustomerUserAccessInvitationRequest
()
{
CustomerId
=
customerId
.
ToString
(),
Operation
=
new
CustomerUserAccessInvitationOperation
()
{
Create
=
new
CustomerUserAccessInvitation
()
{
EmailAddress
=
emailAddress
,
AccessRole
=
accessRole
},
}
};
try
{
var
response
=
service
.
MutateCustomerUserAccessInvitation
(
invitationRequest
);
Console
.
WriteLine
(
"Customer user access invitation was sent for customerId = "
+
"{0} to email address = {1} and access role = {2}. The invitation resource "
+
"name is {3}."
,
customerId
,
emailAddress
,
accessRole
,
response
.
Result
.
ResourceName
);
}
catch
(
GoogleAdsException
e
)
{
Console
.
WriteLine
(
"Failure:"
);
Console
.
WriteLine
(
$"Message: {e.Message}"
);
Console
.
WriteLine
(
$"Failure: {e.Failure}"
);
Console
.
WriteLine
(
$"Request ID: {e.RequestId}"
);
throw
;
}
}
}
}
PHP
< ?php
/**
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\Ads\GoogleAds\Examples\AccountManagement;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsException;
use Google\Ads\GoogleAds\V21\Enums\AccessRoleEnum\AccessRole;
use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V21\Resources\CustomerUserAccessInvitation;
use Google\Ads\GoogleAds\V21\Services\CustomerUserAccessInvitationOperation;
use Google\Ads\GoogleAds\V21\Services\MutateCustomerUserAccessInvitationRequest;
use Google\ApiCore\ApiException;
/**
* This code example sends an invitation email to a user to manage a customer account with a
* desired access role.
*/
class InviteUserWithAccessRole
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
// Email address of the user to send the invitation to.
private const EMAIL_ADDRESS = 'INSERT_EMAIL_ADDRESS_HERE';
// The access role for which the user is invited, such as 'ADMIN'. Must be one of the names of
// the constants defined in AccessRoleEnum/AccessRole.php.
private const ACCESS_ROLE = 'INSERT_ACCESS_ROLE_HERE';
public static function main()
{
// Either pass the required parameters for this example on the command line, or insert them
// into the constants above.
$options = (new ArgumentParser())->parseCommandArguments([
ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::EMAIL_ADDRESS => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::ACCESS_ROLE => GetOpt::REQUIRED_ARGUMENT
]);
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::EMAIL_ADDRESS] ?: self::EMAIL_ADDRESS,
$options[ArgumentNames::ACCESS_ROLE] ?: self::ACCESS_ROLE
);
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
exit(1);
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
exit(1);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $emailAddress the email address of the user to send the invitation to
* @param string $accessRole the access role for which the user is invited
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $emailAddress,
string $accessRole
) {
// Creates a customer user access invitation.
$customerUserAccessInvitation = new CustomerUserAccessInvitation([
'email_address' => $emailAddress,
'access_role' => AccessRole::value($accessRole)
]);
// Creates a customer user access invitation operation.
$customerUserAccessInvitationOperation = new CustomerUserAccessInvitationOperation();
$customerUserAccessInvitationOperation->setCreate($customerUserAccessInvitation);
// Issues a mutate request to send the customer user access invitation and prints its
// information.
$customerUserAccessInvitationServiceClient =
$googleAdsClient->getCustomerUserAccessInvitationServiceClient();
$response = $customerUserAccessInvitationServiceClient->mutateCustomerUserAccessInvitation(
MutateCustomerUserAccessInvitationRequest::build(
$customerId,
$customerUserAccessInvitationOperation
)
);
printf(
"Customer user access invitation with resource name '%s' was sent from customer "
. "ID %d to email address '%s' with access role '%s'.%s",
$response->getResult()->getResourceName(),
$customerId,
$emailAddress,
$accessRole,
PHP_EOL
);
}
}
InviteUserWithAccessRole::main();
Python
#!/usr/bin/env python
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This code example sends an invitation email to a user.
The invitation is to manage a customer account with a desired access role.
"""
import
argparse
import
sys
from
google.ads.googleads.client
import
GoogleAdsClient
from
google.ads.googleads.errors
import
GoogleAdsException
from
google.ads.googleads.v21.services.services.customer_user_access_invitation_service.client
import
(
CustomerUserAccessInvitationServiceClient
,
)
from
google.ads.googleads.v21.services.types.customer_user_access_invitation_service
import
(
CustomerUserAccessInvitationOperation
,
MutateCustomerUserAccessInvitationResponse
,
)
from
google.ads.googleads.v21.resources.types.customer_user_access_invitation
import
(
CustomerUserAccessInvitation
,
)
# AccessRoleEnum is part of google.ads.googleads.v19.enums.types.access_role
# but it's accessed via client.enums.AccessRoleEnum, so direct import for type hint might not be strictly needed for the parameter.
# The field invitation.access_role expects an int (the enum value).
def
main
(
client
:
GoogleAdsClient
,
customer_id
:
str
,
email_address
:
str
,
access_role
:
str
,
)
-
> None
:
"""The main method that creates all necessary entities for the example.
Args:
client: An initialized GoogleAdsClient instance.
customer_id: The client customer ID str.
email_address: The email address for the user receiving the invitation.
access_role: The desired access role for the invitee (e.g., "ADMIN", "STANDARD").
"""
service
:
CustomerUserAccessInvitationServiceClient
=
client
.
get_service
(
"CustomerUserAccessInvitationService"
)
invitation_operation
:
CustomerUserAccessInvitationOperation
=
(
client
.
get_type
(
"CustomerUserAccessInvitationOperation"
)
)
invitation
:
CustomerUserAccessInvitation
=
invitation_operation
.
create
invitation
.
email_address
=
email_address
# The access_role field in the CustomerUserAccessInvitation message expects
# an AccessRoleEnum value (which is an int).
invitation
.
access_role
=
client
.
enums
.
AccessRoleEnum
[
access_role
]
.
value
response
:
MutateCustomerUserAccessInvitationResponse
=
(
service
.
mutate_customer_user_access_invitation
(
customer_id
=
customer_id
,
operation
=
invitation_operation
)
)
print
(
"Customer user access invitation was sent for "
f
"customer ID: '
{
customer_id
}
', "
f
"email address
{
email_address
}
, and "
f
"access role
{
access_role
}
. The invitation resource name is: "
f
"
{
response
.
result
.
resource_name
}
"
)
if
__name__
==
"__main__"
:
parser
=
argparse
.
ArgumentParser
(
description
=
(
"Sends an invitation email to a user to manage a customer "
"account with a desired access role."
)
)
# The following argument(s) should be provided to run the example.
parser
.
add_argument
(
"-c"
,
"--customer_id"
,
type
=
str
,
required
=
True
,
help
=
"The Google Ads customer ID."
,
)
parser
.
add_argument
(
"-e"
,
"--email_address"
,
type
=
str
,
required
=
True
,
help
=
"The email address of the user to send the invitation to."
,
)
parser
.
add_argument
(
"-a"
,
"--access_role"
,
type
=
str
,
required
=
True
,
choices
=
[
e
.
name
for
e
in
googleads_client
.
enums
.
AccessRoleEnum
],
help
=
"The updated user access role."
,
)
args
=
parser
.
parse_args
()
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client
=
GoogleAdsClient
.
load_from_storage
(
version
=
"v21"
)
try
:
main
(
googleads_client
,
args
.
customer_id
,
args
.
email_address
,
args
.
access_role
,
)
except
GoogleAdsException
as
ex
:
print
(
f
'Request with ID "
{
ex
.
request_id
}
" failed with status '
f
'"
{
ex
.
error
.
code
()
.
name
}
" and includes the following errors:'
)
for
error
in
ex
.
failure
.
errors
:
print
(
f
'
\t
Error with message "
{
error
.
message
}
".'
)
if
error
.
location
:
for
field_path_element
in
error
.
location
.
field_path_elements
:
print
(
f
"
\t\t
On field:
{
field_path_element
.
field_name
}
"
)
sys
.
exit
(
1
)
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This code example sends an invitation email to a user to manage a customer
# account with a desired access role.
require
'optparse'
require
'google/ads/google_ads'
def
invite_user_with_access_role
(
customer_id
,
email_address
,
access_role
)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client
=
Google
::
Ads
::
GoogleAds
::
GoogleAdsClient
.
new
operation
=
client
.
operation
.
create_resource
.
customer_user_access_invitation
do
|
inv
|
inv
.
email_address
=
email_address
inv
.
access_role
=
access_role
end
# Issues a mutate request to get the response.
response
=
client
.
service
.
customer_user_access_invitation
.
mutate_customer_user_access_invitation
(
customer_id
:
customer_id
,
operation
:
operation
,
)
# Prints out information of the created invitation.
puts
"Customer user access invitation was sent for customerId =
#{
customer_id
}
"
\
"email address = '
#{
email_address
}
', "
\
"access role = '
#{
access_role
}
'."
end
if
__FILE__
==
$PROGRAM_NAME
options
=
{}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
options
[
:customer_id
]
=
'INSERT_CUSTOMER_ID_HERE'
options
[
:email_address
]
=
'INSERT_EMAIL_ADDRESS_HERE'
options
[
:access_role
]
=
'INSERT_ACCESS_ROLE_HERE'
OptionParser
.
new
do
|
opts
|
opts
.
banner
=
sprintf
(
'Usage: ruby %s [options]'
,
File
.
basename
(
__FILE__
))
opts
.
separator
''
opts
.
separator
'Options:'
opts
.
on
(
'-C'
,
'--customer-id CUSTOMER-ID'
,
String
,
'Customer ID'
)
do
|
v
|
options
[
:customer_id
]
=
v
end
opts
.
on
(
'-E'
,
'--email-address EMAIL-ADDRESS'
,
String
,
'Email Address'
)
do
|
v
|
options
[
:email_address
]
=
v
end
opts
.
on
(
'-R'
,
'--access-role ACCESS-ROLE'
,
String
,
'Access Role'
)
do
|
v
|
options
[
:access_role
]
=
v
end
opts
.
separator
''
opts
.
separator
'Help:'
opts
.
on_tail
(
'-h'
,
'--help'
,
'Show this message'
)
do
puts
opts
exit
end
end
.
parse!
begin
invite_user_with_access_role
(
options
.
fetch
(
:customer_id
)
.
tr
(
"-"
,
""
),
options
.
fetch
(
:email_address
),
options
.
fetch
(
:access_role
)
.
to_sym
,
)
rescue
Google
::
Ads
::
GoogleAds
::
Errors
::
GoogleAdsError
=
> e
e
.
failure
.
errors
.
each
do
|
error
|
STDERR
.
printf
(
"Error with message: %s
\n
"
,
error
.
message
)
if
error
.
location
error
.
location
.
field_path_elements
.
each
do
|
field_path_element
|
STDERR
.
printf
(
"
\t
On field: %s
\n
"
,
field_path_element
.
field_name
)
end
end
error
.
error_code
.
to_h
.
each
do
|
k
,
v
|
next
if
v
==
:UNSPECIFIED
STDERR
.
printf
(
"
\t
Type: %s
\n\t
Code: %s
\n
"
,
k
,
v
)
end
end
raise
end
end
Perl
#!/usr/bin/perl -w
#
# Copyright 2021, Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This code example sends an invitation email to a user to manage a customer
# account with a desired access role.
use
strict
;
use
warnings
;
use
utf8
;
use
FindBin
qw($Bin)
;
use
lib
"$Bin/../../lib"
;
use
Google::Ads::GoogleAds::Client
;
use
Google::Ads::GoogleAds::Utils::GoogleAdsHelper
;
use
Google::Ads::GoogleAds::V21::Resources::CustomerUserAccessInvitation
;
use
Google::Ads::GoogleAds::V21::Services::CustomerUserAccessInvitationService::CustomerUserAccessInvitationOperation
;
use
Getopt::Long
qw(:config auto_help)
;
use
Pod::Usage
;
use
Cwd
qw(abs_path)
;
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my
$customer_id
=
"INSERT_CUSTOMER_ID_HERE"
;
my
$email_address
=
"INSERT_EMAIL_ADDRESS_HERE"
;
# See Google::Ads::GoogleAds::V21::Enums::AccessRoleEnum for optional values.
my
$access_role
=
"INSERT_ACCESS_ROLE_HERE"
;
sub
invite_user_with_access_role
{
my
(
$api_client
,
$customer_id
,
$email_address
,
$access_role
)
=
@_
;
# Create the user access invitation.
my
$user_access_invitation
=
Google::Ads::GoogleAds::V21::Resources::
CustomerUserAccessInvitation
-
> new
({
emailAddress
=
> $email_address
,
accessRole
=
> $access_role
});
# Create the user access invitation operation.
my
$invitation_operation
=
Google::Ads::GoogleAds::V21::Services::CustomerUserAccessInvitationService::
CustomerUserAccessInvitationOperation
-
> new
({
create
=
> $user_access_invitation
});
# Send the user access invitation.
my
$invitation_response
=
$api_client
-
> CustomerUserAccessInvitationService
()
-
> mutate
({
customerId
=
> $customer_id
,
operation
=
> $invitation_operation
});
printf
"Customer user access invitation was sent for customerId = %d "
.
"to email address = '%s' and access role = '%s'. "
.
"The invitation resource name is '%s'.\n"
,
$customer_id
,
$email_address
,
$access_role
,
$invitation_response
-
> {
result
}{
resourceName
};
return
1
;
}
# Don't run the example if the file is being included.
if
(
abs_path
(
$0
)
ne
abs_path
(
__FILE__
))
{
return
1
;
}
# Get Google Ads Client, credentials will be read from ~/googleads.properties.
my
$api_client
=
Google::Ads::GoogleAds::
Client
-
> new
();
# By default examples are set to die on any server returned fault.
$api_client
-
> set_die_on_faults
(
1
);
# Parameters passed on the command line will override any parameters set in code.
GetOptions
(
"customer_id=s"
=
> \
$customer_id
,
"email_address=s"
=
> \
$email_address
,
"access_role=s"
=
> \
$access_role
);
# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage
(
2
)
if
not
check_params
(
$customer_id
,
$email_address
,
$access_role
);
# Call the example.
invite_user_with_access_role
(
$api_client
,
$customer_id
=~
s/-//g
r
,
$email_address
,
$access_role
);
=pod
=head1 NAME
invite_user_with_access_role
=head1 DESCRIPTION
This code example sends an invitation email to a user to manage a customer
account with a desired access role.
=head1 SYNOPSIS
invite_user_with_access_role.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-email_address Email address of the user to send the invitation to.
-access_role The user access role, e.g. ADMIN, STANDARD, READ_ONLY
and EMAIL_ONLY.
=cut
curl
#
Copyright 2025
Google LLC #
Licensed under the Apache License, Version 2
.0 (
the "License"
)
;
#
you may not use this file except in
compliance with the License. #
You may obtain a copy of the License at #
https://www.apache.org/licenses/LICENSE-2.0 #
Unless required by applicable law or agreed to in
writing, software #
distributed under the License is distributed on an "AS IS"
BASIS, #
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
See the License for
the specific language governing permissions and #
limitations under the License. #
This code example sends an invitation email to a user. #
#
The invitation is to manage a customer account with a desired access role. #
#
Variables: #
API_VERSION, #
CUSTOMER_ID, #
DEVELOPER_TOKEN, #
MANAGER_CUSTOMER_ID, #
OAUTH2_ACCESS_TOKEN: #
See https://developers.google.com/google-ads/api/rest/auth#request_headers #
for
details. #
#
EMAIL_ADDRESS: The email address of the user to invite. curl -f --request POST \
"https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/customerUserAccessInvitations:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data @- <<EOF
{
"operation": {
"create": {
"emailAddress": "${EMAIL_ADDRESS}",
"accessRole": "ADMIN"
}
}
}
EOF
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eThese code snippets demonstrate inviting a user to manage a Google Ads customer account with a specific access role, achieved by sending an invitation email.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves initializing a Google Ads client, creating an invitation object with the user's email and access role, sending the request to the Google Ads API, and handling potential errors.\u003c/p\u003e\n"],["\u003cp\u003eThe code is provided in Java, C#, PHP, and Python, each following a similar structure of client initialization, invitation creation, request sending, response printing, and error handling.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCustomerUserAccessInvitationService\u003c/code\u003e is the core API used to send the invitation, while components like \u003ccode\u003eCustomerUserAccessInvitation\u003c/code\u003e and \u003ccode\u003eCustomerUserAccessInvitationOperation\u003c/code\u003e represent the invitation object and operation respectively.\u003c/p\u003e\n"],["\u003cp\u003eExamples in Python, Ruby, and Perl highlight language-specific nuances but share common elements such as retrieving input, constructing the invitation, sending the request via the client library, and handling errors.\u003c/p\u003e\n"]]],[],null,[]]
