Manage User Access Invitations

Page Summary

Google Ads administrators can manage user access invitations to a Google Ads account.
Invitations are sent by creating a new CustomerUserAccessInvitation using the MutateCustomerUserAccessInvitation method.
Sent invitations must be manually accepted by the user, and the status can take up to 24 hours to update after acceptance.
Invitations can be revoked by removing the CustomerUserAccessInvitation using the MutateCustomerUserAccessInvitation method.
Pending user invitations can be retrieved by querying customer_user_access_invitation entities using Google Ads Query Language, potentially filtering by invitation_status = PENDING .

As a Google Ads administrator, you can manage user access invitations to a Google Adss account.

Invite users

You can send an email invitation to a new user as part of managing access to a Google Ads account . This is done by creating a new CustomerUserAccessInvitation using the MutateCustomerUserAccessInvitation method of the CustomerUserAccessInvitationService . The email invitation needs to be manually accepted by the user who received the invitation. The invitation can also be accepted by the user using an alternate email address. It can take up to 24 hours for the status to change from pending once the invitation is accepted.

If Google determines that a multi-party approval is required:

The MutateCustomerUserAccessInvitationResult will populate the multi_party_auth_review field containing the resource name of the pending review requiring approval.
The resource_name field will notbe populated.
A new invitation cannot be sent for the same email address until the pending multi-party approval request is resolved.
The pending review request can be approved or rejected by a second administrator using the ResolveMultiPartyAuthReview method. Refer to the multi-party approval guide to learn more.

This code snippet shows how to send an invitation:

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 
 ); 
  
 if 
  
 ( 
 response 
 . 
 getResult 
 (). 
 getMultiPartyAuthReview 
 (). 
 isEmpty 
 ()) 
  
 { 
  
 // A multi-party auth review was not triggered. 
  
 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 
 ()); 
  
 } 
  
 else 
  
 { 
  
 // A multi-party auth review was triggered. See 
  
 // FetchAndApprovePendingMultiPartyAuthReviews.java for an example on how to fetch 
  
 // and approve an MPA auth review. 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
  
 "A multi-party auth review was triggered. The MPA review resource name is %s. " 
  
 + 
  
 "Ask a second administrator to approve this request to send user access invitation. " 
  
 + 
  
 "See FetchAndApprovePendingMultiPartyAuthReviews.java for an example on " 
  
 + 
  
 "how to approve an MPA auth review using the API.%n" 
 , 
  
 response 
 . 
 getResult 
 (). 
 getMultiPartyAuthReview 
 ()); 
  
 } 
 } 
   InviteUserWithAccessRole 
 . 
 java

C#

 MutateCustomerUserAccessInvitationRequest 
  
 invitationRequest 
  
 = 
  
 new 
  
 MutateCustomerUserAccessInvitationRequest 
 () 
  
 { 
  
 CustomerId 
  
 = 
  
 customerId 
 . 
 ToString 
 (), 
  
 Operation 
  
 = 
  
 new 
  
 CustomerUserAccessInvitationOperation 
 () 
  
 { 
  
 Create 
  
 = 
  
 new 
  
 CustomerUserAccessInvitation 
 () 
  
 { 
  
 EmailAddress 
  
 = 
  
 emailAddress 
 , 
  
 AccessRole 
  
 = 
  
 accessRole 
  
 }, 
  
 } 
  
 }; 
 try 
 { 
  
 var 
  
 response 
  
 = 
  
 service 
 . 
 MutateCustomerUserAccessInvitation 
 ( 
 invitationRequest 
 ); 
  
 if 
  
 ( 
 response 
 . 
 Result 
 . 
 MultiPartyAuthReview 
  
 == 
  
 null 
 ) 
  
 { 
  
 // A multi-party auth review was not triggered. 
  
 Console 
 . 
 WriteLine 
 ( 
 "Customer user access invitation was sent for " 
  
 + 
  
 $"customerId = {customerId} to email address = {emailAddress} and " 
  
 + 
  
 $"access role = {accessRole}. The invitation resource name is " 
  
 + 
  
 $"{response.Result.ResourceName}." 
 ); 
  
 } 
  
 else 
  
  
 { 
  
 // A multi-party auth review was triggered. See 
  
 // FetchAndApprovePendingMultiPartyAuthReviews.cs for an example on how to fetch 
  
 // and approve an MPA auth review. 
  
 Console 
 . 
 WriteLine 
 ( 
 $"A multi-party auth review was triggered. The MPA review " 
  
 + 
  
 $"resource name is {response.Result.MultiPartyAuthReview}. Ask a second " 
  
 + 
  
 $"administrator to approve this request to send user access invitation. " 
  
 + 
  
 $"See FetchAndApprovePendingMultiPartyAuthReviews.cs for an example on " 
  
 + 
  
 $"how to approve an MPA auth review using the API." 
 ); 
  
 } 
 } 
 catch 
  
 ( 
 GoogleAdsException 
  
 e 
 ) 
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 "Failure:" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Message: {e.Message}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Failure: {e.Failure}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Request ID: {e.RequestId}" 
 ); 
  
 throw 
 ; 
 } 
   InviteUserWithAccessRole 
 . 
 cs

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 
 );  InviteUserWithAccessRole.php

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 ) ) if response . result . multi_party_auth_review : # A multi-party auth review was triggered. See # FetchAndApprovePendingMultiPartyAuthReviews.cs for an example on how # to fetch and approve an MPA auth review. print ( "A multi-party auth review was triggered. The MPA review resource " f "name is { response . result . multi_party_auth_review } . Ask a second " "administrator to approve this request to send user access invitation. " "See advanced_operations/fetch_and_approve_pending_multi_party_auth_reviews.py " "for an example on how to approve an MPA auth review using the API." ) else : # A multi-party auth review was not triggered. 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 } " )

invite_user_with_access_role . py

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 } '."

invite_user_with_access_role . rb

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::V24::Resources:: CustomerUserAccessInvitation - > new ({ emailAddress = > $email_address , accessRole = > $access_role }); # Create the user access invitation operation. my $invitation_operation = Google::Ads::GoogleAds::V24::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 }); if ( not $invitation_response - > { result }{ multiPartyAuthReview }) { 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 }; } else { printf "A multi-party auth review was triggered. The MPA review " . "resource name is '%s'. Ask a second administrator to approve this " . "request to send user access invitation. See " . "fetch_and_approve_pending_multi_party_auth_reviews.pl for an example " . "on how to approve an MPA auth review using the API.\n" , $invitation_response - > { result }{ multiPartyAuthReview }; } return 1 ; }

invite_user_with_access_role . pl

# 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

invite_user_with_access_role.sh

Retrieve user invitations

You can retrieve the list of pending user invitations by building a Google Ads Query Language statement to query all the CustomerUserAccessInvitation entities associated with a customer ID. Here is a typical query:

  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

You can add additional filtering conditions to retrieve subsets of invitations. For example, a common use case is to retrieve the list of pending user invitations by filtering for customer_user_access_invitation.invitation_status = PENDING .

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 2026-06-24 UTC.

Manage User Access Invitations

Page Summary

Invite users

Java

C#

PHP

Python

Ruby

Perl

curl

Revoke invitations

Retrieve user invitations

Manage User Access Invitations Stay organized with collections Save and categorize content based on your preferences.

Page Summary

Invite users

Java

C#

PHP

Python

Ruby

Perl

curl

Revoke invitations

Retrieve user invitations

Manage User Access Invitations