Anda dapat menggunakan GoogleAdsFieldService
untuk meminta katalog secara dinamis untuk resource, kolom resource, kunci segmentasi, dan metrik
yang tersedia di metode GoogleAdsService
Penelusuran dan SearchStream. Katalog ini 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/v17/googleAdsFields/{resource_or_field}
Berikut adalah contoh permintaan, diikuti dengan respons yang ditampilkan dari
GoogleAdsFieldService
untuk resource ad_group:
Permintaan
https://googleads.googleapis.com/v17/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 dalam klausa
FROM
. metrics
- Metrik yang tersedia untuk dipilih dengan resource dalam klausa
FROM
. Hanya diisi untuk kolom yangcategory
-nya adalahRESOURCE
. segments
- Segmentasikan kunci yang dapat dipilih dengan resource dalam klausa
FROM
. 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 di klausaFROM
. Sebagai contoh, jika memilihad_group.id
dansegments.date
dariad_group
, dan ingin menyertakan atribut daricampaign
, kita harus memeriksa apakahsegments.date
ada dalam atributselectableWith
untuk kampanye, karena dipilih bersama kolomsegments.date
yang ada.
Detail metadata
Anda dapat meminta katalog menggunakan GoogleAdsFieldService
pada 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
.