Puedes usar GoogleAdsFieldService
para solicitar dinámicamente el catálogo de recursos, campos de recursos, segmentación
claves y métricas disponibles en el GoogleAdsService
métodos Search y SearchStream. El catálogo proporciona metadatos que se pueden
que los clientes de la API de Google Ads usan para la validación y creación de instrucciones del lenguaje de consulta de Google Ads.
Ejemplo de solicitud y respuesta HTTP
La solicitud consiste en un HTTP GET
al servidor de la API de Google Ads en el siguiente
URL:
https://googleads.googleapis.com/v17/googleAdsFields/{resource_or_field}
El siguiente es un ejemplo de una solicitud seguida de la respuesta que mostró
GoogleAdsFieldService
para el recurso ad_group:
Solicitud
https://googleads.googleapis.com/v17/googleAdsFields/ad_group
Respuesta
{
"resourceName": "googleAdsFields/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 quecategory
esRESOURCE
. 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 dondecategory
esRESOURCE
. 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áusulaFROM
. A modo de ejemplo, si seleccionamosad_group.id
ysegments.date
dead_group
, y queremos incluir atributos decampaign
, debemos comprobar quesegments.date
esté enselectableWith
de la campaña, ya que se selecciona junto con el atributosegments.date
.
Detalles de los metadatos
Puedes solicitar el catálogo mediante GoogleAdsFieldService
en estos niveles:
- Recurso
- Por ejemplo,
googleAdsFields/campaign
. - Campo del recurso
- Por ejemplo,
googleAdsFields/campaign.name
. - Campo de segmentación
- Por ejemplo,
googleAdsFields/segments.ad_network_type
. - Métrica
- Por ejemplo,
googleAdsFields/metrics.clicks
.