Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

検索(&Stream)

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

動画: レポート

Google Ads API には、統合型の属性取得と指標の報告メカニズムが用意されており、Google 広告クエリ言語を使用してクエリを作成できます。これにより、個々の Google 広告アカウントについて大量のデータを返すことができる複雑なクエリが可能になります。

クエリは、Search または SearchStream メソッドを使用して作成できます。どちらのメソッドも同じクエリをサポートし、同等の結果を返します。Search メソッドは、カスタマイズ可能なページサイズでデータを返すため、ページ分けを使用して結果セットに対して反復処理を行うことができます。これは、たとえば、大規模な結果セットを小さなレスポンスに分割し、接続が失われた場合に再取得できるようにすることで、低帯域幅や信頼性の低いネットワークにおいて有利になることがあります。一方、SearchStream メソッドでは、結果セット全体が 1 つのレスポンスでストリーミングされるので、データの一括取得で効率的です。

SearchSearchStream はどちらも同じベース URL を使用します。

    https://googleads.googleapis.com/v11/customers/CUSTOMER_ID/googleAds

ページベースの検索メソッドは、オプションの pageSize パラメータを受け取ります。このパラメータは、1 つの API レスポンスで返される結果の数を制限します。

POST /v11/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 /v11/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"
}

すべての結果を 1 つのストリームのレスポンスで返す SearchStream メソッドを使用するには、URL 内のサービス メソッドを searchStream に変更します(SearchStream では pageSizepageToken は必要ありません)。

POST /v11/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'"
}