資源中繼資料

您可以使用 GoogleAdsFieldService 動態要求目錄,以便取得 GoogleAdsService SearchSearchStream 方法提供的資源、資源欄位、區隔鍵和指標。目錄提供的中繼資料可供 Google Ads API 用戶端驗證和建構 Google Ads 查詢語言陳述式。

HTTP 要求和回應範例

這項要求包含 HTTP GET 至位於下列網址的 Google Ads API 伺服器:

https://googleads.googleapis.com/v17/googleAdsFields/{resource_or_field}

以下範例為要求,後面接著 GoogleAdsFieldService 針對 ad_group 資源傳回的回應:

要求

https://googleads.googleapis.com/v17/googleAdsFields/ad_group

回覆

{
  "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",
    ...
  ]
}

這個範例中的重要陣列如下:

attributeResources
可間接連結至 FROM 子句中資源的資源。
metrics
可透過 FROM 子句中資源選取的指標。只有 categoryRESOURCE 的欄位才會填入這個欄位。
segments
區隔可以使用 FROM 子句中資源選取的鍵。這些區隔會區隔查詢中指定的指標。只有 categoryRESOURCE 的欄位才會填入這個欄位。
selectableWith
如果不在 FROM 子句中,可以連同指定欄位一起選取欄位。只有在要識別出可於查詢中選取的資源或區段時,其資源不在 FROM 子句中的資源內時,這項屬性才有關聯。舉例來說,如果從 ad_group 中選取 ad_group.idsegments.date,而想要納入 campaign 的屬性,則必須檢查 segments.date 是否位於廣告活動的 selectableWith 屬性中,因為這是與現有 segments.date 欄位一併選取。

中繼資料詳細資料

您可以在下列層級使用 GoogleAdsFieldService 要求目錄:

資源
例如:googleAdsFields/campaign
資源的欄位
例如:googleAdsFields/campaign.name
區隔欄位
例如:googleAdsFields/segments.ad_network_type
指標
例如:googleAdsFields/metrics.clicks