您可以使用 GoogleAdsFieldService (透過 GetGoogleAdsField 或 SearchGoogleAdsFields),動態要求 GoogleAdsService Search 和 SearchStream 方法中可用的資源、資源欄位、區隔鍵和指標目錄。目錄提供的中繼資料,可供 Google Ads API 用戶端用於驗證及建構 Google Ads 查詢語言陳述式。
HTTP 要求和回應範例
要求包含傳送至 Google Ads API 伺服器的 HTTP GET,網址如下:
https://googleads.googleapis.com/v26/googleAdsFields/{resource_or_field}
以下範例顯示一項要求,以及 GoogleAdsFieldService 針對 ad_group 資源傳回的回應:
要求
https://googleads.googleapis.com/v26/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子句中資源的資源,不需區隔指標。只有在category為RESOURCE時,才會填入欄位。 metrics- 可與
FROM子句中的資源一併選取的指標。只有在category為RESOURCE的欄位中,才會填入資料。 segments- 區隔鍵 (
segments.*欄位和區隔資源),可與FROM子句中的資源一起選取。這些維度會區隔查詢中指定的指標。只有在category為RESOURCE時,才會填入欄位。 selectableWith- 當這項資源或區隔不是
FROM子句中的主要資源時,可在同一個 Google Ads 查詢語言查詢中選取的資源、區隔或指標。
使用 selectableWith 查詢相容性
資源或區隔欄位上的 selectableWith 屬性,會指定可在同一個 Google Ads 查詢語言查詢中選取的其他資源、區隔或指標。如要納入未在 FROM 子句中指定的資源或區隔欄位,這個屬性就非常重要。
建構 Google Ads 查詢語言查詢時:
FROM子句中的資源是主要實體。您隨時可以從這項資源中選取欄位。- 您也可以選取與主要實體相容的指標和區隔。
- 如果您加入
FROM子句以外的任何資源或區隔欄位,請務必確保這個非FROM資源或區隔與查詢中選取的所有其他欄位、區隔和指標相容。
特定資源 (資源 A) 的 selectableWith 清單包含所有其他資源、區隔和指標,當資源 A 不是主要實體時,這些資源、區隔和指標可與資源 A 的欄位一併選取。
範例
請參考以下查詢範例:
SELECT ad_group.id, segments.date, campaign.name FROM ad_group
FROM子句指定ad_group。- 這項查詢會選取
ad_group.id(來自FROM資源)、segments.date和campaign.name。 - 由於您選取了
campaign.name,但campaign不在FROM子句中,因此必須驗證其與其他所選元素的相容性。 - 為確保這項查詢有效,
campaign資源必須與segments.date(另一個選取的欄位) 相容。因此,您必須檢查campaign資源的selectableWith屬性。如果campaign的selectableWith清單中包含segments.date,則查詢有效。
如果您從 FROM 子句中未包含的資源選取欄位,該資源的 selectableWith 清單必須包含 SELECT 子句中的所有其他區隔和資源。
中繼資料詳情
您可以使用 GoogleAdsFieldService (透過 GetGoogleAdsField 的資源名稱或使用 SearchGoogleAdsFields 查詢),在下列 GoogleAdsFieldCategory 層級要求目錄:
- 資源 (
RESOURCE) - 例如:
googleAdsFields/campaign。 - 資源屬性 (
ATTRIBUTE) - 例如:
googleAdsFields/campaign.name。 - 區隔欄位 (
SEGMENT) - 例如:
googleAdsFields/segments.ad_network_type。 - 指標 (
METRIC) - 例如:
googleAdsFields/metrics.clicks。