Metadados do recurso

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

Exemplo de solicitação e resposta HTTP

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

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

Veja a seguir um exemplo de solicitação seguida pela resposta retornada do 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 associados ao recurso na FROM cláusula.

metrics

Métricas disponíveis para serem selecionadas com o recurso em FROM . Só é preenchido nos campos em que category é RESOURCE.

segments

Segmente chaves que podem ser selecionadas com o recurso na cláusula FROM. Segmente as métricas especificadas na consulta. Só é preenchido nos campos em que category é RESOURCE.

selectableWith

Campos que podem ser selecionados ao lado de um determinado campo, quando não estão no FROM . Este atributo só é relevante para identificar recursos ou segmentos que podem ser selecionados em uma consulta onde não estão incluídos pelo recurso na cláusula FROM. Por exemplo, se você selecionar ad_group.id e segments.date de ad_group, e você quiser incluir atributos de campaign, verifique se segments.date está no selectableWith para a campanha, já que ele está sendo selecionado junto com a campo segments.date atual.

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 ver detalhes do campo

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

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

Exemplo 1: uso de 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"
  )