Mappature JSON

Quando utilizzi l'interfaccia REST dell'API Google Ads, lavori con rappresentazioni JSON delle stesse risorse e degli stessi tipi definiti nei file descrittori.proto dell'API Google Ads. Lo schema di codifica JSON segue lo schema di codifica canonico descritto nella sezione Mappatura JSON della guida al linguaggio dei buffer di protocollo.

In generale, tutti i messaggi di primo livello da e verso i servizi sono singoli oggetti JSON. La maggior parte delle richieste di modifica contiene un array operations che a sua volta contiene molte operazioni create, update o delete. Allo stesso modo, le risposte search sono oggetti JSON contenenti un array results con il set di risultati della query.

Gli identificatori vengono trasformati da snake_case (nei buffer di protocollo) a lowerCamelCase in JSON. Una nota importante di questa regola è quando utilizzi search o searchStream per inviare query nel linguaggio di query di Google Ads. Il linguaggio di query stesso utilizza snake case, indipendentemente dall'interfaccia che stai utilizzando. Tuttavia, i risultati di una query in REST vengono restituiti come normali oggetti JSON e i relativi identificatori sono in lowerCamelCase.

Ad esempio, una query per recuperare un elenco di parole chiave attive in un account utilizza snake case all'interno della query stessa (ad_group_criterion, non adGroupCriterion):

POST /v26/customers/CUSTOMER_ID/googleAds:searchStream HTTP/1.1
Host: googleads.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'"
}

Tuttavia, la risposta è una rappresentazione JSON degli oggetti (racchiusa in un array JSON poiché questa richiesta utilizza searchStream) e utilizza l'identificatore camelCase adGroupCriterion:

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