Métadonnées de ressources

GoogleAdsFieldService 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 GoogleAdsService Search et SearchStream. Le catalogue fournit des métadonnées qui peuvent être utilisées par les clients de l'API Google Ads pour valider et construire des instructions en langage de requête Google Ads.

Exemple de requête et de réponse HTTP

La requête consiste en un HTTP GET envoyé au serveur d'API Google Ads à l'URL suivante:

https://googleads.googleapis.com/v16/googleAdsFields/{resource_or_field}

Voici un exemple de requête suivie de la réponse renvoyée par GoogleAdsFieldService pour la ressource ad_group:

Requête

https://googleads.googleapis.com/v16/googleAdsFields/ad_group

Réponse

{
  "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",
    ...
  ]
}

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 est RESOURCE.
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 de 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 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 clause FROM. Par exemple, si nous sélectionnons ad_group.id et segments.date dans ad_group, et que nous voulons inclure les attributs de campaign, nous devons vérifier que segments.date se trouve dans l'attribut selectableWith de la campagne, car il est sélectionné parallèlement au champ segments.date existant.

Détails des métadonnées

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

Ressource
Exemple : googleAdsFields/campaign.
Champ de la ressource
Exemple : googleAdsFields/campaign.name.
Champ de segmentation
Exemple : googleAdsFields/segments.ad_network_type.
Métrique
Exemple : googleAdsFields/metrics.clicks.