このガイドでは、クライアント ライブラリを使用せずに REST エンドポイントを直接呼び出す例を示します。
前提条件
以下のすべてのサンプルは、curl コマンドを使用してコピーして bash シェルに貼り付けられるものです。
また、開発者トークン、テスト アカウント アクセス、少なくとも 1 つのクライアント アカウントを含む Google 広告 MCC アカウントも必要です。
環境変数
以下にアカウントの認証情報と 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
それ以外の場合は、2 つの Mutates - Creates の例で、新しい予算とキャンペーンを作成します。
検索
クエリ クックブック ガイドには、Google 広告のデフォルトの画面の一部に対応し、このガイドで使用されているものと同じ環境変数を操作するレポート サンプルが多数含まれています。Google のインタラクティブ クエリビルダー ツールも、カスタムクエリをインタラクティブに作成するための優れたリソースです。
ページ分けあり
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
メソッドは、すべての結果を 1 つのレスポンスでストリーミングするため、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
配列に値を入力することで、1 つの JSON リクエスト本文で複数の変更オペレーション(create
、update
、remove
)を送信できます。
作成
この例では、1 つのリクエストで 2 つの共有キャンペーン予算を作成します。
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}' } ], }"
部分的障害
複数のオペレーションが 1 つのリクエストに含まれる場合は、必要に応じて partialFailure
を指定します。true
の場合、成功したオペレーションが実行され、無効なオペレーションはエラーを返します。false
の場合、リクエスト内のすべてのオペレーションは、すべて有効である場合にのみ成功します。
次の例では、既存のキャンペーンを使用します。Creates サンプルの出力からコピーして貼り付けることができます。
CAMPAIGN_ID=CAMPAIGN_ID
次のリクエストには 2 つのオペレーションが含まれています。1 回目は指定されたキャンペーンの入札戦略の変更を試み、2 回目は無効な ID を持つキャンペーンの削除を試みます。2 番目のオペレーションはエラーとなり(キャンペーン 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 つのグループとして実行すべき一連のオペレーションを連結できます。一連のオペレーションは、どのオペレーションも失敗しなければ成功し、いずれかのオペレーションが失敗してもすべてが失敗します。
この例では、キャンペーンの予算、キャンペーン、広告グループ、広告をまとめて 1 つのアクション セットとして作成しています。連続する各オペレーションは前のオペレーションに依存します。1 つでも失敗すると、オペレーション グループ全体が失敗します。
負の整数(-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
メソッドを使用して新しいアカウントを作成します。この URL には、クライアント アカウント ID ではなく MCC アカウント ID が必要です。MCC アカウントに新しいクライアント アカウントが作成されます。
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 広告アカウントのリストを取得します。このリクエストでは、MCC アカウント ID またはクライアント アカウント 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 エンコードを使用して文字列としてエンコードされます。パディングありの、またはパディングなしで、標準または URL セーフの 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' } } } ] }"