Métadonnées de ressources

Vous pouvez utiliser SearchAds360FieldService pour demander dynamiquement les ressources, les champs de ressources, clés et métriques de segmentation disponibles dans le SearchAds360Service Search et SearchStream. Le catalogue fournit des métadonnées qui peuvent être utilisé par les clients de l'API Search Ads 360 Reporting pour la validation et l'élaboration de Search Ads 360 Instructions du langage de requête.

Exemple de requête et de réponse HTTP

La demande consiste en un HTTP GET pour le serveur de l'API Search Ads 360 Reporting au niveau du 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 associées implicitement à la ressource dans le FROM .

metrics

Métriques pouvant être sélectionnées avec la ressource du FROM . Renseigné uniquement pour les champs où category est défini sur RESOURCE.

segments

Segmentez les clés pouvant être sélectionnées avec la ressource dans la clause FROM. Ceux-ci segmentent les métriques spécifiées dans la requête. Renseigné uniquement pour les champs où category est RESOURCE.

selectableWith

Champs pouvant être sélectionnés à côté d'un champ donné, lorsqu'ils ne se trouvent pas dans la section FROM . Cet attribut n'est pertinent que pour identifier des ressources ou des segments pouvant être sélectionnés dans une requête alors qu'ils ne sont pas inclus ressource dans la clause FROM. Par exemple, si vous sélectionnez ad_group.id et segments.date provenant de ad_group, et que vous souhaitez inclure des attributs provenant de campaign, vous devez vérifier que segments.date se trouve dans selectableWith pour la campagne, car il est sélectionné avec l'attribut champ segments.date existant.

Détails des métadonnées

Vous pouvez demander le catalogue à l'aide du SearchAds360FieldService à ces niveaux:

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 les détails d'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: Utiliser 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"
  )