本指南包含直接呼叫 REST 端點的範例,而未使用用戶端程式庫。
必要條件
下方所有範例都必須使用 curl 指令,複製並貼上至 bash 殼層。
此外,您還需要開發人員權杖、測試帳戶存取權,以及包含至少一個客戶帳戶的 Google Ads 管理員帳戶。
環境變數
在下方輸入帳戶憑證和 ID,然後複製並貼到終端機,即可設定後續範例中使用的環境變數。 授權指南提供產生 OAuth 2.0 存取權杖的操作說明。
API_VERSION="16"
DEVELOPER_TOKEN="DEVELOPER_TOKEN"
OAUTH2_ACCESS_TOKEN="OAUTH_ACCESS_TOKEN"
MANAGER_CUSTOMER_ID="MANAGER_CUSTOMER_ID"
CUSTOMER_ID="CUSTOMER_ID"
其他選用物件 ID
以下部分範例適用於既有的預算或廣告活動。如有現有物件的 ID 與這些範例搭配使用,請在下方輸入。
BUDGET_ID=BUDGET_ID
CAMPAIGN_ID=CAMPAIGN_ID
否則,兩個「Mutates - Creates 範例」會建立新的預算和廣告活動。
搜尋
查詢教戰手冊指南包含許多報表範例,這些範例與部分預設 Google Ads 畫面對應,並可搭配本指南中使用的相同環境變數。我們的互動式查詢建構工具也是透過互動方式建構自訂查詢的實用資源。
分為多頁
search
方法會使用分頁,並隨 query
一併指定可調整的 pageSize
參數。
cURL
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/googleAds:search" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data '{ "pageSize": 10, "query": " SELECT campaign.name, campaign_budget.amount_micros, campaign.status, campaign.optimization_score, campaign.advertising_channel_type, metrics.clicks, metrics.impressions, metrics.ctr, metrics.average_cpc, metrics.cost_micros, campaign.bidding_strategy_type FROM campaign WHERE segments.date DURING LAST_7_DAYS AND campaign.status != 'REMOVED' " }'
GAQL
SELECT campaign.name, campaign_budget.amount_micros, campaign.status, campaign.optimization_score, campaign.advertising_channel_type, metrics.clicks, metrics.impressions, metrics.ctr, metrics.average_cpc, metrics.cost_micros, campaign.bidding_strategy_type FROM campaign WHERE segments.date DURING LAST_7_DAYS AND campaign.status != 'REMOVED'
直播
searchStream
方法會將所有結果串流成單一回應,因此不支援 pageSize
欄位。
cURL
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/googleAds:searchStream" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data '{ "query": " SELECT campaign.name, campaign_budget.amount_micros, campaign.status, campaign.optimization_score, campaign.advertising_channel_type, metrics.clicks, metrics.impressions, metrics.ctr, metrics.average_cpc, metrics.cost_micros, campaign.bidding_strategy_type FROM campaign WHERE segments.date DURING LAST_7_DAYS AND campaign.status != 'REMOVED' " }'
GAQL
SELECT campaign.name, campaign_budget.amount_micros, campaign.status, campaign.optimization_score, campaign.advertising_channel_type, metrics.clicks, metrics.impressions, metrics.ctr, metrics.average_cpc, metrics.cost_micros, campaign.bidding_strategy_type FROM campaign WHERE segments.date DURING LAST_7_DAYS AND campaign.status != 'REMOVED'
更改
系統會填入 operations
陣列,以透過單一 JSON 要求主體傳送多項變動作業 (create
、update
或 remove
)。
建立
這個範例會在一項要求中建立兩筆共用預算。
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaignBudgets:mutate" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'operations': [ { 'create': { 'name': 'My Campaign Budget #${RANDOM}', 'amountMicros': 500000, } }, { 'create': { 'name': 'My Campaign Budget #${RANDOM}', 'amountMicros': 500000, } } ] }"
下一個範例使用現有廣告活動預算的 BUDGET_ID
;您可以複製並貼上前一個步驟的輸出內容。
BUDGET_ID=BUDGET_ID
參照其他資源的資源則依「資源名稱」完成。下方建立的廣告活動參照其字串值資源名稱的 campaignBudget
。
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'operations': [ { 'create': { 'status': 'PAUSED', 'advertisingChannelType': 'SEARCH', 'geoTargetTypeSetting': { 'positiveGeoTargetType': 'PRESENCE_OR_INTEREST', 'negativeGeoTargetType': 'PRESENCE_OR_INTEREST' }, 'name': 'My Search campaign #${RANDOM}', 'campaignBudget': 'customers/${CUSTOMER_ID}/campaignBudgets/${BUDGET_ID}', 'targetSpend': {} } } ] }"
更新
使用 update
作業更新現有物件的屬性。下一個範例使用現有的廣告活動;您可以複製並貼上上一個步驟的輸出內容。
CAMPAIGN_ID=CAMPAIGN_ID
所有更新都需要 updateMask
欄位。這個欄位會列出要求中應套用的 JSON 屬性 (以半形逗號分隔),應以更新的形式套用。系統會清除物件在 updateMask
中列出的屬性,但要求主體中沒有的屬性。屬性未列出在 updateMask
中,但出現在要求主體中的屬性會遭到忽略。
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'operations': [ { 'update': { 'resourceName': 'customers/${CUSTOMER_ID}/campaigns/${CAMPAIGN_ID}', 'name': 'A changed campaign name #${RANDOM}', }, 'updateMask': 'name' } ], }"
移除
將物件指定為 remove
作業,即可移除物件。
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'operations': [ { 'remove': 'customers/${CUSTOMER_ID}/campaigns/${CAMPAIGN_ID}' } ], }"
部分失敗
如果單一要求中有多項作業,可視需要指定 partialFailure
。如果是 true
,則會執行成功的作業,且無效作業會傳回錯誤。如果設為 false
,則要求中的所有作業只有在全部有效時才都會成功。
下一個範例使用現有的廣告活動;您可以從「Creates」(建立) 範例輸出內容中複製並貼上。
CAMPAIGN_ID=CAMPAIGN_ID
以下要求包含兩項作業。前者會嘗試變更提供廣告活動的出價策略,而後者會嘗試移除包含無效 ID 的廣告活動。第二次作業會產生錯誤 (廣告活動 ID 無效),且由於 partialFailure
設為 false
,因此第一項作業也會失敗,因此現有廣告活動的出價策略不會更新。
curl --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'partialFailure': false, 'operations': [ { 'update': { 'resourceName': 'customers/${CUSTOMER_ID}/campaigns/${CAMPAIGN_ID}', 'manualCpc': { 'enhancedCpcEnabled': false } }, 'updateMask': 'manual_cpc.enhanced_cpc_enabled' }, { 'remove': 'customers/${CUSTOMER_ID}/campaigns/INVALID_CAMPAIGN_ID' } ] }"
分組作業
googleAds:mutate
方法支援傳送包含多種資源的作業群組。您可以傳送許多不同類型的作業,將一系列應以群組形式執行的一系列作業鏈結在一起。如果沒有任何作業失敗,這組作業就會成功;如有任何單一作業失敗,則所有作業都會失敗。
這個範例說明如何將廣告活動預算、廣告活動、廣告群組和廣告建立成一組動作。每個連續作業都取決於上一個作業。如果其中一個作業失敗,整個群組都會失敗。
負整數 (-1
、-2
、-3
) 會當做資源名稱中的預留位置使用,並在執行階段以作業序列的結果動態填入。
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/googleAds:mutate" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'mutateOperations': [ { 'campaignBudgetOperation': { 'create': { 'resourceName': 'customers/${CUSTOMER_ID}/campaignBudgets/-1', 'name': 'My Campaign Budget #${RANDOM}', 'deliveryMethod': 'STANDARD', 'amountMicros': 500000, 'explicitlyShared': false } } }, { 'campaignOperation': { 'create': { 'resourceName': 'customers/${CUSTOMER_ID}/campaigns/-2', 'status': 'PAUSED', 'advertisingChannelType': 'SEARCH', 'geoTargetTypeSetting': { 'positiveGeoTargetType': 'PRESENCE_OR_INTEREST', 'negativeGeoTargetType': 'PRESENCE_OR_INTEREST' }, 'name': 'My Search campaign #${RANDOM}', 'campaignBudget': 'customers/${CUSTOMER_ID}/campaignBudgets/-1', 'targetSpend': {} } } }, { 'adGroupOperation': { 'create': { 'resourceName': 'customers/${CUSTOMER_ID}/adGroups/-3', 'campaign': 'customers/${CUSTOMER_ID}/campaigns/-2', 'name': 'My ad group #${RANDOM}', 'status': 'PAUSED', 'type': 'SEARCH_STANDARD' } } }, { 'adGroupAdOperation': { 'create': { 'adGroup': 'customers/${CUSTOMER_ID}/adGroups/-3', 'status': 'PAUSED', 'ad': { 'responsiveSearchAd': { 'headlines': [ { 'pinned_field': 'HEADLINE_1', 'text': 'An example headline' }, { 'text': 'Another example headline' }, { 'text': 'Yet another headline' } ], 'descriptions': [ { 'text': 'An example description' }, { 'text': 'Another example description' } ], 'path1': 'all-inclusive', 'path2': 'deals' }, 'finalUrls': ['https://www.example.com'] } } } } ] }"
帳戶管理
建立帳戶
使用 createCustomerClient
方法建立新帳戶。請注意,網址需要管理員帳戶 ID,而不是客戶帳戶 ID。系統會在管理員帳戶底下建立新的客戶帳戶。
curl f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${MANAGER_CUSTOMER_ID}:createCustomerClient" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'customerClient': { 'descriptiveName': 'My Client #${RANDOM}', 'currencyCode': 'USD', 'timeZone': 'America/New_York' } }"
列出可存取的帳戶
對 listAccessibleCustomers
方法輸入簡單的 GET
要求,即可取得可用指定 OAuth 2.0 存取權杖存取的 Google Ads 帳戶清單。此要求中不應使用任何管理員帳戶或客戶帳戶 ID。
curl -f --request GET "https://googleads.googleapis.com/v${API_VERSION}/customers:listAccessibleCustomers" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
上傳二進位資產
assets:mutate
方法是用於上傳及管理資產。二進位資料 (例如圖片) 會編碼為字串,並搭配有邊框間距的標準 Base64 編碼。無論是否有邊框間距,都支援標準或網址安全 Base64 編碼。
這個範例會將 1 像素的 GIF 編碼,讓範例內容簡潔清楚。實際上,data
酬載會較大。
使用 base64
指令列公用程式 (GNU 核心公用程式的一部分) 編碼 1 像素的 GIF 圖片。
base64 1pixel.gif
Base64 編碼值在 API 要求中指定為 data
屬性。
curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/assets:mutate" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data "{ 'operations': [ { 'create': { 'name': 'My image asset #${RANDOM}', 'type': 'IMAGE', 'imageAsset': { 'data': 'R0lGODlhAQABAAAAACH5BAEAAAAALAAAAAABAAEAAAIA' } } } ] }"