検索と SearchStream

動画: 報告

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

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

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

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

POST /v18/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 /v18/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 /v18/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'"
}
前へ
概要
次へ
Mutate