Za pomocą SearchAds360FieldService
możesz dynamicznie wysyłać żądania katalogu dotyczące zasobów, pól zasobów, kluczy podziału na segmenty i wskaźników dostępnych w metodach SearchAds360Service
Search
i SearchStream
. Katalog zawiera metadane, które mogą być używane przez klienty interfejsu Search Ads 360 Reporting API do weryfikowania i tworzenia instrukcji w Search Ads 360 w języku zapytań.
Przykładowe żądanie i odpowiedź HTTP
Żądanie składa się z elementu HTTP GET
do serwera Search Ads 360 Reporting API pod tym adresem URL:
https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}
Poniżej znajdziesz przykład żądania, po którym następuje odpowiedź zwrócona przez funkcję SearchAds360FieldService
dla zasobu ad_group:
Prośba
https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group
Odpowiedź
{
"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",
...
]
}
W tym przykładzie ważne tablice to:
attributeResources
- Zasoby, które mogą zostać niejawnie połączone z zasobem w klauzuli
FROM
. metrics
- Wskaźniki, które można wybrać z zasobem w klauzuli
FROM
. Wartość jest podawana tylko w przypadku pól, w którychcategory
toRESOURCE
. segments
- Segmentuj klucze, które można wybrać z zasobem w klauzuli
FROM
. Segmentują one dane określone w zapytaniu. Wartość jest wypełniana tylko w przypadku pól, w którychcategory
toRESOURCE
. selectableWith
- Pola, które można wybrać obok danego pola, gdy nie ma go w klauzuli
FROM
. Ten atrybut ma znaczenie tylko przy identyfikowaniu zasobów lub segmentów, które można wybrać w zapytaniu, jeśli nie zostały one uwzględnione przez zasób w klauzuliFROM
. Jeśli na przykład wybieraszad_group.id
isegments.date
zad_group
oraz chcesz uwzględnić atrybuty zcampaign
, sprawdź, czysegments.date
znajduje się w atrybucieselectableWith
kampanii, ponieważ jest wybierany obok istniejącego polasegments.date
.
Szczegóły metadanych
Możesz poprosić o katalog, korzystając z elementu SearchAds360FieldService
na tych poziomach:
- Zasób
- Na przykład:
searchAds360Fields/campaign
. - Pole zasobu
- Na przykład:
searchAds360Fields/campaign.name
. - Pole podziału na segmenty
- Na przykład:
searchAds360Fields/segments.ad_network_type
. - Dane
- Na przykład:
searchAds360Fields/metrics.clicks
.
Pobieranie szczegółów pól za pomocą zapytania
Szczegóły pól można uzyskać, wysyłając zapytanie do
https://searchads360.googleapis.com/v0/searchAds360Fields:search
Przykład 1: użycie wyrażenia regularnego.
SELECT
name,
category,
selectable,
filterable,
sortable,
selectable_with,
data_type,
is_repeated
WHERE name LIKE 'ad_group.%'"
Przykład 2: wysyłanie zapytań o konkretne pola, dane lub segmenty.
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"
)