Method: customers.googleAds.searchStream

検索ストリーム クエリに一致するすべての行を返します。

スローされるエラーのリスト: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

HTTP リクエスト

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

必須。クエリ対象のお客様の ID。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
フィールド
query

string

必須。クエリ文字列。
summaryRowSetting

enum (SummaryRowSetting)

サマリー行を返すかどうかを決定します。デフォルトでは、概要行は返されません。リクエストに応じて、他のすべてのクエリ結果が返された後に、概要行がレスポンスで単独で送信されます。

レスポンスの本文

GoogleAdsService.SearchStream に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
フィールド
results[]

object (GoogleAdsRow)

クエリに一致した行のリスト。
fieldMask

string (FieldMask format)

ユーザーがリクエストしたフィールドを表す FieldMask。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。
summaryRow

object (GoogleAdsRow)

結果の指標の概要を含む概要行。指標の概要とは、すべての結果の指標を集計したものです。集計には、合計、平均、率などがあります。
requestId

string

デバッグ目的で使用されるリクエストの一意の ID。
queryResourceConsumption

string (int64 format)

クエリの処理に使用されたリソースの量。[Summary] 行の queryResourceConsumption と [Summary] 以外のレスポンスの queryResourceConsumption は、それぞれ個別の行で返されます。[Summary] 以外のレスポンスの queryResourceConsumption は、結果の最終バッチで返されます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/adwords

詳細については、OAuth 2.0 Overview をご覧ください。

SummaryRowSetting

返品概要行の設定を記述する列挙型。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 返品概要行の不明な値を表します。
NO_SUMMARY_ROW 集計行を返さない。
SUMMARY_ROW_WITH_RESULTS 結果とともに概要行を返します。概要行は最後のバッチでのみ返されます（最後のバッチには結果は含まれません）。
SUMMARY_ROW_ONLY 概要行のみを返して、結果は返さない。