Structure de l'API de création de rapports Search Ads 360

Les principaux composants de l'API Search Ads 360 Reporting sont les ressources et les services. Une ressource représente une entité Search Ads 360, et vous utilisez un service pour récupérer des entités Search Ads 360.

Hiérarchie des objets

Un compte Search Ads 360 est une hiérarchie d'objets.

  • La ressource de niveau supérieur d'un compte est le client.

  • Chaque compte contient une ou plusieurs campagnes actives.

  • Chaque Campaign contient un ou plusieurs groupes d'annonces qui regroupent vos annonces en collections logiques.

  • Chaque AdGroup contient une ou plusieurs annonces de groupe d'annonces.

  • Vous pouvez associer une ou plusieurs AdGroupCriterion ou CampaignCriterion à un groupe d'annonces ou à une campagne. Les critères définissent la manière dont les annonces sont déclenchées.

    • Il existe de nombreux types de critères, comme les mots clés, les tranches d'âge et les zones géographiques. Les critères définis au niveau de la campagne affectent toutes les autres ressources de la campagne. Vous pouvez également définir des dates et des budgets pour l'ensemble de la campagne.

Ressources

Les ressources représentent les entités de votre compte Search Ads 360. Customer, Campaign et AdGroup sont des exemples de ressources.

ID des objets

Chaque objet de Search Ads 360 est identifié par son propre ID. Certains ID sont uniques au niveau mondial, c'est-à-dire pour tous les comptes Search Ads 360, tandis que d'autres ne sont uniques que dans un champ d'application limité.

Champ d'application de l'unicité des ID d'objet
ID du budget Monde
ID de la campagne Monde
ID groupe d'annonces Monde
Identifiant d'annonce Groupe d'annonces

Chaque paire AdGroupId / AdId est globalement unique.
ID du critère de groupe d'annonces Groupe d'annonces

Chaque paire AdGroupId / CriterionId est globalement unique.
ID du critère de campagne Campagne

Chaque paire CampaignId / CriterionId est globalement unique.
Extensions d'annonce Campagne

Chaque paire CampaignId / AdExtensionId est globalement unique.
ID du flux Monde
ID de l'élément de flux Monde
ID de l'attribut du flux Flux
ID de correspondance de flux Monde
ID du libellé Monde
ID de la liste d'utilisateurs Monde

Ces règles d'ID peuvent être utiles lorsque vous concevez un stockage local pour vos objets Search Ads 360.

Types d'objet

Certains objets peuvent être utilisés pour plusieurs types d'entités. Dans ce cas, l'objet contient un champ type qui décrit son contenu. Par exemple, AdGroupAd peut faire référence à une annonce textuelle, à une annonce d'hôtel ou à une annonce locale. Vous pouvez accéder à la valeur du type via le champ AdGroupAd.ad.type. Sa valeur est renvoyée dans l'énumération AdType.

Noms de ressources

Chaque ressource est identifiée de manière unique par une chaîne resource_name qui concatène la ressource et ses parents dans un chemin d'accès.

Par exemple, les noms de ressources "Campagne" se présentent comme suit:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Une campagne avec l'ID 987654 dans le compte Search Ads 360 avec le numéro client 1234567 a les resource_name suivantes:

customers/1234567/campaigns/987654

Services

Les services vous permettent de récupérer vos entités et métadonnées Search Ads 360. Il existe trois types de services:

Service de recherche
SearchAds360Service est le service unique et unifié permettant de récupérer tous les objets de ressources et les statistiques de performances. Il fournit deux méthodes: Search et SearchStream. Les deux méthodes nécessitent une requête qui spécifie la ressource à interroger, les attributs de ressource et les métriques de performances à récupérer, les prédicats à utiliser pour filtrer la requête et les segments à utiliser pour approfondir les statistiques de performances. Pour en savoir plus, consultez Créer des rapports sur les recherches et Langage de requête Search Ads 360.
Service sur le terrain
SearchAds360FieldService récupère les métadonnées sur les ressources, telles que les attributs disponibles pour une ressource et son type de données. Vous pouvez demander le catalogue des ressources, des champs de ressources, des clés de segmentation et des métriques disponibles dans les méthodes de recherche SearchAds360Service. Pour en savoir plus, consultez la section Récupérer les métadonnées de ressource.
Services spécifiques à l'entité

Ces services fournissent une méthode de requête GET qui récupère une seule instance de ressource. Cela est utile pour examiner la structure d'une ressource.

Voici quelques exemples de services spécifiques à une entité: