הצגת רשימה של חשבונות נגישים

אפשר להציג רשימה של לקוחות שיש לכם גישה אליהם באמצעות השיטה ListAccessibleCustomers ב-CustomerService. עם זאת, חשוב להבין אילו לקוחות מוחזרים בסוג הבקשה הזה.

לקוחות נגישים היא אחת מהבקשות היחידות ב-Google Ads API שבהן לא צריך לציין מספר לקוח בבקשה, והמערכת תתעלם מכל login-customer-id שסופק.

רשימת הלקוחות שתתקבל מבוססת על פרטי הכניסה שלכם ל-OAuth. הבקשה תחזיר רשימה של כל החשבונות שאתם יכולים לבצע בהם פעולה ישירות באמצעות פרטי הכניסה הקיימים. היא לא תכלול בהכרח את כל החשבונות בהיררכיית החשבון. היא תכלול רק חשבונות שבהם המשתמש המאומת נוסף עם הרשאת אדמין או הרשאות אחרות בחשבון.

נניח שאתם משתמשים A בתפקיד אדמין עבור M1 ו-C3 בשתי ההיררכיות שמופיעות למעלה. אם תבצעו קריאה ל-Google Ads API, למשל ל-GoogleAdsService, תוכלו לגשת למידע על החשבונות M1, C1, C2 ו-C3. עם זאת, קריאה אל CustomerService.ListAccessibleCustomers תחזיר רק M1 ו-C3, כי אלו החשבונות היחידים שבהם למשתמש A יש גישה ישירה.

הנה דוגמה לקוד שממחיש את השימוש ב-method 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);
    }
  }
}
ListAccessibleCustomers.java
      

C#

public void Run(GoogleAdsClient client)
{
    // Get the CustomerService.
    CustomerServiceClient customerService = client.GetService(Services.V16.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;
    }
}
ListAccessibleCustomers.cs
      

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

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

Ruby

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
list_accessible_customers.rb
      

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;
}
list_accessible_customers.pl
      

הצגת רשימה של חשבונות שבוטלו

Google Ads API לא מאפשר לרשום את החשבונות שבוטלו בחשבון ניהול. עם זאת, אפשר להשתמש בפתרון החלופי הבא כדי לאחזר את הרשימה הזו.

1. מאחזרים את רשימת הקישורים של ACTIVE באמצעות המשאב customer_client_link ויוצרים רשימה של לקוחות באמצעות השדה 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
   

2. מאחזרים את הרשימה של חשבונות ENABLED באמצעות המשאב customer_client.

   SELECT customer_client.id, customer_client.descriptive_name FROM customer_client
   

3. ההפרש בין שתי הרשימות מציג את רשימת החשבונות שבוטלו.