Metadatos del recurso

Puedes usar SearchAds360FieldService para solicitar dinámicamente el catálogo de recursos, campos de recursos las claves de segmentación y las métricas disponibles en SearchAds360Service Search y SearchStream. El catálogo proporciona metadatos que se pueden que usan los clientes de la API de Search Ads 360 Reporting para la validación y creación de Search Ads 360 Declaraciones del lenguaje de consulta.

Ejemplo de solicitud y respuesta HTTP

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

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

El siguiente es un ejemplo de una solicitud seguida de la respuesta que mostró 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 el FROM .
metrics
Las métricas que están disponibles para seleccionarlas con el recurso en el FROM . Solo se completa 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. Estas segmentan las métricas especificadas en la consulta. Solo se completa para los campos donde category es RESOURCE.
selectableWith
Son los campos que se pueden seleccionar junto a un campo determinado cuando no se encuentran en FROM. . Este atributo solo es relevante cuando se identifican recursos o segmentos que pueden seleccionarse en una consulta y que no están incluidas en el recurso en la cláusula FROM. Por ejemplo, si seleccionas ad_group.id y segments.date de ad_group, y quieres incluir atributos de campaign, deberás verificar que segments.date esté en selectableWith para 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 estas 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 los detalles de los campos

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"
  )