Metadata Resource

Anda dapat menggunakan SearchAds360FieldService untuk meminta katalog secara dinamis untuk resource, kolom resource, kunci segmentasi, dan metrik yang tersedia di metode SearchAds360Service Search dan SearchStream. Katalog ini 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 ini 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 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 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 Anda memilih ad_group.id dan segments.date dari ad_group, dan ingin menyertakan atribut dari campaign, Anda 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 SearchAds360FieldService di 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

Anda bisa mendapatkan detail kolom dengan mengirimkan 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"
  )