Mit SearchAds360FieldService
können Sie den Katalog dynamisch nach Ressourcen, Ressourcenfeldern, Segmentierungsschlüsseln und Messwerten anfordern, die in den SearchAds360Service
-Methoden 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 HTTP-Anfrage und -Antwort
Die Anfrage besteht aus einer HTTP GET
an den Server der Search Ads 360 Reporting API unter der folgenden URL:
https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}
Das folgende Beispiel zeigt eine Anfrage, gefolgt von der Antwort, die von SearchAds360FieldService
für die Ressource ad_group zurückgegeben wurde:
Anfragen
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",
...
]
}
In diesem Beispiel sind dies die folgenden 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 denencategory
den WertRESOURCE
hat. segments
- Segmentschlüssel, die zusammen 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 denencategory
den WertRESOURCE
hat. selectableWith
- Felder, die neben einem bestimmten Feld ausgewählt werden können, wenn nicht in der
FROM
-Klausel enthalten ist. Dieses Attribut ist nur relevant, wenn Ressourcen oder Segmente identifiziert werden, die in einer Abfrage ausgewählt werden können und bei denen sie nicht von der Ressource in derFROM
-Klausel enthalten sind. Wenn Sie beispielsweisead_group.id
undsegments.date
ausad_group
auswählen und Attribute auscampaign
einbeziehen möchten, musssegments.date
im AttributselectableWith
der Kampagne enthalten sein, da es zusammen mit dem vorhandenen Feldsegments.date
ausgewählt wird.
Metadatendetails
Sie können den Katalog mit dem 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 über eine Abfrage abrufen
Sie können Felddetails abrufen, indem Sie eine Abfrage 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: Bestimmte Felder, Messwerte oder Segmente abfragen
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"
)