Anda dapat menggunakan GoogleAdsFieldService
untuk secara dinamis meminta katalog resource, kolom resource, kunci
segmentasi, dan metrik yang tersedia dalam metode GoogleAdsService
Penelusuran dan SearchStream. Katalog menyediakan metadata yang dapat digunakan oleh klien Google Ads API untuk validasi dan pembuatan pernyataan Bahasa Kueri Google Ads.
Contoh permintaan dan respons HTTP
Permintaan terdiri dari HTTP GET
ke server Google Ads API di URL
berikut:
https://googleads.googleapis.com/v16/googleAdsFields/{resource_or_field}
Berikut adalah contoh permintaan yang diikuti dengan respons yang ditampilkan dari
GoogleAdsFieldService
untuk resource ad_group:
Permintaan
https://googleads.googleapis.com/v16/googleAdsFields/ad_group
Respons
{
"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",
...
]
}
Untuk contoh ini, array pentingnya adalah:
attributeResources
- Resource yang dapat digabungkan secara implisit ke resource di klausa
FROM
. metrics
- Metrik yang tersedia untuk dipilih dengan resource di 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 memilihad_group.id
dansegments.date
dariad_group
, dan ingin menyertakan atribut daricampaign
, kita harus memeriksa bahwasegments.date
berada dalam atributselectableWith
untuk kampanye, karena atribut tersebut dipilih bersama dengan kolomsegments.date
yang sudah ada.
Detail metadata
Anda dapat meminta katalog menggunakan GoogleAdsFieldService
di tingkat berikut:
- Resource
- Misalnya,
googleAdsFields/campaign
. - Kolom resource
- Misalnya,
googleAdsFields/campaign.name
. - Kolom segmentasi
- Misalnya,
googleAdsFields/segments.ad_network_type
. - Metrik
- Misalnya,
googleAdsFields/metrics.clicks
.