Cuidado: você está vendo a documentação da interface REST da API. A maioria das nossas bibliotecas de cliente oficiais usa o gRPC. Consulte Introdução ao REST para ver mais detalhes.

Nomes dos recursos

Hierarquia de nomes

Os nomes dos recursos usados na API Google Ads são hierárquicos, espelhando a organização de entidades no Google Ads. Quase todos os recursos são sub-recursos do Customer, o 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 do cliente.

Recurso 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 dos recursos em toda a API. No entanto, é importante observar que os próprios nomes de recursos podem ter IDs de recursos numéricos exclusivos 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 nos IDs de recurso individuais, separados por IDs de coleção, da seguinte maneira:

Componentes do nome do recurso
IDs de recursos
ID de cliente:
"1234567890"
ID do grupo de anúncios:
"54321098765"
ID do anúncio do grupo de anúncios:
"2109876543210"
Códigos de coleção
"customers"
"adGroupAds"

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

Identificadores de objetos compartilhados

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

Os nomes de recursos desses objetos variam de acordo com a conta para que você está enviando uma chamada de API.

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

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

Diagrama mostrando a relação dos nomes de recursos com as hierarquias de contas.

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

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

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