Metadados do recurso

É possível usar GoogleAdsFieldService para solicitar dinamicamente o catálogo de recursos, campos de recursos, chaves de segmentação e métricas disponíveis nos métodos GoogleAdsService Search e SearchStream. O catálogo fornece metadados que podem ser usados pelos clientes da Google Ads API para validação e criação de instruções da linguagem de consulta do Google Ads.

Exemplo de solicitação e resposta de HTTP

Observação: o exemplo mostra a solicitação HTTP/JSON subjacente como um guia, mas é altamente recomendável usar uma das bibliotecas de cliente baseadas em gRPC para enviar suas solicitações.

A solicitação consiste em um HTTP GET para o servidor da Google Ads API no URL a seguir:

https://googleads.googleapis.com/v14/googleAdsFields/{resource_or_field}

Veja a seguir um exemplo de solicitação seguida pela resposta retornada de GoogleAdsFieldService para o recurso ad_group:

Solicitação

https://googleads.googleapis.com/v14/googleAdsFields/ad_group

Resposta

{
  "resourceName": "googleAdsFields/ad_group",
  "name": "ad_group",
  "category": "RESOURCE",
  "selectable": false,
  "filterable": false,
  "sortable": false,
  "selectableWith": [
    "campaign",
    "customer",
    "metrics.average_cpc",
    "segments.device",
    ...
  ],
  "attributeResources": [
    "customer",
    "campaign"
  ],

  "metrics": [
    "metrics.conversions",
    "metrics.search_budget_lost_impression_share",
    "metrics.average_cost",
    "metrics.clicks",
    ...
  ],
  "segments": [
    "segments.date",
    "segments.ad_network_type",
    "segments.device",
    ...
  ]
}

Neste exemplo, as matrizes importantes são:

attributeResources

Recursos que podem ser mesclados implicitamente ao recurso na cláusula FROM.

metrics

Métricas que estão disponíveis para serem selecionadas com o recurso na cláusula FROM. Preenchido apenas para campos em que category é RESOURCE.

segments

Segmente as chaves que podem ser selecionadas com o recurso na cláusula FROM. Elas segmentam as métricas especificadas na consulta. Preenchido apenas para campos em que category é RESOURCE.

selectableWith

Campos que podem ser selecionados ao lado de um determinado campo, quando não estão na cláusula FROM. Esse atributo só é relevante ao identificar recursos ou segmentos que podem ser selecionados em uma consulta em que não estão incluídos pelo recurso na cláusula FROM. Por exemplo, se selecionarmos ad_group.id e segments.date de ad_group e quisermos incluir atributos de campaign, será necessário verificar se segments.date está no atributo selectableWith da campanha, já que está sendo selecionado com o campo segments.date existente.

Detalhes dos metadados

É possível solicitar o catálogo usando GoogleAdsFieldService nestes níveis:

Recurso

Por exemplo, googleAdsFields/campaign.

Campo do recurso

Por exemplo, googleAdsFields/campaign.name.

Campo de segmentação

Por exemplo, googleAdsFields/segments.ad_network_type.

Métrica

Por exemplo, googleAdsFields/metrics.clicks.