فهرست حساب های قابل دسترسی

شما می‌توانید مشتریانی را که در دسترس شما هستند با استفاده از متد ListAccessibleCustomers در CustomerService فهرست کنید. با این حال، لازم است بدانید که کدام مشتریان در این نوع درخواست بازگردانده می‌شوند.

فهرست کردن مشتریان قابل دسترسی یکی از معدود درخواست‌هایی در API گوگل ادز است که نیازی به مشخص کردن شناسه مشتری در درخواست ندارد و این درخواست هرگونه login-customer-id ارائه شده را نادیده می‌گیرد. فهرست حاصل از مشتریان بر اساس اعتبارنامه‌های OAuth شما است. این درخواست فهرستی از تمام حساب‌هایی را که می‌توانید مستقیماً با توجه به اعتبارنامه‌های فعلی خود روی آنها اقدام کنید، برمی‌گرداند. این لزوماً شامل تمام حساب‌های موجود در سلسله مراتب حساب نمی‌شود؛ بلکه فقط شامل حساب‌هایی می‌شود که کاربر تأیید شده شما با دسترسی ادمین یا سایر حقوق در حساب اضافه شده است.

تصور کنید شما کاربر A هستید که در دو سلسله مراتب نشان داده شده در شکل، مدیر M1 و C3 هستید. اگر بخواهید API تبلیغات گوگل، مثلاً GoogleAdsService را فراخوانی کنید، می‌توانید به اطلاعات حساب‌های M1 ، C1 ، C2 و C3 دسترسی پیدا کنید. با این حال، فراخوانی CustomerService.ListAccessibleCustomers فقط M1 و C3 را برمی‌گرداند، زیرا این دو تنها حساب‌هایی هستند که کاربر A به آنها دسترسی مستقیم دارد.

در اینجا یک مثال کد وجود دارد که نحوه‌ی استفاده از متد CustomerService.ListAccessibleCustomers را نشان می‌دهد:

جاوا

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
      

سی شارپ

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

پی اچ پی

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
      

پایتون

def main(client: GoogleAdsClient) -> None:
    customer_service: CustomerServiceClient = client.get_service(
        "CustomerService"
    )

    accessible_customers: ListAccessibleCustomersResponse = (
        customer_service.list_accessible_customers()
    )
    result_total: int = len(accessible_customers.resource_names)
    print(f"Total results: {result_total}")

    resource_names: List[str] = accessible_customers.resource_names
    for resource_name in resource_names:  # resource_name is implicitly str
        print(f'Customer resource name: "{resource_name}"')
list_accessible_customers.py
      

روبی

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
      

پرل

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
      

حلقه زدن

# Returns the resource names of customers directly accessible by the user
# authenticating the call.
#
# Variables:
#   API_VERSION,
#   DEVELOPER_TOKEN,
#   OAUTH2_ACCESS_TOKEN:
#     See https://developers.google.com/google-ads/api/rest/auth#request_headers
#     for details.
#
curl -f --request GET \
"https://googleads.googleapis.com/v${API_VERSION}/customers:listAccessibleCustomers" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
list_accessible_customers.sh
      

لیست حساب‌های لغو شده

API گوگل ادز روش مستقیمی برای فهرست کردن حساب‌های لغو شده در زیر حساب مدیریت ارائه نمی‌دهد. با این حال، می‌توانید از راه حل زیر برای بازیابی این لیست استفاده کنید.

1. با استفاده از منبع 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
   

2. با استفاده از منبع customer_client ، لیست حساب‌های ENABLED را بازیابی کنید.

   SELECT customer_client.id, customer_client.descriptive_name FROM customer_client
   

3. تفاوت بین این دو لیست، لیست حساب‌های لغو شده را به شما می‌دهد.