您可以使用 SearchAds360FieldService
以動態方式要求目錄以取得資源、資源欄位、區隔索引鍵和指標,適用於 SearchAds360Service
Search
和 SearchStream
方法。目錄提供中繼資料,可供 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
子句中透過資源選取的指標。只有category
為RESOURCE
的欄位才會填入資料。 segments
- 區隔鍵可透過
FROM
子句中的資源選取。藉此區隔查詢中指定的指標。只有category
為RESOURCE
的欄位才會填入資料。 selectableWith
- 可在
FROM
子句中沒有的情況下,與指定欄位一起選取的欄位。只有在識別到可以在FROM
子句資源內沒有納入的資源或區段的情況下,您能夠選取這些資源或區段時,才需要使用這項屬性。舉例來說,如果要從ad_group
中選取ad_group.id
和segments.date
,並想納入campaign
的屬性,就必須檢查segments.date
是否位於廣告活動的selectableWith
屬性中,因為系統會和現有的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"
)