Metadati delle risorse

Puoi utilizzare SearchAds360FieldService per richiedere dinamicamente il catalogo delle risorse, dei campi delle risorse, delle chiavi di segmentazione e delle metriche disponibili nei metodi SearchAds360Service Search e SearchStream. Il catalogo fornisce metadati che possono essere utilizzati dai clienti dell'API Search Ads 360 Reporting per la convalida e la creazione di istruzioni del linguaggio di query di Search Ads 360.

Richiesta e risposta HTTP di esempio

La richiesta consiste in un HTTP GET al server dell'API Search Ads 360 Reporting all'URL seguente:

https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}

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

Richiesta

https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group

Risposta

{
  "resourceName": "searchAds360Fields/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 selezioni ad_group.id e segments.date da ad_group e vuoi includere gli attributi di campaign, devi 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 SearchAds360FieldService a questi livelli:

Risorsa

Ad esempio, searchAds360Fields/campaign.

Campo della risorsa

Ad esempio, searchAds360Fields/campaign.name.

Campo di segmentazione

Ad esempio, searchAds360Fields/segments.ad_network_type.

Metrica

Ad esempio, searchAds360Fields/metrics.clicks.

Utilizzare una query per ottenere i dettagli del campo

È possibile ottenere i dettagli del campo inviando una query a

https://searchads360.googleapis.com/v0/searchAds360Fields:search

Esempio 1: utilizzo di un'espressione regolare.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE name LIKE 'ad_group.%'"

Esempio 2: esecuzione di query su campi, metriche o segmenti specifici.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE
  name IN (
    "ad_group.id",
    "ad_group.name",
    "segments.date",
    "customer.id",
    "customer.manager",
    "metrics.clicks"
  )