Metadati delle risorse

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

Esempio di richiesta e risposta HTTP

La richiesta è costituita da un HTTP GET al server API Search Ads 360 Reporting al seguente URL:

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 disponibili per la selezione con la risorsa nella clausola FROM. Compilato solo per i campi in cui category è RESOURCE.
segments
Segmenta le chiavi che possono essere selezionate con la risorsa nella clausola FROM. Esse segmentano le metriche specificate nella query. Compilato solo per i campi in cui category è RESOURCE.
selectableWith
Campi che possono essere selezionati insieme a un determinato campo, quando non sono presenti nella clausola FROM. Questo attributo è pertinente solo quando si identificano risorse o segmenti che possono essere selezionati in una query in cui 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 della 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 segmentazione
Ad esempio, searchAds360Fields/segments.ad_network_type.
Metrica
Ad esempio, searchAds360Fields/metrics.clicks.

Utilizza una query per ottenere i dettagli dei campi

È possibile ottenere i dettagli dei campi 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: eseguire 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"
  )