Google Ads API には属性の取得と指標レポートのメカニズムが統合されており、Google 広告クエリ言語を使用してクエリを作成できます。これにより、個々の Google 広告アカウントに関する大量のデータを返す複雑なクエリが可能になります。
クエリは、Search メソッドまたは SearchStream メソッドのいずれかを使用して作成できます。どちらのメソッドも同じクエリをサポートし、同等の結果を返します。Search メソッドは、カスタマイズ可能なページサイズでデータを返すため、ページ分けを使用して結果セットを反復処理できます。これは、低帯域幅または信頼性の低いネットワーク状況で有用です。たとえば、大きな結果セットを小さなレスポンスに分割し、接続が失われた場合に再取得できるようにする場合などです。一方、SearchStream メソッドは、結果セット全体を 1 つのレスポンスでストリーミングして返すため、一括データ取得をより効率的に行うことができます。
Search と SearchStream は同じベース URL を使用します。
https://googleads.googleapis.com/v16/customers/CUSTOMER_ID/googleAds
ページベースの検索メソッドは、オプションの pageSize パラメータを受け取ります。このパラメータを使用すると、1 つの API レスポンスで返される結果の数を制限できます。
POST /v16/customers/CUSTOMER_ID/googleAds:search HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"pageSize": 10000,
"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'"
}
結果に pageSize より多くの行がある場合、レスポンスで nextPageToken が返されます。
{
"results": [
// ...
// ...
// ...
],
"nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B",
"fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status"
}
上記の値を指定して pageToken を追加して同じクエリを繰り返すと、結果の次のページが取得されます。
POST /v16/customers/CUSTOMER_ID/googleAds:search HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"pageSize": 10000,
"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"
}
すべての結果を単一のストリーミング レスポンスで返す SearchStream メソッドを使用するには、URL 内のサービス メソッドを searchStream に変更します（SearchStream では pageSize と pageToken は必要ありません）。
POST /v16/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'"
}