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

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

فهرست کردن مشتریان قابل دسترسی یکی از معدود درخواست‌هایی است که در Search Ads 360 Reporting API نیازی به تعیین شناسه مشتری در درخواست ندارد و هرگونه login-customer-id ارائه شده را نادیده می‌گیرد.

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

تصور کنید کاربر A هستید که در دو سلسله مراتب تصویر بالا مدیر M1 و C3 است. اگر می‌خواهید با Search Ads 360 Reporting API تماس بگیرید، برای مثال با SearchAds360Service ، می‌توانید به اطلاعات حساب‌های M1 ، C1 ، C2 ، و C3 دسترسی داشته باشید. با این حال، تماس با CustomerService.ListAccessibleCustomers فقط M1 و C3 را برمی گرداند زیرا این حساب ها تنها حساب هایی هستند که کاربر A دسترسی مستقیم دارد.

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

جاوا

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package sample;

import com.google.ads.searchads360.v0.lib.SearchAds360Client;
import com.google.ads.searchads360.v0.services.CustomerServiceClient;
import com.google.ads.searchads360.v0.services.ListAccessibleCustomersRequest;
import com.google.ads.searchads360.v0.services.ListAccessibleCustomersResponse;

/** List all customers that can be accessed by the authenticated Google account. */
public class ListAccessibleCustomers {

  public static void main(String[] args) {
    try {
      // Creates a SearchAds360Client with local properties file
      final SearchAds360Client searchAds360Client =
          SearchAds360Client.newBuilder().fromPropertiesFile().build();
      // Creates the Customer Service Client.
      CustomerServiceClient client = searchAds360Client.createCustomerServiceClient();
      new ListAccessibleCustomers().runExample(client);
    } catch (Exception exception) {
      System.err.printf("Failed with exception: %s%n", exception);
      exception.printStackTrace();
      System.exit(1);
    }
  }

  private void runExample(CustomerServiceClient customerServiceClient) {
    ListAccessibleCustomersResponse response =
        customerServiceClient.listAccessibleCustomers(
            ListAccessibleCustomersRequest.getDefaultInstance());

    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 را دانلود کنید

پایتون

#!/usr/bin/env python
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Lists all accessible customers."""

import traceback
from util_searchads360 import SearchAds360Client


def main(client) -> None:
  customer_service = client.get_customer_service()

  # Issues a list accessible customer request.
  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'Accessible customer resource name: "{resource_name}"')


if __name__ == "__main__":
  # SearchAds360Client will read the search-ads-360.yaml configuration file in
  # the home directory if none is specified.
  search_ads_360_client = SearchAds360Client.load_from_file()

  try:
    main(search_ads_360_client)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

list_accessible_customers.py را دانلود کنید