Google Ads API には、Google 広告クエリ言語を使用してクエリを作成できる、属性取得と指標レポートの メカニズム があります。これにより、個々の Google 広告アカウントに関する大量のデータを返す複雑なクエリが可能になります。
クエリは、Search メソッドまたは SearchStream メソッドのいずれかを使用して作成できます。
どちらのメソッドも同じクエリをサポートし、同等の結果を返します。Search メソッドは、10,000 行の固定サイズのページでデータを返すため、ページ分割を使用して結果セットを反復処理できます。たとえば、帯域幅が狭い場合やネットワーク接続が不安定な場合に、大きな結果セットを小さなレスポンスに分割して、接続が切断された場合に再取得できるため、この方法が有利になることがあります。一方、SearchStream メソッドは、結果セット全体を 1 つのレスポンスでストリーミングするため、大量のデータを取得する場合に効率的です。
Search と SearchStream はどちらも同じベース URL を使用します。
https://googleads.googleapis.com/v25/customers/CUSTOMER_ID/googleAds
POST /v25/customers/CUSTOMER_ID/googleAds:search HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'" }
結果が 10,000 行を超える場合は、レスポンスに nextPageToken が返されます。
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
前のリクエストの値で pageToken を追加して同じクエリを繰り返すと、次のページの結果が取得されます。
POST /v25/customers/CUSTOMER_ID/googleAds:search HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'", "pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B" }
1 つのストリーミング レスポンスですべての結果を返す SearchStream メソッドを使用するには、URL のサービス メソッドを searchStream に変更します（SearchStream では pageToken は不要です）。
POST /v25/customers/CUSTOMER_ID/googleAds:searchStream HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'" }