Nomes dos recursos

Hierarquia de nomes

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

Recurso	Nome do recurso
Cliente	customers/1234567890
Campaign	customers/1234567890/campaigns/8765432109
Grupo de anúncios	customers/1234567890/adGroups/54321098765
AdGroupAd	customers/1234567890/adGroupAds/54321098765~2109876543210

Importante: a API Google Ads usa nomes de recursos relativos (e não os nomes completos dos recursos como algumas outras APIs do Google).

IDs de recursos

As entidades do Google Ads (clientes, campanhas etc.) são referenciadas pelo recurso delas. em toda a API. No entanto, é importante observar que o recurso os próprios nomes podem ter recursos numéricos exclusivos IDs que identificam cada objeto na hierarquia. Nesses casos, pode ser útil analisar 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 recurso individuais (separados por IDs de coleção) da seguinte forma:

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 referenciar o cliente do anúncio do grupo de anúncios (customers/1234567890) ou o grupo de anúncios customers/1234567890/adGroupAds/54321098765).

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

Identificadores de objetos compartilhados

A maioria dos objetos na API está associada a uma conta do Google Ads para o cliente. No entanto, alguns tipos de objeto podem ser compartilhados entre várias contas. Na prática, temos itens como palavras-chave negativas listas ou entre contas ações de conversão que são geralmente criados por gerentes e compartilhados com muitas contas de clientes.

Os nomes de recursos de objetos como esses serão diferentes, dependendo de qual 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 várias contas ação de conversão com uma das contas de clientes 123-456-7890:

Fazer uma chamada de API à conta de administrador para, por exemplo, atualizar a conversão da janela de lookback da ação faria 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 do a ação de conversão faria referência a ele 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á-lo.