Login customer ID

Stay organized with collections Save and categorize content based on your preferences.

The login-customer-id is a required header in the Search Ads 360 Reporting API when using a manager account to access an operating customer account. If accessing an operating customer account directly, the login-customer-id header is not required.

If the authenticated user has access to both the manager and operating customer accounts, then login-customer-id should be specified to avoid any ambiguity. Though not specifying login-customer-id would still work in this case, the context is set to the operating customer account only (which is probably not what is intended).

If you've been managing accounts with just OAuth2 credentials of a manager account, follow these steps to obtain the correct login-customer-id value:

  1. List accessible customers

    // 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.beust.jcommander.Parameter;
    import com.google.ads.searchads360.v0.lib.SearchAds360Client;
    import com.google.ads.searchads360.v0.resources.CustomerClient;
    import com.google.ads.searchads360.v0.services.SearchAds360Row;
    import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
    import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;
    import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;
    
    /** Get customer client details. */
    public class GetCustomerClient {
      private static class GetCustomerClientParams extends CodeSampleParams {
    
        @Parameter(names = "--customerId", required = true)
        private String customerId;
    
        @Parameter(names = "--loginCustomerId")
        private String loginCustomerId;
      }
    
      public static void main(String[] args) {
        GetCustomerClientParams params = new GetCustomerClientParams();
        if (!params.parseArguments(args)) {
          // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
          // here. If neither are set, customerId will be used as loginCustomerId.
          // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
        }
        final String loginCustomerId = params.loginCustomerId;
        final String customerId = params.customerId;
    
        try {
          // Creates a SearchAds360Client with the specified loginCustomerId. If there's
          // no loginCustomerId, customerId will be used instead.
          final SearchAds360Client searchAds360Client =
              SearchAds360Client.newBuilder()
                  .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
                  .fromPropertiesFile()
                  .build();
          // Creates the Search Ads 360 Service client.
          SearchAds360ServiceClient client = searchAds360Client.create();
          new GetCustomerClient().runExample(client, customerId);
        } catch (Exception exception) {
          System.err.printf("Failed with exception: %s%n", exception);
          exception.printStackTrace();
          System.exit(1);
        }
      }
    
      private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
        // Creates a query that retrieves all child accounts of the customerId specified in search
        // calls below.
        String query =
            "SELECT customer_client.descriptive_name, customer_client.client_customer,"
                + " customer_client.status FROM customer_client";
        SearchSearchAds360Request request =
            SearchSearchAds360Request.newBuilder().setCustomerId(customerId).setQuery(query).build();
    
        // Issues a search request.
        final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
        for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
          CustomerClient customerClient = element.getCustomerClient();
          System.out.printf(
              "CustomerClient found with name '%s', customer %s, and status: %s.%n",
              customerClient.getDescriptiveName(),
              customerClient.getClientCustomer(),
              customerClient.getStatus());
        }
      }
    }
    

    Download GetCustomerClient.java

  2. Determine manager account hierarchy

    // 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.beust.jcommander.Parameter;
    import com.google.ads.searchads360.v0.lib.SearchAds360Client;
    import com.google.ads.searchads360.v0.services.SearchAds360Row;
    import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
    import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;
    import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;
    
    /** Get manager details. */
    public class GetManagers {
      private static class GetManagersParams extends CodeSampleParams {
    
        @Parameter(names = "--customerId", required = true)
        private String customerId;
    
        @Parameter(names = "--loginCustomerId")
        private String loginCustomerId;
      }
    
      public static void main(String[] args) {
        GetManagersParams params = new GetManagersParams();
        if (!params.parseArguments(args)) {
          // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
          // here. If neither are set, customerId will be used as loginCustomerId.
          // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
        }
        final String loginCustomerId = params.loginCustomerId;
        final String customerId = params.customerId;
    
        try {
          // Creates a SearchAds360Client with the specified loginCustomerId. If there's
          // no loginCustomerId, customerId will be used instead.
          final SearchAds360Client searchAds360Client =
              SearchAds360Client.newBuilder()
                  .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
                  .fromPropertiesFile()
                  .build();
          // Creates the Search Ads 360 Service client.
          SearchAds360ServiceClient client = searchAds360Client.create();
          new GetManagers().runExample(client, customerId);
        } catch (Exception exception) {
          System.err.printf("Failed with exception: %s%n", exception);
          exception.printStackTrace();
          System.exit(1);
        }
      }
    
      private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
        // Creates a query that retrieves manager for the customer.
        String query =
            "SELECT customer_manager_link.manager_customer, customer_manager_link.status FROM"
                + " customer_manager_link";
        SearchSearchAds360Request request =
            SearchSearchAds360Request.newBuilder().setCustomerId(customerId).setQuery(query).build();
    
        // Issues a search request.
        final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
        for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
          System.out.printf(
              "Manager found with customer '%s' and status: %s.%n",
              element.getCustomerManagerLink().getManagerCustomer(),
              element.getCustomerManagerLink().getStatus());
        }
      }
    }
    

    Download GetManagers.java

  3. Select the appropriate manager account.

    If there are multiple manager accounts for a given operating customer account, select the manager account at the top of the hierarchy. This lets you maintain the same login-customer-id for multiple calls throughout the hierarchy of accounts and thereby avoid excessive switching.