Metadati delle risorse

Puoi utilizzare GoogleAdsFieldService per richiedere dinamicamente il catalogo delle risorse, dei campi delle risorse, delle chiavi di segmentazione e delle metriche disponibili nei metodi GoogleAdsService Search e SearchStream. Il catalogo fornisce metadati che possono essere utilizzati dai client dell'API Google Ads per la convalida e la creazione di istruzioni in Google Ads Query Language.

Richiesta e risposta HTTP di esempio

Nota: l'esempio mostra la richiesta HTTP/JSON sottostante come guida, ma ti consigliamo vivamente di utilizzare una delle librerie client basate su gRPC per inviare le richieste.

La richiesta consiste in un HTTP GET al server dell'API Google Ads al seguente URL:

https://googleads.googleapis.com/v19/googleAdsFields/{resource_or_field}

Di seguito è riportato un esempio di richiesta seguita dalla risposta restituita da GoogleAdsFieldService per la risorsa ad_group:

Richiesta

https://googleads.googleapis.com/v19/googleAdsFields/ad_group

Risposta

{
  "resourceName": "googleAdsFields/ad_group",
  "name": "ad_group",
  "category": "RESOURCE",
  "selectable": false,
  "filterable": false,
  "sortable": false,
  "selectableWith": [
    "campaign",
    "customer",
    "metrics.average_cpc",
    "segments.device",
    ...
  ],
  "attributeResources": [
    "customer",
    "campaign"
  ],

  "metrics": [
    "metrics.conversions",
    "metrics.search_budget_lost_impression_share",
    "metrics.average_cost",
    "metrics.clicks",
    ...
  ],
  "segments": [
    "segments.date",
    "segments.ad_network_type",
    "segments.device",
    ...
  ]
}

Per questo esempio, gli array importanti sono:

attributeResources

Risorse che possono essere unite implicitamente alla risorsa nella clausola FROM.

metrics

Metriche che possono essere selezionate con la risorsa nella clausola FROM. Viene compilato solo per i campi in cui category è RESOURCE.

segments

Chiavi di segmento che possono essere selezionate con la risorsa nella clausola FROM. Questi segmentano le metriche specificate nella query. Viene compilato solo per i campi in cui category è RESOURCE.

selectableWith

Campi che possono essere selezionati insieme a un determinato campo, se non sono inclusi nella clausola FROM. Questo attributo è pertinente solo per identificare le risorse o i segmenti che possono essere selezionati in una query se non sono inclusi dalla risorsa nella clausola FROM. Ad esempio, se selezioniamo ad_group.id e segments.date da ad_group e vogliamo includere gli attributi di campaign, dobbiamo verificare che segments.date sia nell'attributo selectableWith per la campagna, poiché viene selezionato insieme al campo segments.date esistente.

Dettagli dei metadati

Puoi richiedere il catalogo utilizzando GoogleAdsFieldService a questi livelli:

Risorsa

Ad esempio, googleAdsFields/campaign.

Campo della risorsa

Ad esempio, googleAdsFields/campaign.name.

Campo di segmentazione

Ad esempio, googleAdsFields/segments.ad_network_type.

Metrica

Ad esempio, googleAdsFields/metrics.clicks.