Métadonnées de ressources

GoogleAdsFieldService vous permet de demander dynamiquement 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 que les clients de l'API Google Ads peuvent utiliser pour valider et créer des instructions de 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 recommandons vivement d'utiliser l'une des bibliothèques clientes basées sur gRPC pour envoyer vos requêtes.

La demande consiste en une demande HTTP GET envoyée au serveur de l'API Google Ads à l'URL suivante:

https://googleads.googleapis.com/v17/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/v17/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 associées 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 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 pour lesquels category est défini sur RESOURCE.

selectableWith

Champs pouvant être sélectionnés à côté d'un champ donné, lorsqu'ils ne se trouvent pas dans la clause FROM. Cet attribut n'est pertinent que lorsque vous identifiez 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 souhaitons 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é 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 aux niveaux suivants:

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.