Répertorier les comptes accessibles

Vous pouvez répertorier les clients auxquels vous avez accès avec la méthode ListAccessibleCustomers dans CustomerService. Cependant, il est nécessaire de comprendre quels clients sont renvoyés dans ce type de requête.

Répertorier les clients accessibles est l'une des rares requêtes de l'API Search Ads 360 Reporting pour lesquelles vous ne devez pas spécifier de numéro client et qui ignorent tout login-customer-id fourni.

La liste de clients obtenue est basée sur vos identifiants OAuth. La requête renvoie une liste de tous les comptes sur lesquels vous pouvez agir directement à partir de vos identifiants actuels. Cela n'inclura pas nécessairement tous les comptes de la hiérarchie, mais uniquement ceux sur lesquels votre utilisateur authentifié a été ajouté avec des droits d'administration ou d'autres droits sur le compte.

Imaginez que vous êtes l'utilisateur A, qui est administrateur des comptes M1 et C3 dans les deux hiérarchies illustrées ci-dessus. Si vous appelez l'API Search Ads 360 Reporting (par exemple, SearchAds360Service), vous pouvez accéder aux informations des comptes M1, C1, C2 et C3. Toutefois, un appel à CustomerService.ListAccessibleCustomers ne renverrait que M1 et C3, car il s'agit des seuls comptes pour lesquels l'utilisateur A dispose d'un accès direct.

Voici un exemple de code illustrant l'utilisation de la méthode 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);
    }
  }
}

Télécharger 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()

Télécharger list_accessible_customers.py