Metadados do recurso

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

Exemplo de solicitação e resposta HTTP

A solicitação consiste em um HTTP GET para o servidor da API Search Ads 360 Reporting no seguinte URL:

https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}

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

Solicitação

https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group

Resposta

{
  "resourceName": "searchAds360Fields/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",
    ...
  ]
}

Para este exemplo, as matrizes importantes são:

attributeResources

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

metrics

Métricas disponíveis para seleção com o recurso na cláusula FROM. Só é preenchido para campos em que o category é RESOURCE.

segments

Chaves de segmento que podem ser selecionadas com o recurso na cláusula FROM. Eles segmentam as métricas especificadas na consulta. Só é preenchido para campos em que category é RESOURCE.

selectableWith

Campos que podem ser selecionados com 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 são incluídos pelo recurso na cláusula FROM. Por exemplo, se você selecionar ad_group.id e segments.date em ad_group e quiser incluir atributos de campaign, será necessário verificar se segments.date está no atributo selectableWith da campanha, já que ele está sendo selecionado com o campo segments.date.

Detalhes dos metadados

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

Recurso

Por exemplo, searchAds360Fields/campaign.

Campo do recurso

Por exemplo, searchAds360Fields/campaign.name.

Campo de segmentação

Por exemplo, searchAds360Fields/segments.ad_network_type.

Métrica

Por exemplo, searchAds360Fields/metrics.clicks.

Usar uma consulta para conferir detalhes do campo

É possível obter detalhes do campo enviando uma consulta ao

https://searchads360.googleapis.com/v0/searchAds360Fields:search

Exemplo 1: usar uma expressão regular.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE name LIKE 'ad_group.%'"

Exemplo 2: consulta de campos, métricas ou segmentos específicos.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE
  name IN (
    "ad_group.id",
    "ad_group.name",
    "segments.date",
    "customer.id",
    "customer.manager",
    "metrics.clicks"
  )