Barrierefreie Konten auflisten

Mit der Methode ListAccessibleCustomers in CustomerService können Sie Kunden auflisten, auf die Sie Zugriff haben. Sie müssen jedoch wissen, welche Kunden in dieser Art von Anfrage zurückgegeben werden.

Das Auflisten zugänglicher Kunden ist eine der wenigen Anfragen in der Google Ads API, bei denen Sie keine Kundennummern angeben müssen. Die angegebene login-customer-id wird ignoriert.

Die resultierende Kundenliste basiert auf Ihren OAuth-Anmeldedaten. Die Anfrage gibt eine Liste aller Konten zurück, für die Sie mit Ihren aktuellen Anmeldedaten direkt arbeiten können. Dies umfasst nicht unbedingt alle Konten innerhalb der Kontohierarchie, sondern nur Konten, denen Ihr authentifizierter Nutzer mit Administrator- oder anderen Rechten für das Konto hinzugefügt wurde.

Angenommen, Sie sind Nutzer A. Er ist Administrator für M1 und C3 in den beiden oben abgebildeten Hierarchien. Wenn Sie die Google Ads API aufrufen, z. B. GoogleAdsService, können Sie auf Informationen zu den Konten M1, C1, C2 und C3 zugreifen. Bei einem Aufruf von CustomerService.ListAccessibleCustomers werden jedoch nur M1 und C3 zurückgegeben, da dies die einzigen Konten sind, bei denen der Nutzer A direkten Zugriff hat.

Hier ist ein Codebeispiel, das die Verwendung der Methode CustomerService.ListAccessibleCustomers veranschaulicht:

Java

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);
    }
  }
}
ListAccessibleCustomers.java
      

C#

public void Run(GoogleAdsClient client)
{
    // Get the CustomerService.
    CustomerServiceClient customerService = client.GetService(Services.V16.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;
    }
}
ListAccessibleCustomers.cs
      

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);
    }
}
ListAccessibleCustomers.php
      

Python

def main(client):
    customer_service = client.get_service("CustomerService")

    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'Customer resource name: "{resource_name}"')
list_accessible_customers.py
      

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
list_accessible_customers.rb
      

Perl

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;
}
list_accessible_customers.pl
      

Aufgelöste Konten auflisten

Die Google Ads API bietet keine direkte Möglichkeit, die aufgelösten Konten in einem Verwaltungskonto aufzulisten. Sie können diese Liste jedoch mit der folgenden Problemumgehung abrufen.

1. Rufen Sie die Liste der ACTIVE-Links mithilfe der Ressource customer_client_link ab und erstellen Sie mithilfe des Felds customer_client_link.client_customer eine Liste der Kunden.

   SELECT customer_client_link.client_customer, customer_client_link.status FROM
       customer_client_link WHERE customer_client_link.status = ACTIVE
   

2. Rufen Sie die Liste der ENABLED-Konten mit der Ressource customer_client ab.

   SELECT customer_client.id, customer_client.descriptive_name FROM customer_client
   

3. Der Unterschied zwischen den beiden Listen ergibt sich aus der Liste der aufgelösten Konten.