您可以使用 CustomerService
中的 ListAccessibleCustomers
方法列出可存取的客戶。不過,您必須瞭解這類要求中會傳回哪些客戶。
「可供存取的客戶」是 Google Ads API 中的其中一種要求,您不必在要求中指定客戶 ID,而且系統會忽略所有提供的 login-customer-id
。
系統會根據您的 OAuth 憑證產生客戶清單。這項要求會傳回您直接根據您目前的憑證操作的所有帳戶清單。但不一定包括帳戶階層中的所有帳戶;只有已驗證使用者,且具有帳戶管理員或其他權限的帳戶,才會納入其中。
假設您是使用者 A
,而且是上方兩個階層中的 M1
和 C3
管理員。如果您呼叫 Google Ads API (例如 GoogleAdsService
),可以存取 M1
、C1
、C2
和 C3
的相關資訊。不過,對 CustomerService.ListAccessibleCustomers
的呼叫只會傳回 M1
和 C3
,因為這是使用者 A
擁有「直接」直接存取權的唯一帳戶。
以下程式碼範例說明如何使用 CustomerService.ListAccessibleCustomers
方法:
Java
private void runExample(GoogleAdsClient client) { // Optional: Change credentials to use a different refresh token, to retrieve customers // available for a specific user. // // UserCredentials credentials = // UserCredentials.newBuilder() // .setClientId("INSERT_OAUTH_CLIENT_ID") // .setClientSecret("INSERT_OAUTH_CLIENT_SECRET") // .setRefreshToken("INSERT_REFRESH_TOKEN") // .build(); // // client = client.toBuilder().setCredentials(credentials).build(); try (CustomerServiceClient customerService = client.getLatestVersion().createCustomerServiceClient()) { ListAccessibleCustomersResponse response = customerService.listAccessibleCustomers( ListAccessibleCustomersRequest.newBuilder().build()); System.out.printf("Total results: %d%n", response.getResourceNamesCount()); for (String customerResourceName : response.getResourceNamesList()) { System.out.printf("Customer resource name: %s%n", customerResourceName); } } }
C#
public void Run(GoogleAdsClient client) { // Get the CustomerService. CustomerServiceClient customerService = client.GetService(Services.V17.CustomerService); try { // Retrieve the list of customer resources. string[] customerResourceNames = customerService.ListAccessibleCustomers(); // Display the result. foreach (string customerResourceName in customerResourceNames) { Console.WriteLine( $"Found customer with resource name = '{customerResourceName}'."); } } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample(GoogleAdsClient $googleAdsClient) { $customerServiceClient = $googleAdsClient->getCustomerServiceClient(); // Issues a request for listing all accessible customers. $accessibleCustomers = $customerServiceClient->listAccessibleCustomers(new ListAccessibleCustomersRequest()); print 'Total results: ' . count($accessibleCustomers->getResourceNames()) . PHP_EOL; // Iterates over all accessible customers' resource names and prints them. foreach ($accessibleCustomers->getResourceNames() as $resourceName) { /** @var string $resourceName */ printf("Customer resource name: '%s'%s", $resourceName, PHP_EOL); } }
Python
def main(client): customer_service = client.get_service("CustomerService") accessible_customers = customer_service.list_accessible_customers() result_total = len(accessible_customers.resource_names) print(f"Total results: {result_total}") resource_names = accessible_customers.resource_names for resource_name in resource_names: print(f'Customer resource name: "{resource_name}"')
小茹
def list_accessible_customers() # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new accessible_customers = client.service.customer.list_accessible_customers().resource_names accessible_customers.each do |resource_name| puts "Customer resource name: #{resource_name}" end end
Perl
sub list_accessible_customers { my ($api_client) = @_; my $list_accessible_customers_response = $api_client->CustomerService()->list_accessible_customers(); printf "Total results: %d.\n", scalar @{$list_accessible_customers_response->{resourceNames}}; foreach my $resource_name (@{$list_accessible_customers_response->{resourceNames}}) { printf "Customer resource name: '%s'.\n", $resource_name; } return 1; }
列出已取消的帳戶
Google Ads API 無法直接列出管理員帳戶下的已取消帳戶。不過,您可以使用以下解決方法擷取這份清單。
使用
customer_client_link
資源擷取ACTIVE
連結清單,並使用customer_client_link.client_customer
欄位列出客戶清單。SELECT customer_client_link.client_customer, customer_client_link.status FROM customer_client_link WHERE customer_client_link.status = ACTIVE
使用
customer_client
資源擷取ENABLED
帳戶清單。SELECT customer_client.id, customer_client.descriptive_name FROM customer_client
兩份清單的差異會顯示已取消的帳戶清單。