Métadonnées de ressources

Vous pouvez utiliser GoogleAdsFieldService pour demander dynamiquement le catalogue des ressources, des champs de ressources, des clés de segmentation et des métriques disponibles dans les méthodes Search et SearchStream de GoogleAdsService. 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 du langage de requête Google Ads.

Exemple de requête et de réponse HTTP

Remarque : L'exemple montre la requête HTTP/JSON sous-jacente à titre indicatif, mais nous vous encourageons vivement à utiliser l'une des bibliothèques clientes basées sur gRPC pour envoyer vos requêtes.

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

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

L'exemple suivant montre une requête suivie de la réponse renvoyée par GoogleAdsFieldService pour la ressource ad_group :

Requête

https://googleads.googleapis.com/v20/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",
    ...
  ]
}

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. Rempli uniquement pour les champs où category est défini sur 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. Renseigné uniquement pour les champs où category est défini sur 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 nous sélectionnons ad_group.id et segments.date dans ad_group, et que nous souhaitons inclure des attributs de campaign, nous devons vérifier que segments.date se trouve dans l'attribut selectableWith de la campagne, car il est sélectionné en même temps que le champ segments.date existant.

Détails des métadonnées

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

Ressource

Par exemple, googleAdsFields/campaign.

Champ de la ressource

Par exemple, googleAdsFields/campaign.name.

Champ de segmentation

Par exemple, googleAdsFields/segments.ad_network_type.

Métrique

Par exemple, googleAdsFields/metrics.clicks.