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

אתם יכולים להציג את רשימת הלקוחות שיש לכם גישה אליהם באמצעות השיטה 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 יש להם גישה ישירה.

דוגמה לקוד שממחישה את השימוש ב-method‏ CustomerService.ListAccessibleCustomers:

Java

// 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

Python

#!/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