فهرست کردن حساب‌های دردسترس

می‌توانید مشتریانی را که با روش 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 در آن‌ها دسترسی مستقیم دارد.

در اینجا نمونه کدی برای نشان دادن نحوه استفاده از 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);
    }
  }
}

C#‎

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

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

پرل

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;
}

فر کردن

# Returns the resource names of customers directly accessible by the user
# authenticating the call.
#
# Variables:
#   API_VERSION,
#   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 "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \

فهرست کردن حساب‌های لغوشده

برای بازیابی حساب‌های تحت حساب مدیری که لغو شده‌اند، مستقیماً منبع customer_client را پُرسمان کنید و براساس status فیلتر کنید:

SELECT
  customer_client.id,
  customer_client.descriptive_name,
  customer_client.status
FROM customer_client
WHERE customer_client.status = 'CANCELED'
قبلی
پیوند به حساب‌های مدیر
بعدی
دریافت سلسله‌مراتب حساب