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 dans des collections logiques.

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

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

    • Il existe de nombreux types de critères, tels que des mots clés, des tranches d'âge et des zones géographiques. Les critères définis au niveau de la campagne affectent toutes les autres ressources de la campagne. Vous pouvez également spécifier 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. Voici quelques exemples de ressources : Customer, Campaign et AdGroup.

ID des objets

Chaque objet dans Search Ads 360 est identifié par son propre ID. Certains ID sont uniques au niveau mondial, c'est-à-dire sur l'ensemble des comptes Search Ads 360, tandis que d'autres ne le sont que dans un champ d'application restreint.

Portée de l'unicité de l'ID d'objet
ID du budget Global
ID de campagne Global
ID groupe d'annonces Global
Identifiant d'annonce Groupe d'annonces

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

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

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

Chaque paire CampaignId / AdExtensionId est unique.
ID du flux Global
ID de l'élément de flux Global
ID de l'attribut du flux Flux
ID de correspondance de flux Global
ID du libellé Global
ID UserList Global

Ces règles d'identifiant peuvent s'avérer utiles lors de la conception d'un stockage local pour vos objets Search Ads 360.

Types d'objets

Certains objets peuvent être utilisés pour plusieurs types d'entités. Dans ce cas, l'objet comporte 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.

Les noms de ressources de campagne, par exemple, se présentent sous la forme suivante:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Une campagne associée à l'ID 987654 dans le compte Search Ads 360 associé au numéro client 1234567 comporte l'élément resource_name:

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 ressources et les statistiques de performances. Elle fournit deux méthodes: Search et SearchStream. Ces deux méthodes nécessitent une requête spécifiant 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 ventiler davantage les statistiques de performances. Pour en savoir plus, consultez Créer des rapports de recherche 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 pour les ressources, les champs de ressources, les clés de segmentation et les 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 ressources.
Services spécifiques à une entité

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

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