作为 Google Ads 管理员，您可以管理 Google Ads 账号的用户访问权限邀请。
邀请用户
您可以在管理对 Google Ads 帐号的访问权限的过程中向新用户发送电子邮件邀请。为此，请使用 CustomerUserAccessInvitationService 的 MutateCustomerUserAccessInvitation 方法创建新的 CustomerUserAccessInvitation。电子邮件邀请需要由收到邀请的用户手动接受。用户也可以使用备用邮箱接受邀请。
以下代码段展示了如何发送邀请：
Java
// 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#
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
// 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
);
Python
invitation_operation = client.get_type(
"CustomerUserAccessInvitationOperation"
)
invitation = invitation_operation.create
invitation.email_address = email_address
invitation.access_role = client.enums.AccessRoleEnum[access_role].value
response = 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}"
)
Ruby
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}'."
Perl
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::V16::Resources::CustomerUserAccessInvitation->new({
emailAddress => $email_address,
accessRole => $access_role
});
# Create the user access invitation operation.
my $invitation_operation =
Google::Ads::GoogleAds::V16::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;
}
撤消邀请
您可以使用 CustomerUserAccessInvitationService 的 MutateCustomerUserAccessInvitation 方法移除 CustomerUserAccessInvitation，从而撤消邀请。
检索用户邀请
如需检索待处理的用户邀请列表，您可以构建一个 Google Ads 查询语言语句，以查询与某个客户 ID 关联的所有 CustomerUserAccessInvitation 实体。以下是一个典型的查询：
SELECT
customer_user_access_invitation.invitation_id,
customer_user_access_invitation.email_address,
customer_user_access_invitation.access_role,
customer_user_access_invitation.invitation_status,
customer_user_access_invitation.creation_date_time
FROM
customer_user_access_invitation
您可以添加其他过滤条件，以检索邀请的子集。
例如，一个常见用例是检索待处理的用户邀请列表。这可以通过过滤 customer_user_access_invitation.invitation_status = PENDING 来实现：