您可以使用 GoogleAdsFieldService
,以動態方式為 GoogleAdsService
Search 和 SearchStream 方法中可用的資源、資源欄位、區隔鍵和指標要求目錄。此目錄提供了可供 Google Ads API 用戶端驗證及建構 Google Ads 查詢語言陳述式的中繼資料。
HTTP 要求和回應範例
要求包含以下網址的 Google Ads API 伺服器 HTTP GET
:
https://googleads.googleapis.com/v11/googleAdsFields/{resource_or_field}
以下是要求範例,後接從 ad_group 資源從 GoogleAdsFieldService
傳回的回應:
要求
https://googleads.googleapis.com/v11/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
是與現有的segments.date
欄位一併選取,就必須檢查segments.date
是否在廣告活動的selectableWith
屬性中。
中繼資料詳細資訊
您可以在下列層級使用 GoogleAdsFieldService
要求目錄:
- 資源
- 例如:
googleAdsFields/campaign
。 - 資源欄位
- 例如:
googleAdsFields/campaign.name
。 - 區隔欄位
- 例如:
googleAdsFields/segments.ad_network_type
。 - 指標
- 例如:
googleAdsFields/metrics.clicks
。