Ingin menyampaikan masukan tentang Google Ads API? Daftar untuk diundang berpartisipasi dalam riset pengguna.

Halaman ini diterjemahkan oleh Cloud Translation API.

Metadata Resource

Anda dapat menggunakan GoogleAdsFieldService untuk meminta katalog secara dinamis untuk resource, kolom resource, kunci segmentasi, dan metrik yang tersedia di metode GoogleAdsService Search dan SearchStream. Katalog menyediakan metadata yang dapat digunakan oleh klien Google Ads API untuk validasi dan pembuatan pernyataan Google Ads Query Language.

Contoh permintaan dan respons HTTP

Permintaan terdiri dari HTTP GET ke server Google Ads API di URL berikut:

https://googleads.googleapis.com/v19/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/v19/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 yang penting adalah:

attributeResources: Resource yang dapat secara implisit digabungkan ke resource dalam klausa FROM.
metrics: Metrik yang tersedia untuk dipilih dengan resource dalam klausa FROM. Hanya diisi untuk kolom dengan category adalah RESOURCE.
segments: Kunci segmen yang dapat dipilih dengan resource dalam klausa FROM. Dimensi ini menyegmentasikan metrik yang ditentukan dalam kueri. Hanya diisi untuk kolom dengan category RESOURCE.
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 jika tidak disertakan oleh resource dalam klausa FROM. Misalnya, jika kita memilih ad_group.id dan segments.date dari ad_group, dan ingin menyertakan atribut dari campaign, kita harus memeriksa apakah segments.date ada dalam atribut selectableWith untuk kampanye, karena dipilih bersama kolom segments.date yang 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.