Estrutura da API Reporting do Search Ads 360

Os principais componentes da API Search Ads 360 Reporting são recursos e serviços. Um recurso representa uma entidade do Search Ads 360, e um serviço é usado para recuperar entidades do Search Ads 360.

Hierarquia de objetos

Uma conta do Search Ads 360 é uma hierarquia de objetos.

• O recurso de nível mais alto de uma conta é o cliente.

• Cada conta contém uma ou mais campanhas ativas campaigns.

• Cada Campaign contém um ou mais grupos de anúncios que agrupam seus anúncios em coleções lógicas.

• Cada AdGroup contém um ou mais anúncios do grupo de anúncios.

• É possível anexar um ou mais AdGroupCriterion ou CampaignCriterion a um grupo de anúncios ou campanha. Os critérios definem como os anúncios são acionados.

  • Há muitos tipos de critérios, como palavras-chave, faixas etárias e locais. Os critérios definidos no nível da campanha afetam todos os outros recursos dela. Também é possível especificar orçamentos e datas para toda a campanha.

Recursos

Os recursos representam as entidades na sua conta do Search Ads 360. Exemplos de recursos incluem Customer, Campaign e AdGroup.

IDs de objeto

Cada objeto no Search Ads 360 é identificado pelo próprio ID. Alguns IDs são globalmente exclusivos, ou seja, em todas as contas do Search Ads 360, enquanto outros são exclusivos apenas em um escopo limitado.

Essas regras de ID podem ser úteis ao projetar o armazenamento local para seus objetos do Search Ads 360.

Tipos de objeto

Alguns objetos podem ser usados para vários tipos de entidade. Nesse caso, o objeto contém um campo type que descreve o conteúdo dele. Por exemplo, AdGroupAd pode se referir a um anúncio de texto, de hotel ou local ad. É possível acessar o valor do tipo pelo AdGroupAd.ad.type campo. O valor é retornado na AdType enumeração.

Nomes de recursos

Cada recurso é identificado exclusivamente por uma string resource_name que concatena o recurso e os recursos de nível superior em um caminho.

Os nomes dos recursos da campanha, por exemplo, têm o seguinte formato:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Uma campanha com o ID 987654 na conta do Search Ads 360 com o ID do cliente 1234567 tem o resource_name:

customers/1234567/campaigns/987654

Serviços

Os serviços permitem recuperar suas entidades e metadados do Search Ads 360. Há três tipos de serviço:

SearchService

SearchAds360Service é o serviço unificado para recuperar todos os objetos de recursos e estatísticas de desempenho. Ele oferece dois métodos: Search e SearchStream. Ambos os métodos exigem uma consulta que especifique o recurso a ser consultado, os atributos de recursos e as métricas de desempenho a serem recuperadas, os predicados a serem usados para filtrar a solicitação e os segmentos a serem usados para detalhar ainda mais as estatísticas de desempenho. Consulte Criar relatórios de pesquisa e Linguagem de consulta do Search Ads 360 para mais informações.

FieldService

SearchAds360FieldService recupera metadados sobre recursos, como os atributos disponíveis para um recurso e o tipo de dados dele. É possível solicitar o catálogo de recursos, campos de recursos, chaves de segmentação e métricas disponíveis nos métodos de pesquisa SearchAds360Service. Consulte Recuperar metadados de recursos para saber mais.

Serviços específicos da entidade

Esses serviços fornecem um método de solicitação GET que recupera uma única instância de recurso. Isso é útil para examinar a estrutura de um recurso.

Exemplos de serviços específicos da entidade incluem:

• CustomColumnService que retorna a coluna personalizada solicitada com todos os detalhes.