Mappages JSON

bookmark_border Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Lorsque vous utilisez l'interface REST de l'API Search Ads 360 Reporting, vous travaillez avec des représentations JSON des mêmes ressources et types définis dans les fichiers .proto descriptor de l'API Search Ads 360 Reporting. Le schéma d'encodage JSON suit le schéma d'encodage canonique décrit dans la section Mappage JSON du guide de langage des tampons de protocole.

En général, tous les messages de niveau supérieur à destination et en provenance des services sont des objets JSON uniques. Les réponses search sont des objets JSON contenant un tableau results avec l'ensemble de résultats de votre requête.

Les identifiants sont transformés de snake_case (dans les tampons de protocole) en lowerCamelCase au format JSON. Une exception notable à cette règle concerne l'utilisation de search ou searchStream pour envoyer des requêtes Search Ads 360 Query Language. Le langage de requête lui-même utilise le snake case, quelle que soit l'interface que vous utilisez. Toutefois, les résultats d'une requête dans REST sont renvoyés en tant qu'objets JSON normaux et leurs identifiants sont en CamelCase inférieur.

Par exemple, une requête permettant d'extraire une liste de mots clés actifs dans un compte utilise la casse en snake case dans la requête elle-même (ad_group_criterion, et non adGroupCriterion):

POST /v0/customers/CUSTOMER_ID/searchAds360:searchStream HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN

{
  "query": "SELECT ad_group_criterion.keyword.text
            FROM ad_group_criterion
            WHERE ad_group_criterion.type = 'KEYWORD'
            AND ad_group_criterion.status = 'ENABLED'"
}

Toutefois, la réponse est une représentation JSON des objets (encapsulant un tableau JSON, car cette requête utilise searchStream) et utilise l'identifiant adGroupCriterion en CamelCase à la place:

[
  {
    "results": [
      {
        "adGroupCriterion": {
          "resourceName": "customers/1842689525/adGroupCriteria/55771861891~10003060",
          "keyword": {
            "text": "pay per click"
          }
        }
      },
      ...
    ]
  }
]