Metadatos del recurso

Puedes usar SearchAds360FieldService para solicitar de forma dinámica el catálogo de recursos, los campos de recursos, las claves de segmentación y las métricas disponibles en los métodos Search y SearchStream de SearchAds360Service. El catálogo proporciona metadatos que los clientes de la API de Search Ads 360 Reporting pueden usar para validar y crear sentencias del lenguaje de consultas de Search Ads 360.

Ejemplo de solicitud y respuesta HTTP

La solicitud consiste en un HTTP GET al servidor de la API de informes de Search Ads 360 en la siguiente URL:

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

El siguiente es un ejemplo de una solicitud seguida de la respuesta que muestra SearchAds360FieldService para el recurso ad_group:

Solicitud

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

Respuesta

{
  "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",
    ...
  ]
}

En este ejemplo, los arrays importantes son los siguientes:

attributeResources

Recursos que se pueden unir implícitamente al recurso en la cláusula FROM.

metrics

Métricas que están disponibles para seleccionarse con el recurso en la cláusula FROM. Solo se completa para los campos en los que category es RESOURCE.

segments

Claves de segmento que se pueden seleccionar con el recurso en la cláusula FROM. Estos segmentan las métricas especificadas en la consulta. Solo se propaga para los campos en los que category es RESOURCE.

selectableWith

Son los campos que se pueden seleccionar junto con un campo determinado cuando no están en la cláusula FROM. Este atributo solo es relevante cuando se identifican recursos o segmentos que se pueden seleccionar en una consulta en la que el recurso no los incluye en la cláusula FROM. A modo de ejemplo, si seleccionas ad_group.id y segments.date de ad_group y deseas incluir atributos de campaign, deberás verificar que segments.date esté en el atributo selectableWith de la campaña, ya que se selecciona junto con el campo segments.date existente.

Detalles de los metadatos

Puedes solicitar el catálogo con SearchAds360FieldService en estos niveles:

Recurso

Por ejemplo, searchAds360Fields/campaign.

Campo del recurso

Por ejemplo, searchAds360Fields/campaign.name.

Campo de segmentación

Por ejemplo, searchAds360Fields/segments.ad_network_type.

Métrica

Por ejemplo, searchAds360Fields/metrics.clicks.

Usa una consulta para obtener detalles del campo

Para obtener detalles de los campos, envía una consulta a

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

Ejemplo 1: Usa una expresión regular.

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

Ejemplo 2: Consultar campos, métricas o 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"
  )