資源中繼資料

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

HTTP 要求和回應範例

這項要求包含 HTTP GET,可連至下列網址的 Search Ads 360 Reporting API 伺服器:

https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}

以下是要求範例,接著是 SearchAds360FieldService 針對 ad_group 資源傳回的回應:

要求

https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group

回應

{
  "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
可在 FROM 子句中隱含地與資源相連的資源。
metrics
FROM 子句中,可與資源一併選取的指標。只有 categoryRESOURCE 的欄位才會填入這項資料。
segments
可在 FROM 子句中使用資源選取的區隔鍵。這些區隔會將查詢中指定的指標劃分。只有 categoryRESOURCE 的欄位才會填入這個值。
selectableWith
如果不在 FROM 子句中,則可與特定欄位一併選取的欄位。只有在識別可在查詢中選取的資源或區段時,這項屬性才有相關性,因為 FROM 子句中的資源不會納入這些資源。舉例來說,如果您要從 ad_group 選取 ad_group.idsegments.date,並且要納入 campaign 的屬性,就必須確認 segments.date 位於廣告活動的 selectableWith 屬性中,因為系統會在選取現有 segments.date 欄位時一併選取 segments.date

中繼資料詳細資料

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

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

使用查詢取得欄位詳細資料

您可以將查詢傳送至

https://searchads360.googleapis.com/v0/searchAds360Fields:search

範例 1:使用規則運算式。

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE name LIKE 'ad_group.%'"

範例 2:查詢特定欄位、指標或區隔。

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"
  )