Metadatos del recurso

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

Ejemplo de solicitud y respuesta HTTP

La solicitud consta de un HTTP GET al servidor de la API de Search Ads 360 Reporting 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 de forma implícita 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 propaga para los campos en los que category es RESOURCE.
segments
Segmenta las claves 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. Por ejemplo, si seleccionas ad_group.id y segments.date en ad_group, y deseas incluir atributos de campaign, debes 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 el 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

Es posible obtener detalles del campo enviando una consulta a

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

Ejemplo 1: Uso de una expresión regular

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

Ejemplo 2: Consulta de 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"
  )