SearchAds360FieldService
vous permet de demander de manière dynamique le catalogue pour les ressources, les champs de ressources, les clés de segmentation et les métriques disponibles dans les méthodes SearchAds360Service
Search
et SearchStream
. Le catalogue fournit des métadonnées qui peuvent être utilisées par les clients de l'API Search Ads 360 Reporting pour la validation et la construction des instructions du langage de requête Search Ads 360.
Exemple de requête et de réponse HTTP
La requête consiste en un HTTP GET
envoyé au serveur de l'API Search Ads 360 Reporting à l'URL suivante:
https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}
Voici un exemple de requête suivie de la réponse renvoyée par SearchAds360FieldService
pour la ressource ad_group:
Requête
https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group
Réponse
{
"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",
...
]
}
Pour cet exemple, les tableaux importants sont les suivants:
attributeResources
- Ressources pouvant être jointes implicitement à la ressource dans la clause
FROM
. metrics
- Métriques pouvant être sélectionnées avec la ressource dans la clause
FROM
. Renseigné uniquement pour les champs oùcategory
estRESOURCE
. segments
- Segmentez les clés pouvant être sélectionnées avec la ressource dans la clause
FROM
. Ils permettent de segmenter les métriques spécifiées dans la requête. Renseigné uniquement pour les champs dont la valeur decategory
estRESOURCE
. selectableWith
- Champs pouvant être sélectionnés à côté d'un champ donné, lorsqu'ils ne figurent pas dans la clause
FROM
. Cet attribut n'est pertinent que lors de l'identification des ressources ou des segments pouvant être sélectionnés dans une requête lorsqu'ils ne sont pas inclus par la ressource dans la clauseFROM
. Par exemple, si vous sélectionnezad_group.id
etsegments.date
dansad_group
et que vous souhaitez inclure des attributs decampaign
, vous devez vérifier quesegments.date
se trouve dans l'attributselectableWith
de la campagne, car il est sélectionné à côté du champsegments.date
existant.
Détails des métadonnées
Vous pouvez demander le catalogue à l'aide de SearchAds360FieldService
aux niveaux suivants:
- Ressource
- Exemple :
searchAds360Fields/campaign
. - Champ de la ressource
- Exemple :
searchAds360Fields/campaign.name
. - Champ de segmentation
- Exemple :
searchAds360Fields/segments.ad_network_type
. - Métrique
- Exemple :
searchAds360Fields/metrics.clicks
.
Utiliser une requête pour obtenir des détails sur un champ
Il est possible d'obtenir les détails d'un champ en envoyant une requête à
https://searchads360.googleapis.com/v0/searchAds360Fields:search
Exemple 1: Utilisation d'une expression régulière.
SELECT
name,
category,
selectable,
filterable,
sortable,
selectable_with,
data_type,
is_repeated
WHERE name LIKE 'ad_group.%'"
Exemple 2: Interrogation de champs, de métriques ou de segments spécifiques
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"
)