您可以使用 GoogleAdsFieldService
動態要求資源目錄、資源欄位、區隔鍵和 GoogleAdsService
Search 和 SearchStream 方法提供的指標。目錄提供中繼資料,Google Ads API 用戶端可用於驗證及建構 Google Ads 查詢語言陳述式。
範例 HTTP 要求和回應
這項要求包含以下網址中 Google Ads API 伺服器的 HTTP GET
:
https://googleads.googleapis.com/v19/googleAdsFields/{resource_or_field}
以下是要求範例,後面是 GoogleAdsFieldService
針對 ad_group 資源傳回的回應:
要求
https://googleads.googleapis.com/v19/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
和現有的segments.date
欄位。
中繼資料詳細資料
您可以使用 GoogleAdsFieldService
在下列層級要求目錄:
- 資源
- 例如:
googleAdsFields/campaign
。 - 資源欄位
- 例如:
googleAdsFields/campaign.name
。 - 區隔欄位
- 例如:
googleAdsFields/segments.ad_network_type
。 - 指標
- 例如:
googleAdsFields/metrics.clicks
。