Anda dapat menggunakan SearchAds360FieldService
untuk secara dinamis meminta katalog resource, kolom resource,
kunci segmentasi, dan metrik yang tersedia dalam metode SearchAds360Service
Search
dan SearchStream
. Katalog menyediakan metadata yang dapat digunakan oleh klien Search Ads 360 Reporting API untuk validasi dan pembuatan pernyataan Bahasa Kueri Search Ads 360.
Contoh permintaan dan respons HTTP
Permintaan terdiri dari HTTP GET
ke server Search Ads 360 Reporting API di URL berikut:
https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}
Berikut adalah contoh permintaan yang diikuti dengan respons yang ditampilkan dari
SearchAds360FieldService
untuk resource ad_group:
Permintaan
https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group
Respons
{
"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",
...
]
}
Untuk contoh ini, array pentingnya adalah:
attributeResources
- Resource yang dapat digabungkan secara implisit ke resource dalam klausa
FROM
. metrics
- Metrik yang tersedia untuk dipilih dengan resource dalam klausa
FROM
. Hanya diisi untuk kolom yangcategory
-nya adalahRESOURCE
. segments
- Kunci segmen yang dapat dipilih dengan resource di klausa
FROM
. Segmen ini mengelompokkan metrik yang ditentukan dalam kueri. Hanya diisi untuk kolom dengancategory
adalahRESOURCE
. selectableWith
- Kolom yang dapat dipilih bersama kolom tertentu, jika tidak ada dalam klausa
FROM
. Atribut ini hanya relevan saat mengidentifikasi resource atau segmen yang dapat dipilih dalam kueri yang tidak disertakan oleh resource dalam klausaFROM
. Misalnya, jika Anda memilihad_group.id
dansegments.date
dariad_group
, dan Anda ingin menyertakan atribut daricampaign
, Anda harus memeriksa bahwasegments.date
berada dalam atributselectableWith
untuk kampanye, karena atribut tersebut dipilih bersama kolomsegments.date
yang sudah ada.
Detail metadata
Anda dapat meminta katalog menggunakan SearchAds360FieldService
pada tingkat
berikut:
- Resource
- Misalnya,
searchAds360Fields/campaign
. - Kolom resource
- Misalnya,
searchAds360Fields/campaign.name
. - Kolom segmentasi
- Misalnya,
searchAds360Fields/segments.ad_network_type
. - Metrik
- Misalnya,
searchAds360Fields/metrics.clicks
.
Menggunakan kueri untuk mendapatkan detail kolom
Detail {i>field<i} bisa diperoleh dengan mengirim kueri ke
https://searchads360.googleapis.com/v0/searchAds360Fields:search
Contoh 1: Menggunakan ekspresi reguler.
SELECT
name,
category,
selectable,
filterable,
sortable,
selectable_with,
data_type,
is_repeated
WHERE name LIKE 'ad_group.%'"
Contoh 2: Membuat kueri untuk kolom, metrik, atau segmen tertentu.
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"
)