Métadonnées de ressources

Vous pouvez utiliser SearchAds360FieldService pour demander de manière dynamique au catalogue les ressources, les champs des 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 que les clients de l'API Search Ads 360 Reporting peuvent utiliser pour valider et créer des instructions de 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",
    ...
  ]
}

Dans 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. N'est renseigné que pour les champs dont la valeur category est RESOURCE.

segments

Clés de segment pouvant être sélectionnées avec la ressource dans la clause FROM. Ils segmentent les métriques spécifiées dans la requête. N'est renseigné que pour les champs où category est RESOURCE.

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 pour identifier les ressources ou les segments pouvant être sélectionnés dans une requête où ils ne sont pas inclus par la ressource dans la clause FROM. Par exemple, si vous sélectionnez ad_group.id et segments.date à partir de ad_group et que vous souhaitez inclure des attributs de campaign, vous devez vérifier que segments.date figure dans l'attribut selectableWith pour la campagne, car il est sélectionné à côté du champ segments.date existant.

Détails des métadonnées

Vous pouvez demander le catalogue à l'aide de SearchAds360FieldService aux niveaux suivants:

Ressource

Par exemple, searchAds360Fields/campaign.

Champ de la ressource

Par exemple, searchAds360Fields/campaign.name.

Champ de segmentation

Par exemple, searchAds360Fields/segments.ad_network_type.

Métrique

Par exemple, searchAds360Fields/metrics.clicks.

Utiliser une requête pour obtenir des détails sur un champ

Vous pouvez obtenir des informations sur le 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: Interroger des champs, des métriques ou des 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"
  )