Ressourcenmetadaten

Mit SearchAds360FieldService können Sie den Katalog dynamisch nach Ressourcen, Ressourcenfeldern, Segmentierungsschlüsseln und Messwerten abfragen, die in den Methoden SearchAds360Service Search und SearchStream verfügbar sind. Der Katalog enthält Metadaten, die von Search Ads 360 Reporting API-Clients zur Validierung und Erstellung von Search Ads 360 Query Language-Anweisungen verwendet werden können.

Beispiel für eine HTTP-Anfrage und ‑Antwort

Die Anfrage besteht aus einer HTTP GET an den Search Ads 360 Reporting API-Server unter der folgenden URL:

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

Im Folgenden sehen Sie ein Beispiel für eine Anfrage, gefolgt von der Antwort, die von SearchAds360FieldService für die Ressource ad_group zurückgegeben wurde:

Anfrage

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

Antwort

{
  "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",
    ...
  ]
}

Für dieses Beispiel sind die wichtigen Arrays:

attributeResources

Ressourcen, die implizit mit der Ressource in der FROM-Klausel zusammengeführt werden können.

metrics

Messwerte, die für die Auswahl mit der Ressource in der FROM-Klausel zur Verfügung stehen. Wird nur für Felder ausgefüllt, in denen category den Wert RESOURCE hat.

segments

-Segmentschlüssel, die mit der Ressource in der FROM-Klausel ausgewählt werden können. Damit werden die in der Abfrage angegebenen Messwerte segmentiert. Wird nur für Felder ausgefüllt, bei denen category = RESOURCE ist.

selectableWith

Felder, die zusammen mit einem bestimmten Feld ausgewählt werden können, wenn sie nicht in der FROM-Klausel enthalten sind. Dieses Attribut ist nur relevant, wenn Sie Ressourcen oder Segmente ermitteln, die in einer Abfrage ausgewählt werden können, wenn sie nicht von der Ressource in der FROM-Klausel enthalten sind. Wenn Sie beispielsweise ad_group.id und segments.date aus ad_group auswählen und Attribute aus campaign einschließen möchten, müssen Sie prüfen, ob segments.date im Attribut selectableWith für die Kampagne enthalten ist, da es zusammen mit dem vorhandenen segments.date-Feld ausgewählt wird.

Metadatendetails

Sie können den Katalog mit der SearchAds360FieldService auf folgenden Ebenen anfordern:

Ressource

Beispiel: searchAds360Fields/campaign.

Feld der Ressource

Beispiel: searchAds360Fields/campaign.name.

Segmentierungsfeld

Beispiel: searchAds360Fields/segments.ad_network_type.

Messwert

Beispiel: searchAds360Fields/metrics.clicks.

Felddetails mit einer Abfrage abrufen

Sie können Felddetails abrufen, indem Sie eine Anfrage an

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

Beispiel 1: Regulären Ausdruck verwenden

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

Beispiel 2: Abfragen bestimmter Felder, Messwerte oder Segmente

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"
  )