Ressourcenmetadaten

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

Beispiel für HTTP-Anfrage und -Antwort

Die Anfrage besteht aus einem HTTP GET an den Google Ads API-Server unter der folgenden URL:

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

Das folgende Beispiel zeigt eine Anfrage, gefolgt von der Antwort, die von GoogleAdsFieldService für die Ressource ad_group zurückgegeben wird:

Anfrage

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

Antwort

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

In diesem Beispiel sind die wichtigen Arrays:

attributeResources
Ressourcen, die implizit mit der Ressource in der FROM-Klausel verknüpft werden können.
metrics
Messwerte, die mit der Ressource in der FROM-Klausel ausgewählt werden können. Wird nur für Felder ausgefüllt, in denen category RESOURCE ist.
segments
Segment-Schlü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, in denen category RESOURCE ist.
selectableWith

Mit dem Attribut selectableWith für ein Ressourcen- oder Segmentfeld werden andere Ressourcen, Segmente oder Messwerte angegeben, die in derselben GAQL-Abfrage ausgewählt werden können. Dieses Attribut ist wichtig, wenn Sie Felder aus einer Ressource oder einem Segment einbeziehen möchten, die nicht in der FROM-Klausel angegeben sind.

Beim Erstellen einer GAQL-Abfrage gilt Folgendes:

  1.  Die Ressource in der FROM-Klausel ist die primäre Entität. Sie können immer Felder aus dieser Ressource auswählen.
  2.  Sie können auch kompatible Messwerte und Segmente auswählen, die für die primäre Einheit verfügbar sind.
  3.  Wenn Sie Felder aus einer Ressource oder einem Segment außerhalb der FROM-Klausel einfügen, müssen Sie dafür sorgen, dass diese Ressource oder dieses Segment, die bzw. das nicht FROM ist, mit allen anderen Feldern, Segmenten und Messwerten kompatibel ist, die in der Abfrage ausgewählt sind.

Die selectableWith-Liste für eine bestimmte Ressource (Ressource A) enthält alle anderen Ressourcen, Segmente und Messwerte, die zusammen mit Feldern aus Ressource A ausgewählt werden können, wenn Ressource A nicht die primäre Einheit ist.

Beispiel:

Sehen Sie sich diese Beispielabfrage an: SELECT ad_group.id, segments.date, campaign.name FROM ad_group

  •  Die FROM-Klausel gibt ad_group an.

  •  Mit dieser Abfrage werden ad_group.id (aus der Ressource FROM), segments.date und campaign.name ausgewählt.

  •  Da campaign.name ausgewählt ist, campaign aber nicht in der FROM-Klausel enthalten ist, müssen Sie die Kompatibilität mit anderen ausgewählten Elementen überprüfen.

  •  Damit diese Abfrage gültig ist, muss die campaign-Ressource mit segments.date (einem anderen ausgewählten Feld) kompatibel sein. Daher müssen Sie das Attribut selectableWith für die Ressource campaign prüfen. Wenn segments.date in der selectableWith-Liste von campaign vorhanden ist, ist die Anfrage gültig.

Wenn Sie Felder aus einer Ressource auswählen, die nicht in der FROM-Klausel enthalten ist, muss die selectableWith-Liste dieser Ressource alle anderen Segmente und Ressourcen enthalten, die in Ihrer SELECT-Klausel vorhanden sind.

Metadatendetails

Sie können den Katalog mit GoogleAdsFieldService auf diesen Ebenen anfordern:

Ressource
Beispiel: googleAdsFields/campaign.
Feld der Ressource
Beispiel: googleAdsFields/campaign.name.
Segmentierungsfeld
Beispiel: googleAdsFields/segments.ad_network_type.
Messwert
Beispiel: googleAdsFields/metrics.clicks.