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 premier niveau d'un compte est le client.

• Chaque compte contient une ou plusieurs campagnes actives campaigns.

• 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 le déclenchement des annonces.

  • Il existe de nombreux types de critères, tels que 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 spécifier des budgets et des dates pour l'ensemble de la campagne.

Ressources

Les ressources représentent les entités de votre compte Search Ads 360. Par exemple, les ressources incluent Customer, Campaign et AdGroup.

ID d'objet

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

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 ad. Vous pouvez accéder à la valeur du type via le AdGroupAd.ad.type champ. Sa valeur est renvoyée dans l' AdType énumération.

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 de campagne se présentent sous la forme suivante :

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Une campagne dont l'ID est 987654 dans le compte Search Ads 360 dont l'ID client est 1234567 a le resource_name suivant :

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 ressource et les statistiques sur les 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 affiner les statistiques sur les performances. Pour en savoir plus, consultez Créer des rapports de recherche et Langage de requête Search Ads 360.

Service de champ

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 Récupérer les métadonnées de ressources.

Services spécifiques aux entités

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 aux entités :

• CustomColumnService qui renvoie la colonne personnalisée demandée en détail.