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

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

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