Nomes dos recursos

Hierarquia de nomes

Os nomes de recursos usados na Google Ads API são hierárquicos e refletem 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

Importante :a API Google Ads usa nomes de recursos relative, e não relative de recursos, como algumas outras APIs do Google.

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 únicos que identificam cada objeto na hierarquia. Nesses casos, pode ser útil analisar o nome do recurso para extrair esses IDs e criar 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 recursos individuais (separados por IDs de coleção) da seguinte maneira:

Componentes de nome de recurso
IDs de recursos	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"

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 dele (customers/1234567890/adGroupAds/54321098765).

Importante: os nomes de recursos em corpos de solicitação e resposta JSON são referidos pelo campo resourceName, não pelo campo name, como em algumas outras APIs do Google Cloud. Muitas entidades do Google Ads têm atributos de nome (campaign.Name, adGroup.Name etc.). Portanto, resourceName é usado para evitar colisão com nomes de objetos existentes.

Identificadores de objetos compartilhados

A maioria dos objetos na API é 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, são itens como 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 dos 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

Imagine 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 de cliente 123-456-7890:

Se você fizer uma chamada de API à conta de administrador para, por exemplo, atualizar a janela de lookback da ação de conversão, referenciaria o objeto compartilhado usando o nome do recurso: customers/9876543210/conversionActions/257733534.

Se você fizer uma chamada de API à conta de cliente para ativar o uso da ação de conversão compartilhada, ela será referenciada usando o nome do recurso: customers/1234567890/conversionActions/257733534.

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