4.1.3 建立 Google Ads 帳戶或選擇現有帳戶
價值與業務影響
除了 Merchant Center 帳戶，商家還必須擁有 Google Ads 帳戶。如果您選擇了直接結算選項，建議您也允許他們使用現有帳戶 (他們可能已在放送其他類型的廣告)。
您可以使用 Google Ads API，透過程式輔助的方式建立 Google Ads 帳戶。 雖然您也可以依照設定 Google Ads 帳戶一文所述的步驟，代表商家手動進行此操作，但可擴充的做法則是透過程式輔助方式進行。
使用者體驗指南
合併帳單
如果您選擇使用合併帳單，則除了接受服務條款外，還可以在後端完全完成帳單設定。
如果是直接計費功能，系統會在 Google Ads 或 Merchant Center 的帳單設定過程中向商家顯示《Google 服務條款》，因此您不必在 UI 中向使用者公開這些服務條款。在「合併帳單」情境中，您必須向使用者顯示購物廣告政策和 Google Ads 政策，並記錄他們接受情形 (包含日期和版本)。
直接帳單
本節涵蓋的使用者體驗指南適用於直接計費情境，可讓您選擇向商家顯示完整的新手上路程序。
如果商家尚未完成 OAuth 步驟，請提示他們進行。建議您在流程開始時一次完成 OAuth，以便同時取得 Google Merchant Center 範圍和 Google Ads 範圍。偵測商家的任何現有 Google Ads 帳戶。如果偵測到一或多個帳戶，請提供連線至這些帳戶的選項。
如果商家選擇建立新帳戶，請嘗試在欄位中預先填入可用的商家相關資訊。在理想情況下，商家不必手動提供這項資訊，且建立新的 Google Ads 帳戶應只需按一下就能體驗。
建立帳戶後，您可以透過程式將 Google Ads 帳戶連結至商家的 Merchant Center 客戶帳戶。
下方為 Google Ads 帳戶連結步驟的總覽。 如果您參與了獎勵優待券計畫，且商家可能符合參加資格，請在 Google Ads 帳戶連結步驟 (詳情請見下一節) 中加入優待券資訊。
技術指南
如要使用 API 管理 Google Ads 帳戶，您必須以現有 Google Ads 管理員帳戶的使用者進行驗證。系統會在該管理員帳戶下建立新帳戶。
以下範例說明如何建立 GAQL 陳述式來查詢 CustomerClient 中 client_customer 欄位指定的所有子帳戶，並對副管理員帳戶定期執行，藉此取得管理員帳戶的帳戶階層。當這些範例是透過管理員帳戶存取子帳戶時，您必須提供 login-customer-id 並將其設為您的管理員帳戶 ID，才能執行任何範例。
Java
// Copyright 2020 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 com.google.ads.googleads.examples.accountmanagement;
import com.beust.jcommander.Parameter;
import com.google.ads.googleads.examples.utils.ArgumentNames;
import com.google.ads.googleads.examples.utils.CodeSampleParams;
import com.google.ads.googleads.lib.GoogleAdsClient;
import com.google.ads.googleads.v17.errors.GoogleAdsError;
import com.google.ads.googleads.v17.errors.GoogleAdsException;
import com.google.ads.googleads.v17.resources.CustomerClient;
import com.google.ads.googleads.v17.resources.CustomerName;
import com.google.ads.googleads.v17.services.CustomerServiceClient;
import com.google.ads.googleads.v17.services.GoogleAdsRow;
import com.google.ads.googleads.v17.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v17.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v17.services.ListAccessibleCustomersRequest;
import com.google.ads.googleads.v17.services.ListAccessibleCustomersResponse;
import com.google.ads.googleads.v17.services.SearchGoogleAdsRequest;
import com.google.common.base.Strings;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Queue;
/**
* Gets the account hierarchy of the specified manager account and login customer ID. If you don't
* specify manager ID and login customer ID, the example will instead print the hierarchies of all
* accessible customer accounts for your authenticated Google account. Note that if the list of
* accessible customers for your authenticated Google account includes accounts within the same
* hierarchy, this example will retrieve and print the overlapping portions of the hierarchy for
* each accessible customer.
*/
public class GetAccountHierarchy {
private static class GetAccountHierarchyParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.MANAGER_CUSTOMER_ID)
private Long managerId;
@Parameter(names = ArgumentNames.LOGIN_CUSTOMER_ID)
private Long loginCustomerId;
}
public static void main(String[] args) {
GetAccountHierarchyParams params = new GetAccountHierarchyParams();
if (!params.parseArguments(args)) {
// Optional: You may pass the managerId on the command line or specify a managerId here. If
// neither are set, a null value will be passed to the run example method, and the example
// will print the hierarchies of all accessible customer IDs.
// params.managerId = Long.parseLong("INSERT_MANAGER_ID_HERE");
// Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
// here if and only if the managerId is set. If the loginCustomerId is set neither on the
// command line nor below, a null value will be passed to the run example method, and the
// example will use each respective accessible customer ID as the loginCustomerId.
// params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
}
if (params.managerId != null && params.loginCustomerId == null) {
System.err.println("loginCustomerId must be provided if managerId is provided.");
return;
} else if (params.managerId == null && params.loginCustomerId != null) {
System.err.println("loginCustomerId may not be provided if managerId is not provided.");
return;
}
GoogleAdsClient googleAdsClient = null;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
System.exit(1);
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
System.exit(1);
}
try {
new GetAccountHierarchy()
.runExample(googleAdsClient, params.managerId, params.loginCustomerId);
} catch (GoogleAdsException gae) {
// GoogleAdsException is the base class for most exceptions thrown by an API request.
// Instances of this exception have a message and a GoogleAdsFailure that contains a
// collection of GoogleAdsErrors that indicate the underlying causes of the
// GoogleAdsException.
System.err.printf(
"Request ID %s failed due to GoogleAdsException. Underlying errors:%n",
gae.getRequestId());
int i = 0;
for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
System.err.printf(" Error %d: %s%n", i++, googleAdsError);
}
System.exit(1);
} catch (IOException ioe) {
System.err.printf("Request failed. Exception: %s%n", ioe);
System.exit(1);
}
}
/**
* Runs the example.
*
* @param googleAdsClient the Google Ads API client.
* @param managerId the root customer ID from which to begin the search.
* @param loginCustomerId the loginCustomerId used to create the GoogleAdsClient.
* @throws IOException if a Google Ads Client is not successfully created.
*/
private void runExample(GoogleAdsClient googleAdsClient, Long managerId, Long loginCustomerId)
throws IOException {
List<Long> seedCustomerIds = new ArrayList<>();
if (managerId == null) {
// Gets the account hierarchies for all accessible customers.
seedCustomerIds = getAccessibleCustomers(googleAdsClient);
} else {
// Only gets the hierarchy for the provided manager ID if provided.
seedCustomerIds.add(managerId);
}
Map<CustomerClient, Multimap<Long, CustomerClient>> allHierarchies = new HashMap<>();
List<Long> accountsWithNoInfo = new ArrayList<>();
// Constructs a map of account hierarchies.
for (Long seedCustomerId : seedCustomerIds) {
Map<CustomerClient, Multimap<Long, CustomerClient>> customerClientToHierarchy =
createCustomerClientToHierarchy(loginCustomerId, seedCustomerId);
if (customerClientToHierarchy == null) {
accountsWithNoInfo.add(seedCustomerId);
} else {
allHierarchies.putAll(customerClientToHierarchy);
}
}
// Prints the IDs of any accounts that did not produce hierarchy information.
if (!accountsWithNoInfo.isEmpty()) {
System.out.println(
"Unable to retrieve information for the following accounts which are likely either test "
+ "accounts or accounts with setup issues. Please check the logs for details.");
for (long accountId : accountsWithNoInfo) {
System.out.println(accountId);
}
System.out.println();
}
int depth = 0;
// Prints the hierarchy information for all accounts for which there is hierarchy information
// available.
for (CustomerClient rootCustomerClient : allHierarchies.keySet()) {
System.out.printf("Hierarchy of customer ID %d:%n", rootCustomerClient.getId());
printAccountHierarchy(rootCustomerClient, allHierarchies.get(rootCustomerClient), depth);
System.out.println();
}
}
/**
* Creates a map between a CustomerClient and each of its managers' mappings.
*
* @param loginCustomerId the loginCustomerId used to create the GoogleAdsClient.
* @param seedCustomerId the ID of the customer at the root of the tree.
* @return a map between a CustomerClient and each of its managers' mappings if the account
* hierarchy can be retrieved. If the account hierarchy cannot be retrieved, returns null.
* @throws IOException if a Google Ads Client is not successfully created.
*/
private Map<CustomerClient, Multimap<Long, CustomerClient>> createCustomerClientToHierarchy(
Long loginCustomerId, long seedCustomerId) throws IOException {
Queue<Long> managerAccountsToSearch = new LinkedList<>();
CustomerClient rootCustomerClient = null;
// Creates a GoogleAdsClient with the specified loginCustomerId. See
// https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid for more
// information.
GoogleAdsClient googleAdsClient =
GoogleAdsClient.newBuilder()
.fromPropertiesFile()
.setLoginCustomerId(loginCustomerId == null ? seedCustomerId : loginCustomerId)
.build();
// Creates the Google Ads Service client.
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
// Creates a query that retrieves all child accounts of the manager specified in search
// calls below.
String query =
"SELECT customer_client.client_customer, customer_client.level, "
+ "customer_client.manager, customer_client.descriptive_name, "
+ "customer_client.currency_code, customer_client.time_zone, "
+ "customer_client.id "
+ "FROM customer_client "
+ "WHERE customer_client.level <= 1";
// Adds the seed customer ID to the list of IDs to be processed.
managerAccountsToSearch.add(seedCustomerId);
// Performs a breadth-first search algorithm to build a mapping of managers to their
// child accounts.
Multimap<Long, CustomerClient> customerIdsToChildAccounts = ArrayListMultimap.create();
while (!managerAccountsToSearch.isEmpty()) {
long customerIdToSearchFrom = managerAccountsToSearch.poll();
SearchPagedResponse response;
try {
// Issues a search request.
response =
googleAdsServiceClient.search(
SearchGoogleAdsRequest.newBuilder()
.setQuery(query)
.setCustomerId(Long.toString(customerIdToSearchFrom))
.build());
// Iterates over all rows in all pages to get all customer clients under the specified
// customer's hierarchy.
for (GoogleAdsRow googleAdsRow : response.iterateAll()) {
CustomerClient customerClient = googleAdsRow.getCustomerClient();
// Gets the CustomerClient object for the root customer in the tree.
if (customerClient.getId() == seedCustomerId) {
rootCustomerClient = customerClient;
}
// The steps below map parent and children accounts. Continue here so that manager
// accounts exclude themselves from the list of their children accounts.
if (customerClient.getId() == customerIdToSearchFrom) {
continue;
}
// For all level-1 (direct child) accounts that are manager accounts, the above
// query will be run against them to create a map of managers to their
// child accounts for printing the hierarchy afterwards.
customerIdsToChildAccounts.put(customerIdToSearchFrom, customerClient);
// Checks if the child account is a manager itself so that it can later be processed
// and added to the map if it hasn't been already.
if (customerClient.getManager()) {
// A customer can be managed by multiple managers, so to prevent visiting the same
// customer multiple times, we need to check if it's already in the map.
boolean alreadyVisited =
customerIdsToChildAccounts.containsKey(customerClient.getId());
if (!alreadyVisited && customerClient.getLevel() == 1) {
managerAccountsToSearch.add(customerClient.getId());
}
}
}
} catch (GoogleAdsException gae) {
System.out.printf(
"Unable to retrieve hierarchy for customer ID %d: %s%n",
customerIdToSearchFrom, gae.getGoogleAdsFailure().getErrors(0).getMessage());
return null;
}
}
// The rootCustomerClient will be null if the account hierarchy was unable to be retrieved
// (e.g. the account is a test account or a client account with an incomplete billing setup).
// This method returns null in these cases to add the seedCustomerId to the list of
// customer IDs for which the account hierarchy could not be retrieved.
if (rootCustomerClient == null) {
return null;
}
Map<CustomerClient, Multimap<Long, CustomerClient>> customerClientToHierarchy =
new HashMap<>();
customerClientToHierarchy.put(rootCustomerClient, customerIdsToChildAccounts);
return customerClientToHierarchy;
}
}
/**
* Retrieves a list of accessible customers with the provided set up credentials.
*
* @param googleAdsClient the Google Ads API client.
* @return a list of customer IDs.
*/
private List<Long> getAccessibleCustomers(GoogleAdsClient googleAdsClient) {
List<Long> seedCustomerIds = new ArrayList<>();
// Issues a request for listing all accessible customers by this authenticated Google account.
try (CustomerServiceClient customerServiceClient =
googleAdsClient.getLatestVersion().createCustomerServiceClient()) {
ListAccessibleCustomersResponse accessibleCustomers =
customerServiceClient.listAccessibleCustomers(
ListAccessibleCustomersRequest.newBuilder().build());
System.out.println(
"No manager customer ID is specified. The example will print the "
+ "hierarchies of all accessible customer IDs:");
for (String customerResourceName : accessibleCustomers.getResourceNamesList()) {
Long customer = Long.parseLong(CustomerName.parse(customerResourceName).getCustomerId());
System.out.println(customer);
seedCustomerIds.add(customer);
}
}
return seedCustomerIds;
}
/**
* Prints the specified account's hierarchy using recursion.
*
* @param customerClient the customer client whose info will be printed and its child accounts
* will be processed if it's a manager.
* @param customerIdsToChildAccounts a map containing the account hierarchy information.
* @param depth the current depth we are printing from in the account hierarchy.
*/
private void printAccountHierarchy(
CustomerClient customerClient,
Multimap<Long, CustomerClient> customerIdsToChildAccounts,
int depth) {
String leadingSpace = " ";
if (depth == 0) {
System.out.println("Customer ID (Descriptive Name, Currency Code, Time Zone");
leadingSpace = "";
} else {
System.out.println("|");
}
System.out.print(Strings.repeat("-", depth * 2));
long customerId = customerClient.getId();
System.out.printf(
leadingSpace + "%d ('%s', '%s', '%s')%n",
customerId,
customerClient.getDescriptiveName(),
customerClient.getCurrencyCode(),
customerClient.getTimeZone());
// Recursively calls this function for all child accounts of customerClient if the current
// customer is a manager account.
for (CustomerClient childCustomer : customerIdsToChildAccounts.get(customerId)) {
printAccountHierarchy(childCustomer, customerIdsToChildAccounts, depth + 1);
}
}
}
C#
// Copyright 2020 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
//
// http://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.
using CommandLine;
using Google.Ads.Gax.Examples;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V17.Resources;
using Google.Ads.GoogleAds.V17.Services;
using Google.Api.Gax;
using System;
using System.Collections.Generic;
namespace Google.Ads.GoogleAds.Examples.V17
{
/// <summary>
/// This example gets the account hierarchy of the specified manager account. If you don't
/// specify manager customer ID, the example will instead print the hierarchies of all
/// accessible customer accounts for your authenticated Google account.
/// Note that if the list of accessible customers for your authenticated Google account
/// includes accounts within the same hierarchy, this example will retrieve and print
/// the overlapping portions of the hierarchy for each accessible customer.
/// </summary>
public class GetAccountHierarchy : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GetAccountHierarchy"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// Optional manager account ID. If none provided, this method will instead list the
/// accounts accessible from the authenticated Google Ads account.
/// </summary>
[Option("managerCustomerId", Required = true, HelpText =
"Optional manager account ID. If none provided, this method will instead list the" +
" accounts accessible from the authenticated Google Ads account.")]
public long? ManagerCustomerId { get; set; }
/// <summary>
/// The login customer ID used to create the GoogleAdsClient.
/// </summary>
[Option("loginCustomerId", Required = false, HelpText =
"The login customer ID used to create the GoogleAdsClient.")]
public long? LoginCustomerId { get; set; }
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args)
{
Options options = ExampleUtilities.ParseCommandLine<Options>(args);
GetAccountHierarchy codeExample = new GetAccountHierarchy();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(),
options.ManagerCustomerId,
options.LoginCustomerId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example gets the account hierarchy of a specified manager account. If " +
"you don't specify a manager customer ID, the example will instead print the " +
"hierarchies of all accessible customer accounts for your authenticated " +
"Google account.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="googleAdsClient">The Google Ads client instance.</param>
/// <param name="managerCustomerId">Optional manager account ID. If none provided, this method
/// will instead list the accounts accessible from the authenticated Google Ads account.
/// </param>
/// <param name="loginCustomerId">The login customer ID used to create the GoogleAdsClient.
/// </param>
public void Run(GoogleAdsClient googleAdsClient, long? managerCustomerId = null,
long? loginCustomerId = null)
{
if (loginCustomerId.HasValue)
{
googleAdsClient.Config.LoginCustomerId = loginCustomerId.Value.ToString();
}
GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.GetService(Services.V17.GoogleAdsService);
CustomerServiceClient customerServiceClient =
googleAdsClient.GetService(Services.V17.CustomerService);
// List of Customer IDs to handle.
List<long> seedCustomerIds = new List<long>();
// If a Manager ID was provided in the customerId parameter, it will be the only ID
// in the list. Otherwise, we will issue a request for all customers accessible by
// this authenticated Google account.
if (managerCustomerId.HasValue)
{
seedCustomerIds.Add(managerCustomerId.Value);
}
else
{
Console.WriteLine(
"No manager customer ID is specified. The example will print the hierarchies" +
" of all accessible customer IDs:");
string[] customerResourceNames = customerServiceClient.ListAccessibleCustomers();
foreach (string customerResourceName in customerResourceNames)
{
CustomerName customerName = CustomerName.Parse(customerResourceName);
Console.WriteLine(customerName.CustomerId);
seedCustomerIds.Add(long.Parse(customerName.CustomerId));
}
Console.WriteLine();
}
// Create a query that retrieves all child accounts of the manager specified in
// search calls below.
const string query = @"SELECT
customer_client.client_customer,
customer_client.level,
customer_client.manager,
customer_client.descriptive_name,
customer_client.currency_code,
customer_client.time_zone,
customer_client.id
FROM customer_client
WHERE
customer_client.level <= 1";
// Perform a breadth-first search to build a Dictionary that maps managers to their
// child accounts.
Dictionary<long, List<CustomerClient>> customerIdsToChildAccounts =
new Dictionary<long, List<CustomerClient>>();
foreach (long seedCustomerId in seedCustomerIds)
{
Queue<long> unprocessedCustomerIds = new Queue<long>();
unprocessedCustomerIds.Enqueue(seedCustomerId);
CustomerClient rootCustomerClient = null;
while (unprocessedCustomerIds.Count > 0)
{
managerCustomerId = unprocessedCustomerIds.Dequeue();
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> response =
googleAdsServiceClient.Search(
managerCustomerId.ToString(),
query
);
// Iterate over all rows in all pages to get all customer clients under the
// specified customer's hierarchy.
foreach (GoogleAdsRow googleAdsRow in response)
{
CustomerClient customerClient = googleAdsRow.CustomerClient;
// The customer client that with level 0 is the specified customer.
if (customerClient.Level == 0)
{
if (rootCustomerClient == null)
{
rootCustomerClient = customerClient;
}
continue;
}
// For all level-1 (direct child) accounts that are a manager account,
// the above query will be run against them to create a Dictionary of
// managers mapped to their child accounts for printing the hierarchy
// afterwards.
if (!customerIdsToChildAccounts.ContainsKey(managerCustomerId.Value))
customerIdsToChildAccounts.Add(managerCustomerId.Value,
new List<CustomerClient>());
customerIdsToChildAccounts[managerCustomerId.Value].Add(customerClient);
if (customerClient.Manager)
// A customer can be managed by multiple managers, so to prevent
// visiting the same customer many times, we need to check if it's
// already in the Dictionary.
if (!customerIdsToChildAccounts.ContainsKey(customerClient.Id) &&
customerClient.Level == 1)
unprocessedCustomerIds.Enqueue(customerClient.Id);
}
}
if (rootCustomerClient != null)
{
Console.WriteLine("The hierarchy of customer ID {0} is printed below:",
rootCustomerClient.Id);
PrintAccountHierarchy(rootCustomerClient, customerIdsToChildAccounts, 0);
Console.WriteLine();
}
else
{
Console.WriteLine(
"Customer ID {0} is likely a test account, so its customer client " +
" information cannot be retrieved.", managerCustomerId);
}
}
}
/// <summary>
/// Prints the specified account's hierarchy using recursion.
/// <param name="customerClient">
/// the customer client whose info will be printed and
/// its child accounts will be processed if it's a manager
/// </param>
/// <param name="customerIdsToChildAccounts"> a Dictionary mapping customer IDs to
/// child accounts</param>
/// <param name="depth"> the current integer depth we are printing from in the
/// account hierarchy</param>
/// </summary>
private void PrintAccountHierarchy(CustomerClient customerClient,
Dictionary<long, List<CustomerClient>> customerIdsToChildAccounts, int depth)
{
if (depth == 0)
Console.WriteLine("Customer ID (Descriptive Name, Currency Code, Time Zone)");
long customerId = customerClient.Id;
Console.Write(new string('-', depth * 2));
Console.WriteLine("{0} ({1}, {2}, {3})",
customerId, customerClient.DescriptiveName, customerClient.CurrencyCode,
customerClient.TimeZone);
// Recursively call this function for all child accounts of $customerClient.
if (customerIdsToChildAccounts.ContainsKey(customerId))
foreach (CustomerClient childAccount in customerIdsToChildAccounts[customerId])
PrintAccountHierarchy(childAccount, customerIdsToChildAccounts,
depth + 1);
}
}
}
PHP
<?php
/**
* Copyright 2019 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.
*/
namespace Google\Ads\GoogleAds\Examples\AccountManagement;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V17\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V17\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V17\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\V17\GoogleAdsServerStreamDecorator;
use Google\Ads\GoogleAds\V17\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V17\Resources\CustomerClient;
use Google\Ads\GoogleAds\V17\Services\CustomerServiceClient;
use Google\Ads\GoogleAds\V17\Services\GoogleAdsRow;
use Google\Ads\GoogleAds\V17\Services\ListAccessibleCustomersRequest;
use Google\Ads\GoogleAds\V17\Services\SearchGoogleAdsStreamRequest;
use Google\ApiCore\ApiException;
/**
* Gets the account hierarchy of the specified manager customer ID and login customer ID. If you
* don't specify them, the example will instead print the hierarchies of all accessible customer
* accounts for your authenticated Google account. Note that if the list of accessible customers
* for your authenticated Google account includes accounts within the same hierarchy, this example
* will retrieve and print the overlapping portions of the hierarchy for each accessible customer.
*/
class GetAccountHierarchy
{
// Optional: You may pass the manager customer ID on the command line or specify it here. If
// neither are set, a null value will be passed to the runExample() method, and the example
// will print the hierarchies of all accessible customer IDs.
private const MANAGER_CUSTOMER_ID = null;
// Optional: You may pass the login customer ID on the command line or specify it here if and
// only if the manager customer ID is set. If the login customer ID is set neither on the
// command line nor below, a null value will be passed to the runExample() method, and the
// example will use each accessible customer ID as the login customer ID.
private const LOGIN_CUSTOMER_ID = null;
// Stores the mapping from the root customer IDs (the ones that will be used as a start point
// for printing each hierarchy) to their `CustomerClient` objects.
private static array $rootCustomerClients = [];
public static function main()
{
// Either pass the required parameters for this example on the command line, or insert them
// into the constants above.
$options = (new ArgumentParser())->parseCommandArguments([
ArgumentNames::MANAGER_CUSTOMER_ID => GetOpt::OPTIONAL_ARGUMENT,
ArgumentNames::LOGIN_CUSTOMER_ID => GetOpt::OPTIONAL_ARGUMENT
]);
$managerCustomerId =
$options[ArgumentNames::MANAGER_CUSTOMER_ID] ?: self::MANAGER_CUSTOMER_ID;
$loginCustomerId =
$options[ArgumentNames::LOGIN_CUSTOMER_ID] ?: self::LOGIN_CUSTOMER_ID;
if ($managerCustomerId xor $loginCustomerId) {
throw new \InvalidArgumentException(
'Both the manager customer ID and login customer ID must be provided together, '
. 'or they must both be null.'
);
}
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())->fromFile()
->withOAuth2Credential($oAuth2Credential)
// We set this value to true to show how to use GAPIC v2 source code. You can remove the
// below line if you wish to use the old-style source code. Note that in that case, you
// probably need to modify some parts of the code below to make it work.
// For more information, see
// https://developers.devsite.corp.google.com/google-ads/api/docs/client-libs/php/gapic.
->usingGapicV2Source(true)
->build();
try {
self::runExample($googleAdsClient, $managerCustomerId, $loginCustomerId);
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
exit(1);
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
exit(1);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int|null $managerCustomerId the manager customer ID
* @param int|null $loginCustomerId the login customer ID
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
?int $managerCustomerId,
?int $loginCustomerId
) {
$rootCustomerIds = [];
if (is_null($managerCustomerId)) {
// We will get the account hierarchies for all accessible customers.
$rootCustomerIds = self::getAccessibleCustomers($googleAdsClient);
} else {
// We will get only the hierarchy for the provided manager customer ID when it's
// provided.
$rootCustomerIds[] = $managerCustomerId;
}
$allHierarchies = [];
$accountsWithNoInfo = [];
// Constructs a map of account hierarchies.
foreach ($rootCustomerIds as $rootCustomerId) {
$customerClientToHierarchy =
self::createCustomerClientToHierarchy($loginCustomerId, $rootCustomerId);
if (is_null($customerClientToHierarchy)) {
$accountsWithNoInfo[] = $rootCustomerId;
} else {
$allHierarchies += $customerClientToHierarchy;
}
}
// Prints the IDs of any accounts that did not produce hierarchy information.
if (!empty($accountsWithNoInfo)) {
print
'Unable to retrieve information for the following accounts which are likely '
. 'either test accounts or accounts with setup issues. Please check the logs for '
. 'details:' . PHP_EOL;
foreach ($accountsWithNoInfo as $accountId) {
print $accountId . PHP_EOL;
}
print PHP_EOL;
}
// Prints the hierarchy information for all accounts for which there is hierarchy info
// available.
foreach ($allHierarchies as $rootCustomerId => $customerIdsToChildAccounts) {
printf(
"The hierarchy of customer ID %d is printed below:%s",
$rootCustomerId,
PHP_EOL
);
self::printAccountHierarchy(
self::$rootCustomerClients[$rootCustomerId],
$customerIdsToChildAccounts,
0
);
print PHP_EOL;
}
}
/**
* Creates a map between a customer client and each of its managers' mappings.
*
* @param int|null $loginCustomerId the login customer ID used to create the GoogleAdsClient
* @param int $rootCustomerId the ID of the customer at the root of the tree
* @return array|null a map between a customer client and each of its managers' mappings if the
* account hierarchy can be retrieved. If the account hierarchy cannot be retrieved, returns
* null
*/
private static function createCustomerClientToHierarchy(
?int $loginCustomerId,
int $rootCustomerId
): ?array {
// Creates a GoogleAdsClient with the specified login customer ID. See
// https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid for more
// information.
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())->fromFile()
->withOAuth2Credential($oAuth2Credential)
->withLoginCustomerId($loginCustomerId ?? $rootCustomerId)
// We set this value to true to show how to use GAPIC v2 source code. You can remove the
// below line if you wish to use the old-style source code. Note that in that case, you
// probably need to modify some parts of the code below to make it work.
// For more information, see
// https://developers.devsite.corp.google.com/google-ads/api/docs/client-libs/php/gapic.
->usingGapicV2Source(true)
->build();
// Creates the Google Ads Service client.
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves all child accounts of the manager specified in search
// calls below.
$query = 'SELECT customer_client.client_customer, customer_client.level,'
. ' customer_client.manager, customer_client.descriptive_name,'
. ' customer_client.currency_code, customer_client.time_zone,'
. ' customer_client.id FROM customer_client WHERE customer_client.level <= 1';
$rootCustomerClient = null;
// Adds the root customer ID to the list of IDs to be processed.
$managerCustomerIdsToSearch = [$rootCustomerId];
// Performs a breadth-first search algorithm to build an associative array mapping
// managers to their child accounts ($customerIdsToChildAccounts).
$customerIdsToChildAccounts = [];
while (!empty($managerCustomerIdsToSearch)) {
$customerIdToSearch = array_shift($managerCustomerIdsToSearch);
// Issues a search request.
/** @var GoogleAdsServerStreamDecorator $stream */
$stream = $googleAdsServiceClient->searchStream(SearchGoogleAdsStreamRequest::build(
$customerIdToSearch,
$query
));
// Iterates over all elements to get all customer clients under the specified customer's
// hierarchy.
foreach ($stream->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$customerClient = $googleAdsRow->getCustomerClient();
// Gets the CustomerClient object for the root customer in the tree.
if ($customerClient->getId() === $rootCustomerId) {
$rootCustomerClient = $customerClient;
self::$rootCustomerClients[$rootCustomerId] = $rootCustomerClient;
}
// The steps below map parent and children accounts. Continue here so that managers
// accounts exclude themselves from the list of their children accounts.
if ($customerClient->getId() === $customerIdToSearch) {
continue;
}
// For all level-1 (direct child) accounts that are a manager account, the above
// query will be run against them to create an associative array of managers to
// their child accounts for printing the hierarchy afterwards.
$customerIdsToChildAccounts[$customerIdToSearch][] = $customerClient;
// Checks if the child account is a manager itself so that it can later be processed
// and added to the map if it hasn't been already.
if ($customerClient->getManager()) {
// A customer can be managed by multiple managers, so to prevent visiting
// the same customer multiple times, we need to check if it's already in the
// map.
$alreadyVisited = array_key_exists(
$customerClient->getId(),
$customerIdsToChildAccounts
);
if (!$alreadyVisited && $customerClient->getLevel() === 1) {
array_push($managerCustomerIdsToSearch, $customerClient->getId());
}
}
}
}
return is_null($rootCustomerClient) ? null
: [$rootCustomerClient->getId() => $customerIdsToChildAccounts];
}
/**
* Retrieves a list of accessible customers with the provided set up credentials.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @return int[] the list of customer IDs
*/
private static function getAccessibleCustomers(GoogleAdsClient $googleAdsClient): array
{
$accessibleCustomerIds = [];
// Issues a request for listing all customers accessible by this authenticated Google
// account.
$customerServiceClient = $googleAdsClient->getCustomerServiceClient();
$accessibleCustomers =
$customerServiceClient->listAccessibleCustomers(new ListAccessibleCustomersRequest());
print 'No manager customer ID is specified. The example will print the hierarchies of'
. ' all accessible customer IDs:' . PHP_EOL;
foreach ($accessibleCustomers->getResourceNames() as $customerResourceName) {
$customer = CustomerServiceClient::parseName($customerResourceName)['customer_id'];
print $customer . PHP_EOL;
$accessibleCustomerIds[] = intval($customer);
}
print PHP_EOL;
return $accessibleCustomerIds;
}
/**
* Prints the specified account's hierarchy using recursion.
*
* @param CustomerClient $customerClient the customer client whose info will be printed and
* its child accounts will be processed if it's a manager
* @param array $customerIdsToChildAccounts a map from customer IDs to child
* accounts
* @param int $depth the current depth we are printing from in the
* account hierarchy
*/
private static function printAccountHierarchy(
CustomerClient $customerClient,
array $customerIdsToChildAccounts,
int $depth
) {
if ($depth === 0) {
print 'Customer ID (Descriptive Name, Currency Code, Time Zone)' . PHP_EOL;
}
$customerId = $customerClient->getId();
print str_repeat('-', $depth * 2);
printf(
" %d ('%s', '%s', '%s')%s",
$customerId,
$customerClient->getDescriptiveName(),
$customerClient->getCurrencyCode(),
$customerClient->getTimeZone(),
PHP_EOL
);
// Recursively call this function for all child accounts of $customerClient.
if (array_key_exists($customerId, $customerIdsToChildAccounts)) {
foreach ($customerIdsToChildAccounts[$customerId] as $childAccount) {
self::printAccountHierarchy($childAccount, $customerIdsToChildAccounts, $depth + 1);
}
}
}
}
GetAccountHierarchy::main();
Python
#!/usr/bin/env python
# Copyright 2020 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.
"""Gets the account hierarchy of the given MCC and login customer ID.
If you don't specify manager ID and login customer ID, the example will instead
print the hierarchies of all accessible customer accounts for your
authenticated Google account. Note that if the list of accessible customers for
your authenticated Google account includes accounts within the same hierarchy,
this example will retrieve and print the overlapping portions of the hierarchy
for each accessible customer.
"""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, login_customer_id=None):
"""Gets the account hierarchy of the given MCC and login customer ID.
Args:
client: The Google Ads client.
login_customer_id: Optional manager account ID. If none provided, this
method will instead list the accounts accessible from the
authenticated Google Ads account.
"""
# Gets instances of the GoogleAdsService and CustomerService clients.
googleads_service = client.get_service("GoogleAdsService")
customer_service = client.get_service("CustomerService")
# A collection of customer IDs to handle.
seed_customer_ids = []
# Creates a query that retrieves all child accounts of the manager
# specified in search calls below.
query = """
SELECT
customer_client.client_customer,
customer_client.level,
customer_client.manager,
customer_client.descriptive_name,
customer_client.currency_code,
customer_client.time_zone,
customer_client.id
FROM customer_client
WHERE customer_client.level <= 1"""
# If a Manager ID was provided in the customerId parameter, it will be
# the only ID in the list. Otherwise, we will issue a request for all
# customers accessible by this authenticated Google account.
if login_customer_id is not None:
seed_customer_ids = [login_customer_id]
else:
print(
"No manager ID is specified. The example will print the "
"hierarchies of all accessible customer IDs."
)
customer_resource_names = (
customer_service.list_accessible_customers().resource_names
)
for customer_resource_name in customer_resource_names:
customer_id = googleads_service.parse_customer_path(
customer_resource_name
)["customer_id"]
print(customer_id)
seed_customer_ids.append(customer_id)
for seed_customer_id in seed_customer_ids:
# Performs a breadth-first search to build a Dictionary that maps
# managers to their child accounts (customerIdsToChildAccounts).
unprocessed_customer_ids = [seed_customer_id]
customer_ids_to_child_accounts = dict()
root_customer_client = None
while unprocessed_customer_ids:
customer_id = int(unprocessed_customer_ids.pop(0))
response = googleads_service.search(
customer_id=str(customer_id), query=query
)
# Iterates over all rows in all pages to get all customer
# clients under the specified customer's hierarchy.
for googleads_row in response:
customer_client = googleads_row.customer_client
# The customer client that with level 0 is the specified
# customer.
if customer_client.level == 0:
if root_customer_client is None:
root_customer_client = customer_client
continue
# For all level-1 (direct child) accounts that are a
# manager account, the above query will be run against them
# to create a Dictionary of managers mapped to their child
# accounts for printing the hierarchy afterwards.
if customer_id not in customer_ids_to_child_accounts:
customer_ids_to_child_accounts[customer_id] = []
customer_ids_to_child_accounts[customer_id].append(
customer_client
)
if customer_client.manager:
# A customer can be managed by multiple managers, so to
# prevent visiting the same customer many times, we
# need to check if it's already in the Dictionary.
if (
customer_client.id not in customer_ids_to_child_accounts
and customer_client.level == 1
):
unprocessed_customer_ids.append(customer_client.id)
if root_customer_client is not None:
print(
"The hierarchy of customer ID "
f"{root_customer_client.id} is printed below:"
)
print_account_hierarchy(
root_customer_client, customer_ids_to_child_accounts, 0
)
else:
print(
f"Customer ID {login_customer_id} is likely a test "
"account, so its customer client information cannot be "
"retrieved."
)
def print_account_hierarchy(
customer_client, customer_ids_to_child_accounts, depth
):
"""Prints the specified account's hierarchy using recursion.
Args:
customer_client: The customer client whose info will be printed; its
child accounts will be processed if it's a manager.
customer_ids_to_child_accounts: A dictionary mapping customer IDs to
child accounts.
depth: The current integer depth we are printing from in the account
hierarchy.
"""
if depth == 0:
print("Customer ID (Descriptive Name, Currency Code, Time Zone)")
customer_id = customer_client.id
print("-" * (depth * 2), end="")
print(
f"{customer_id} ({customer_client.descriptive_name}, "
f"{customer_client.currency_code}, "
f"{customer_client.time_zone})"
)
# Recursively call this function for all child accounts of customer_client.
if customer_id in customer_ids_to_child_accounts:
for child_account in customer_ids_to_child_accounts[customer_id]:
print_account_hierarchy(
child_account, customer_ids_to_child_accounts, depth + 1
)
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="This example gets the account hierarchy of the specified "
"manager account and login customer ID."
)
# The following argument(s) should be provided to run the example.
parser.add_argument(
"-l",
"--login_customer_id",
"--manager_customer_id",
type=str,
required=False,
help="Optional manager "
"account ID. If none provided, the example will "
"instead list the accounts accessible from the "
"authenticated Google Ads account.",
)
args = parser.parse_args()
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v17")
try:
main(googleads_client, args.login_customer_id)
except GoogleAdsException as ex:
print(
f'Request with ID "{ex.request_id}" failed with status '
f'"{ex.error.code().name}" and includes the following errors:'
)
for error in ex.failure.errors:
print(f'\tError with message "{error.message}".')
if error.location:
for field_path_element in error.location.field_path_elements:
print(f"\t\tOn field: {field_path_element.field_name}")
sys.exit(1)
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2020 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.
#
# This example gets the account hierarchy of the specified manager account.
# If you don't specify manager customer ID, the example will instead print the
# hierarchies of all accessible customer accounts for your authenticated
# Google account.
# Note that if the list of accessible customers for your authenticated Google
# account includes accounts within the same hierarchy, this example will
# retrieve and print the overlapping portions of the hierarchy for each
# accessible customer.
require 'optparse'
require 'google/ads/google_ads'
require 'thread'
def get_account_hierarchy(manager_customer_id, login_customer_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Set the specified login customer ID.
client.configure do |config|
if login_customer_id
config.login_customer_id = login_customer_id.to_i
elsif manager_customer_id
config.login_customer_id = manager_customer_id.to_i
end
end
google_ads_service = client.service.google_ads
seed_customer_ids = []
if manager_customer_id
seed_customer_ids << manager_customer_id
else
puts 'No manager customer ID is specified. The example will print the ' +
'hierarchies of all accessible customer IDs:'
customer_resource_names = client.service.customer.
list_accessible_customers().resource_names
customer_resource_names.each do |res|
seed_customer_ids << res.split('/')[1]
end
end
search_query = <<~QUERY
SELECT
customer_client.client_customer,
customer_client.level,
customer_client.manager,
customer_client.descriptive_name,
customer_client.currency_code,
customer_client.time_zone,
customer_client.id
FROM customer_client
WHERE customer_client.level <= 1
QUERY
seed_customer_ids.each do |seed_cid|
# Performs a breadth-first search to build a dictionary that maps managers
# to their child accounts (cid_to_children).
unprocessed_customer_ids = Queue.new
unprocessed_customer_ids << seed_cid
cid_to_children = Hash.new { |h, k| h[k] = [] }
root_customer_client = nil
while unprocessed_customer_ids.size > 0
cid = unprocessed_customer_ids.pop
response = google_ads_service.search(
customer_id: cid,
query: search_query,
page_size: PAGE_SIZE,
)
# Iterates over all rows in all pages to get all customer clients under
# the specified customer's hierarchy.
response.each do |row|
customer_client = row.customer_client
# The customer client that with level 0 is the specified customer
if customer_client.level == 0
if root_customer_client == nil
root_customer_client = customer_client
end
next
end
# For all level-1 (direct child) accounts that are a manager account,
# the above query will be run against them to create a dictionary of
# managers mapped to their child accounts for printing the hierarchy
# afterwards.
cid_to_children[cid.to_s] << customer_client
unless customer_client.manager.nil?
if !cid_to_children.key?(customer_client.id.to_s) &&
customer_client.level == 1
unprocessed_customer_ids << customer_client.id.to_s
end
end
end
end
if root_customer_client
puts "The hierarychy of customer ID #{root_customer_client.id} " +
"is printed below:"
print_account_hierarchy(root_customer_client, cid_to_children, 0)
else
puts "Customer ID #{manager_customer_id} is likely a test account, " \
"so its customer client information cannot be retrieved."
end
end
end
def print_account_hierarchy(customer_client, cid_to_children, depth)
if depth == 0
puts 'Customer ID (Descriptive Name, Currency Code, Time Zone)'
end
customer_id = customer_client.id
puts '-' * (depth * 2) +
"#{customer_id} #{customer_client.descriptive_name} " +
"#{customer_client.currency_code} #{customer_client.time_zone}"
# Recursively call this function for all child accounts of customer_client
if cid_to_children.key?(customer_id.to_s)
cid_to_children[customer_id.to_s].each do |child|
print_account_hierarchy(child, cid_to_children, depth + 1)
end
end
end
if __FILE__ == $PROGRAM_NAME
PAGE_SIZE = 1000
options = {}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
options[:customer_id] = nil
OptionParser.new do |opts|
opts.banner = sprintf('Usage: ruby %s [options]', File.basename(__FILE__))
opts.separator ''
opts.separator 'Options:'
opts.on('-M', '--manager-customer-id MANAGER-CUSTOMER-ID', String, 'Manager Customer ID (optional)') do |v|
options[:manager_customer_id] = v.tr("-", "")
end
opts.on('-L', '--login-customer-id LOGIN-CUSTOMER-ID', String, 'Login Customer ID (optional)') do |v|
options[:login_customer_id] = v.tr("-", "")
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
get_account_hierarchy(
options[:manager_customer_id],
options[:login_customer_id],
)
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
e.failure.errors.each do |error|
STDERR.printf("Error with message: %s\n", error.message)
if error.location
error.location.field_path_elements.each do |field_path_element|
STDERR.printf("\tOn field: %s\n", field_path_element.field_name)
end
end
error.error_code.to_h.each do |k, v|
next if v == :UNSPECIFIED
STDERR.printf("\tType: %s\n\tCode: %s\n", k, v)
end
end
raise
end
end
Perl
#!/usr/bin/perl -w
#
# Copyright 2020, 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
#
# http://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.
#
# Gets the account hierarchy of the specified manager customer ID and login customer
# ID. If you don't specify them, the example will instead print the hierarchies
# of all accessible customer accounts for your authenticated Google account.
#
# Note that if the list of accessible customers for your authenticated Google
# account includes accounts within the same hierarchy, this example will retrieve
# and print the overlapping portions of the hierarchy for each accessible customer.
use strict;
use warnings;
use utf8;
use FindBin qw($Bin);
use lib "$Bin/../../lib";
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::Utils::GoogleAdsHelper;
use Google::Ads::GoogleAds::Utils::SearchStreamHandler;
use
Google::Ads::GoogleAds::V17::Services::GoogleAdsService::SearchGoogleAdsStreamRequest;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
#
# Optional: You may pass the manager customer ID on the command line or specify
# it here. If neither are set, a null value will be passed to run the example,
# and the example will print the hierarchies of all accessible customer IDs.
my $manager_customer_id = undef;
# Optional: You may pass the login customer ID on the command line or specify it
# here if and only if the manager customer ID is set. If the login customer ID
# is set neither on the command line nor below, a null value will be passed to
# run the example, and the example will use each accessible customer ID as the
# login customer ID.
my $login_customer_id = undef;
# Stores the mapping from the root customer IDs (the ones that will be used as a
# start point for printing each hierarchy) to their `CustomerClient` objects.
my $root_customer_clients = {};
sub get_account_hierarchy {
my ($api_client, $manager_customer_id, $login_customer_id) = @_;
my $root_customer_ids = [];
if (not $manager_customer_id) {
# Get the account hierarchies for all accessible customers.
$root_customer_ids = get_accessible_customers($api_client);
} else {
# Only get the hierarchy for the provided manager customer ID if provided.
push @$root_customer_ids, $manager_customer_id;
}
my $all_hierarchies = {};
my $accounts_with_no_info = [];
# Construct a map of account hierarchies.
foreach my $root_customer_id (@$root_customer_ids) {
my $customer_client_to_hierarchy =
create_customer_client_to_hierarchy($login_customer_id,
$root_customer_id);
if (not $customer_client_to_hierarchy) {
push @$accounts_with_no_info, $root_customer_id;
} else {
$all_hierarchies = {%$all_hierarchies, %$customer_client_to_hierarchy};
}
}
# Print the IDs of any accounts that did not produce hierarchy information.
if (scalar @$accounts_with_no_info > 0) {
print "Unable to retrieve information for the following accounts " .
"which are likely either test accounts or accounts with setup issues. " .
"Please check the logs for details:\n";
foreach my $account_id (@$accounts_with_no_info) {
print "$account_id\n";
}
print "\n";
}
# Print the hierarchy information for all accounts for which there is hierarchy
# information available.
foreach my $root_customer_id (keys %$all_hierarchies) {
printf "The hierarchy of customer ID %d is printed below:\n",
$root_customer_id;
print_account_hierarchy($root_customer_clients->{$root_customer_id},
$all_hierarchies->{$root_customer_id}, 0);
print "\n";
}
return 1;
}
# Retrieves a list of accessible customers with the provided set up credentials.
sub get_accessible_customers {
my $api_client = shift;
my $accessible_customer_ids = [];
# Issue a request for listing all customers accessible by this authenticated
# Google account.
my $list_accessible_customers_response =
$api_client->CustomerService()->list_accessible_customers();
print "No manager customer ID is specified. The example will print the " .
"hierarchies of all accessible customer IDs:\n";
foreach my $customer_resource_name (
@{$list_accessible_customers_response->{resourceNames}})
{
my $customer_id = $1 if $customer_resource_name =~ /(\d+)$/;
print "$customer_id\n";
push @$accessible_customer_ids, $customer_id;
}
return $accessible_customer_ids;
}
# Creates a map between a customer client and each of its managers' mappings.
sub create_customer_client_to_hierarchy() {
my ($login_customer_id, $root_customer_id) = @_;
# Create a GoogleAdsClient with the specified login customer ID. Seec
# https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid
# for more information.
my $api_client = Google::Ads::GoogleAds::Client->new({
login_customer_id => $login_customer_id || $root_customer_id
});
# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();
# Create a query that retrieves all child accounts of the manager specified in
# search calls below.
my $search_query =
"SELECT customer_client.client_customer, customer_client.level, " .
"customer_client.manager, customer_client.descriptive_name, " .
"customer_client.currency_code, customer_client.time_zone, " .
"customer_client.id " .
"FROM customer_client WHERE customer_client.level <= 1";
my $root_customer_client = undef;
# Add the root customer ID to the list of IDs to be processed.
my $manager_customer_ids_to_search = [$root_customer_id];
# Perform a breadth-first search algorithm to build a mapping of managers to
# their child accounts.
my $customer_ids_to_child_accounts = {};
while (scalar @$manager_customer_ids_to_search > 0) {
my $customer_id_to_search = shift @$manager_customer_ids_to_search;
$customer_ids_to_child_accounts->{$customer_id_to_search} ||= [];
my $search_stream_handler =
Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
service => $google_ads_service,
request =>
Google::Ads::GoogleAds::V17::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
->new({
customerId => $customer_id_to_search,
query => $search_query,
})});
# Iterate over all elements to get all customer clients under the specified
# customer's hierarchy.
$search_stream_handler->process_contents(
sub {
my $google_ads_row = shift;
my $customer_client = $google_ads_row->{customerClient};
# Get the CustomerClient object for the root customer in the tree.
if ($customer_client->{id} == $root_customer_id) {
$root_customer_client = $customer_client;
$root_customer_clients->{$root_customer_id} = $root_customer_client;
}
# The steps below map parent and children accounts. Return here so that
# manager accounts exclude themselves from the list of their children
# accounts.
if ($customer_client->{id} == $customer_id_to_search) {
return;
}
# For all level-1 (direct child) accounts that are manager accounts, the
# above query will be run against them to create a map of managers to their
# child accounts for printing the hierarchy afterwards.
push @{$customer_ids_to_child_accounts->{$customer_id_to_search}},
$customer_client;
# Check if the child account is a manager itself so that it can later be
# processed and added to the map if it hasn't been already.
if ($customer_client->{manager}) {
# A customer can be managed by multiple managers, so to prevent visiting
# the same customer multiple times, we need to check if it's already
# in the map.
my $already_visited =
exists $customer_ids_to_child_accounts->{$customer_client->{id}};
if (not $already_visited && $customer_client->{level} == 1) {
push @$manager_customer_ids_to_search, $customer_client->{id};
}
}
});
}
return $root_customer_client
? {$root_customer_client->{id} => $customer_ids_to_child_accounts}
: undef;
}
# Prints the specified account's hierarchy using recursion.
sub print_account_hierarchy {
my ($customer_client, $customer_ids_to_child_accounts, $depth) = @_;
if ($depth == 0) {
print "Customer ID (Descriptive Name, Currency Code, Time Zone)\n";
}
my $customer_id = $customer_client->{id};
print "--" x $depth;
printf
" %d ('%s', '%s', '%s')\n",
$customer_id,
$customer_client->{descriptiveName} || "",
$customer_client->{currencyCode},
$customer_client->{timeZone};
# Recursively call this function for all child accounts of $customer_client.
if (exists $customer_ids_to_child_accounts->{$customer_id}) {
foreach
my $child_account (@{$customer_ids_to_child_accounts->{$customer_id}})
{
print_account_hierarchy($child_account, $customer_ids_to_child_accounts,
$depth + 1);
}
}
}
# Don't run the example if the file is being included.
if (abs_path($0) ne abs_path(__FILE__)) {
return 1;
}
# Get Google Ads Client, credentials will be read from ~/googleads.properties.
my $api_client = Google::Ads::GoogleAds::Client->new();
# By default examples are set to die on any server returned fault.
$api_client->set_die_on_faults(1);
# Parameters passed on the command line will override any parameters set in code.
GetOptions(
"manager_customer_id=s" => \$manager_customer_id,
"login_customer_id=s" => \$login_customer_id
);
if ($manager_customer_id xor $login_customer_id) {
die "Both the manager customer ID and login customer ID must be " .
"provided together, or they must both be null.\n";
}
# Call the example.
get_account_hierarchy(
$api_client,
$manager_customer_id ? $manager_customer_id =~ s/-//gr
: undef,
$login_customer_id ? $login_customer_id =~ s/-//gr
: undef
);
=pod
=head1 NAME
get_account_hierarchy
=head1 DESCRIPTION
Gets the account hierarchy of the specified manager customer ID and login customer
ID. If you don't specify them, the example will instead print the hierarchies
of all accessible customer accounts for your authenticated Google account.
Note that if the list of accessible customers for your authenticated Google
account includes accounts within the same hierarchy, this example will retrieve
and print the overlapping portions of the hierarchy for each accessible customer.
=head1 SYNOPSIS
get_account_hierarchy.pl [options]
-help Show the help message.
-manager_customer_id [optional] The Google Ads manager customer ID.
-login_customer_id [optional] The login customer ID.
=cut
若要建立廣告客戶帳戶，請使用 CustomerService 的 CreateCustomerClient 方法 (而不是「變化」方法)，將預先填入的 Customer 傳送給 Google Ads API。在 CreateCustomerClient 方法中，指定管理新用戶端的管理員帳戶客戶 ID。
以下範例說明如何在管理員帳戶中建立客戶 (商家廣告客戶) 帳戶：
Java
private void runExample(GoogleAdsClient googleAdsClient, Long managerId) {
// Formats the current date/time to use as a timestamp in the new customer description.
String dateTime = ZonedDateTime.now().format(DateTimeFormatter.RFC_1123_DATE_TIME);
// Initializes a Customer object to be created.
Customer customer =
Customer.newBuilder()
.setDescriptiveName("Account created with CustomerService on '" + dateTime + "'")
.setCurrencyCode("USD")
.setTimeZone("America/New_York")
// Optional: Sets additional attributes of the customer.
.setTrackingUrlTemplate("{lpurl}?device={device}")
.setFinalUrlSuffix("keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}")
.build();
// Sends the request to create the customer.
try (CustomerServiceClient client =
googleAdsClient.getLatestVersion().createCustomerServiceClient()) {
CreateCustomerClientResponse response =
client.createCustomerClient(managerId.toString(), customer);
System.out.printf(
"Created a customer with resource name '%s' under the manager account with"
+ " customer ID '%d'.%n",
response.getResourceName(), managerId);
}
}
C#
public void Run(GoogleAdsClient client, long managerCustomerId)
{
// Get the CustomerService.
CustomerServiceClient customerService = client.GetService(Services.V17.CustomerService);
Customer customer = new Customer()
{
DescriptiveName = $"Account created with CustomerService on '{DateTime.Now}'",
// For a list of valid currency codes and time zones see this documentation:
// https://developers.google.com/google-ads/api/reference/data/codes-formats#codes_formats.
CurrencyCode = "USD",
TimeZone = "America/New_York",
// The below values are optional. For more information about URL
// options see: https://support.google.com/google-ads/answer/6305348.
TrackingUrlTemplate = "{lpurl}?device={device}",
FinalUrlSuffix = "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
};
try
{
// Create the account.
CreateCustomerClientResponse response = customerService.CreateCustomerClient(
managerCustomerId.ToString(), customer);
// Display the result.
Console.WriteLine($"Created a customer with resource name " +
$"'{response.ResourceName}' under the manager account with customer " +
$"ID '{managerCustomerId}'");
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
PHP
public static function runExample(GoogleAdsClient $googleAdsClient, int $managerCustomerId)
{
$customer = new Customer([
'descriptive_name' => 'Account created with CustomerService on ' . date('Ymd h:i:s'),
// For a list of valid currency codes and time zones see this documentation:
// https://developers.google.com/google-ads/api/reference/data/codes-formats.
'currency_code' => 'USD',
'time_zone' => 'America/New_York',
// The below values are optional. For more information about URL
// options see: https://support.google.com/google-ads/answer/6305348.
'tracking_url_template' => '{lpurl}?device={device}',
'final_url_suffix' => 'keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}'
]);
// Issues a mutate request to create an account
$customerServiceClient = $googleAdsClient->getCustomerServiceClient();
$response = $customerServiceClient->createCustomerClient(
CreateCustomerClientRequest::build($managerCustomerId, $customer)
);
printf(
'Created a customer with resource name "%s" under the manager account with '
. 'customer ID %d.%s',
$response->getResourceName(),
$managerCustomerId,
PHP_EOL
);
}
Python
def main(client, manager_customer_id):
customer_service = client.get_service("CustomerService")
customer = client.get_type("Customer")
now = datetime.today().strftime("%Y%m%d %H:%M:%S")
customer.descriptive_name = f"Account created with CustomerService on {now}"
# For a list of valid currency codes and time zones see this documentation:
# https://developers.google.com/google-ads/api/reference/data/codes-formats
customer.currency_code = "USD"
customer.time_zone = "America/New_York"
# The below values are optional. For more information about URL
# options see: https://support.google.com/google-ads/answer/6305348
customer.tracking_url_template = "{lpurl}?device={device}"
customer.final_url_suffix = (
"keyword={keyword}&matchtype={matchtype}" "&adgroupid={adgroupid}"
)
response = customer_service.create_customer_client(
customer_id=manager_customer_id, customer_client=customer
)
print(
f'Customer created with resource name "{response.resource_name}" '
f'under manager account with ID "{manager_customer_id}".'
)
Ruby
def create_customer(manager_customer_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
customer = client.resource.customer do |c|
c.descriptive_name = "Account created with CustomerService on #{(Time.new.to_f * 1000).to_i}"
# For a list of valid currency codes and time zones, see this documentation:
# https://developers.google.com/google-ads/api/reference/data/codes-formats
c.currency_code = "USD"
c.time_zone = "America/New_York"
# The below values are optional. For more information about URL options, see:
# https://support.google.com/google-ads/answer/6305348
c.tracking_url_template = "{lpurl}?device={device}"
c.final_url_suffix = "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
end
response = client.service.customer.create_customer_client(
customer_id: manager_customer_id,
customer_client: customer
)
puts "Created a customer with resource name #{response.resource_name} under" +
" the manager account with customer ID #{manager_customer_id}."
end
Perl
sub create_customer {
my ($api_client, $manager_customer_id) = @_;
# Initialize a customer to be created.
my $customer = Google::Ads::GoogleAds::V17::Resources::Customer->new({
descriptiveName => "Account created with CustomerService on #" . uniqid(),
# For a list of valid currency codes and time zones, see this documentation:
# https://developers.google.com/google-ads/api/reference/data/codes-formats
currencyCode => "USD",
timeZone => "America/New_York",
# The below values are optional. For more information about URL options, see:
# https://support.google.com/google-ads/answer/6305348
trackingUrlTemplate => "{lpurl}?device={device}",
finalUrlSuffix =>
"keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
});
# Create the customer client.
my $create_customer_client_response =
$api_client->CustomerService()->create_customer_client({
customerId => $manager_customer_id,
customerClient => $customer
});
printf
"Created a customer with resource name '%s' under the manager account " .
"with customer ID %d.\n", $create_customer_client_response->{resourceName},
$manager_customer_id;
return 1;
}
如果商家想要使用現有的 Google Ads 帳戶，請使用 CustomerService 的 ListAccessibleCustomers 方法檢查現有帳戶。
選好想要使用的帳戶後，請在客戶的 Google Ads 帳戶和管理員帳戶之間建立連結。連結兩個帳戶一律須透過管理員帳戶啟動，且必須從客戶帳戶接受該連結。連結的狀態會儲存在 CustomerClientLink 或 CustomerManagerLink 的狀態欄位中。請參閱有效狀態清單。使用 PENDING 即可啟動連結，使用「ACTIVE」則可接受連結。
您必須完成三個步驟，才能連結兩個現有的 Google Ads 帳戶。
以管理員帳戶進行驗證時，請建立狀態為「PENDING」的 CustomerClientLink，藉此擴充客戶帳戶的邀請。
以管理員帳戶進行驗證時，請查詢 GoogleAdsService，找出您建立的 CustomerClientLink 變數
manager_link_id。以客戶帳戶進行驗證時，請將
CustomerManagerLink變更為「有效」，藉此接受來自管理員帳戶的邀請。