Nomes dos recursos

Hierarquia de nomes

Os nomes de recursos usados na API Google Ads são hierárquicos e espelham a organização das entidades no Google Ads. Quase todos os recursos são sub-recursos do Customer, que reflete o fato de que quase todas as chamadas de API precisam segmentar uma conta específica do Google Ads. Por exemplo, campanhas, grupos de anúncios, anúncios e palavras-chave são sub-recursos de um recurso raiz de cliente.

Resource Nome do recurso
Cliente customers/1234567890
Campanha customers/1234567890/campaigns/8765432109
AdGroup customers/1234567890/adGroups/54321098765
AdGroupAd customers/1234567890/adGroupAds/54321098765~2109876543210

IDs de recursos

As entidades do Google Ads (clientes, campanhas etc.) são chamadas pelos nomes de recursos em toda a API. No entanto, é importante observar que os próprios nomes de recursos podem ter IDs de recursos numéricos únicos que identificam cada objeto na hierarquia. Nesses casos, pode ser útil analisar o nome do recurso para extrair esses IDs e montar um novo.

Por exemplo, examine o nome do recurso AdGroupAd da tabela anterior:

customers/1234567890/adGroupAds/54321098765~2109876543210

Isso pode ser dividido em IDs de recursos individuais (separados por IDs de coleções) da seguinte maneira:

Componentes do nome do recurso
IDs de recurso
ID do cliente:
"1234567890"
ID do grupo de anúncios:
"54321098765"
ID do anúncio do grupo de anúncios:
"2109876543210"
IDs de coleções
"customers"
"adGroupAds"

Analisar os IDs individuais permite derivar novos nomes de recursos para fazer referência ao cliente (customers/1234567890) ou ao grupo de anúncios (customers/1234567890/adGroupAds/54321098765) do anúncio do grupo de anúncios.

Identificadores de objetos compartilhados

A maioria dos objetos na API está associada a um único cliente específico do Google Ads. No entanto, alguns tipos de objetos podem ser compartilhados entre várias contas. Na prática, isso inclui listas de palavras-chave negativas ou ações de conversão de várias contas, que geralmente são criadas pelos administradores e compartilhadas com várias contas de cliente.

Os nomes de recursos de objetos como esses serão diferentes, dependendo da conta para a qual você está enviando uma chamada de API.

Exemplo: ações de conversão de várias contas

Suponha que temos uma conta de administrador 987-654-3210 que compartilha uma ação de conversão de várias contas com uma das contas de cliente do cliente 123-456-7890:

Diagrama mostrando a relação entre nomes de recursos e hierarquias de contas.

Fazer uma chamada de API à conta de administrador com o objetivo de, por exemplo, atualizar a janela de lookback da ação de conversão, faria referência ao objeto compartilhado usando o nome de recurso: customers/9876543210/conversionActions/257733534.

Fazer uma chamada de API à conta de cliente para ativar o uso da ação de conversão compartilhada faria referência a ela usando o nome de recurso: customers/1234567890/conversionActions/257733534.

Essa é a mesma ação de conversão subjacente, mas o nome do recurso é relativo à conta usada para acessá-lo.