資源中繼資料

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

HTTP 要求和回應範例

這項要求包含對下列網址的 Google Ads API 伺服器發出的 HTTP GET

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

以下範例顯示要求,以及 GoogleAdsFieldServicead_group 資源傳回的回應:

要求

https://googleads.googleapis.com/v20/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 的屬性,就必須檢查廣告活動的 selectableWith 屬性是否包含 segments.date,因為 segments.date 是與現有 segments.date 欄位一起選取。

中繼資料詳細資料

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

資源
舉例來說,googleAdsFields/campaign
資源的欄位
舉例來說,googleAdsFields/campaign.name
區隔欄位
舉例來說,googleAdsFields/segments.ad_network_type
指標
舉例來說,googleAdsFields/metrics.clicks