Mengambil metadata resource di Search Ads 360 Reporting API

SearchAds360FieldService memungkinkan Anda mengambil metadata untuk resource. Anda dapat menggunakan layanan ini untuk meminta katalog resource secara dinamis, kolom resource, kunci segmentasi, dan metrik yang tersedia dalam metode SearchAds360Service.Search dan SearchAds360Service.SearchStream. Lihat Layanan penelusuran untuk mengetahui informasi selengkapnya.

Katalog ini menyediakan metadata yang digunakan klien Search Ads 360 Reporting API untuk memvalidasi dan membuat 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/VERSION_NUMBER/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",
    ...
  ]
}
  • attributeResources adalah resource yang dapat digabungkan secara implisit ke resource di klausa FROM.
  • metrics adalah daftar kolom yang dapat dipilih saat resource digunakan dalam klausa FROM. Hanya diisi untuk kolom dengan category dari RESOURCE.
  • segments adalah daftar kolom segmen yang dapat dipilih saat resource digunakan dalam klausa FROM. Hanya diisi untuk kolom dengan category dari RESOURCE. Kolom ini mengelompokkan metrik yang dipilih dalam kueri. Lihat Segmentasi untuk mempelajari lebih lanjut.
  • selectableWith mencantumkan kolom yang dapat dipilih bersama dengan kolom resource jika tidak berada dalam klausa FROM. Atribut ini hanya relevan untuk mengidentifikasi resource atau segmen yang tidak disertakan oleh resource di klausa FROM. Misalnya, jika Anda memilih ad_group.id dan segments.date dari ad_group dan ingin menyertakan atribut dari campaign, Anda harus memeriksa apakah segments.date berada dalam atribut selectableWith untuk campaign, karena atribut tersebut dipilih bersama dengan kolom segments.date yang ada.

Lihat Dokumentasi referensi untuk informasi selengkapnya.

Detail metadata

Anda dapat meminta katalog menggunakan SearchAds360FieldService pada level berikut:

Resource
Misalnya, searchAds360Fields/campaign.
Kolom aset
Misalnya, searchAds360Fields/campaign.name.
Kolom segmentasi
Misalnya, searchAds360Fields/segments.ad_network_type.
Kolom metrik
Misalnya, searchAds360Fields/metrics.clicks.