您可以使用 GoogleAdsFieldService
以動態方式要求目錄以取得資源、資源欄位、區隔索引鍵和 GoogleAdsService
Search 和 SearchStream 方法中可用的指標。目錄提供了中繼資料,可供 Google Ads API 用戶端用於驗證及建構 Google Ads 查詢語言陳述式。
HTTP 要求和回應範例
這項要求會將 HTTP GET
傳送至下列網址的 Google Ads API 伺服器:
https://googleads.googleapis.com/v16/googleAdsFields/{resource_or_field}
以下是要求範例,後面接著 GoogleAdsFieldService
針對 ad_group 資源傳回的回應:
要求
https://googleads.googleapis.com/v16/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
子句中透過資源選取的指標。只有category
為RESOURCE
的欄位才會填入資料。 segments
- 區隔鍵可透過
FROM
子句中的資源選取。藉此區隔查詢中指定的指標。只有category
為RESOURCE
的欄位才會填入資料。 selectableWith
-
- 可在
FROM
子句中沒有的情況下,與指定欄位一起選取的欄位。只有在識別到可以在FROM
子句資源內沒有納入的資源或區段的情況下,您能夠選取這些資源或區段時,才需要使用這項屬性。舉例來說,如要從ad_group
選取ad_group.id
和segments.date
,並想納入campaign
的屬性,就必須檢查segments.date
是否位於廣告活動的selectableWith
屬性中,因為這是在現有的segments.date
欄位旁選取。
中繼資料詳細資料
您可以在下列層級使用 GoogleAdsFieldService
要求目錄:
- 資源
- 例如:
googleAdsFields/campaign
。 - 資源欄位
- 例如:
googleAdsFields/campaign.name
。 - 區隔欄位
- 例如:
googleAdsFields/segments.ad_network_type
。 - 指標
- 例如:
googleAdsFields/metrics.clicks
。