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 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/v22/googleAdsFields/{resource_or_field}

Contoh berikut menunjukkan permintaan yang diikuti dengan respons yang ditampilkan dari GoogleAdsFieldService untuk resource ad_group:

Permintaan

https://googleads.googleapis.com/v22/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 dengan category adalah RESOURCE.

segments

Kunci segmen

yang dapat dipilih dengan resource dalam klausa FROM. Segmen ini membagi metrik yang ditentukan dalam kueri. Hanya diisi untuk kolom dengan category adalah RESOURCE.

selectableWith

Atribut selectableWith pada kolom resource atau segmen menentukan resource, segmen, atau metrik lain yang dapat dipilih dalam kueri GAQL yang sama. Atribut ini sangat penting saat Anda ingin menyertakan kolom dari resource atau segmen yang tidak ditentukan dalam klausa FROM.

Saat membuat kueri GAQL:

1.  Resource dalam klausa FROM adalah entity utama. Anda selalu dapat memilih kolom dari resource ini.
2.  Anda juga dapat memilih metrik dan segmen yang kompatibel yang tersedia dengan entitas utama.
3.  Jika Anda menyertakan kolom dari resource atau segmen di luar klausa FROM, Anda harus memastikan bahwa resource atau segmen non-FROM ini kompatibel dengan semua kolom, segmen, dan metrik lain yang dipilih dalam kueri.

Daftar selectableWith untuk resource tertentu (kita sebut saja Resource A) berisi semua resource, segmen, dan metrik lain yang dapat dipilih bersama kolom dari Resource A saat Resource A bukan merupakan entitas utama.

Contoh:

Perhatikan contoh kueri ini: SELECT ad_group.id, segments.date, campaign.name FROM ad_group

•   Klausa FROM menentukan ad_group.

•   Kueri ini memilih ad_group.id (dari resource FROM), segments.date, dan campaign.name.

•   Karena campaign.name dipilih, tetapi campaign tidak ada dalam klausa FROM, Anda harus memverifikasi kompatibilitasnya dengan elemen lain yang dipilih.

•   Untuk memastikan kueri ini valid, resource campaign harus kompatibel dengan segments.date (kolom lain yang dipilih). Oleh karena itu, Anda harus memeriksa atribut selectableWith untuk resource campaign. Jika segments.date ada dalam daftar selectableWith campaign, kueri valid.

Jika Anda memilih kolom dari resource yang tidak ada dalam klausa FROM, daftar selectableWith resource tersebut harus menyertakan semua segmen dan resource lain yang ada dalam klausa SELECT Anda.

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.