検索と SearchStream

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

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

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

    https://searchAds360.googleapis.com/v0/customers/CUSTOMER_ID/searchAds360

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

POST /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1
Host: searchAds360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_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 /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_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 に変更します(pageSizepageTokenSearchStream では必要ありません)。

POST /v0/customers/CUSTOMER_ID/searchAds360:searchStream HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_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'"
}