検索ストリーム クエリに一致するすべての行を返します。
スローされるエラーのリスト: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
HTTP リクエスト
POST https://googleads.googleapis.com/v15/customers/{customerId}/googleAds:searchStream
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
customerId |
必須。クエリ対象の顧客の ID。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"query": string,
"summaryRowSetting": enum ( |
フィールド | |
---|---|
query |
必須。クエリ文字列。 |
summaryRowSetting |
概要行を返すかどうかを決定します。デフォルトでは、概要行は返されません。リクエストされた場合、他のすべてのクエリ結果が返された後、概要行が単独でレスポンスで送信されます。 |
レスポンスの本文
GoogleAdsService.SearchStream
に対するレスポンス メッセージです。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "results": [ { object ( |
フィールド | |
---|---|
results[] |
クエリに一致した行のリスト。 |
fieldMask |
ユーザーがリクエストしたフィールドを表す FieldMask。 これは、フィールドの完全修飾名のカンマ区切りリストです。(例: |
summaryRow |
結果の指標の概要を含む概要行。指標の概要とは、すべての結果についての指標の集計を意味します。集計とは、合計、平均、レートなどを指します。 |
requestId |
デバッグ目的で使用されるリクエストの一意の ID。 |
queryResourceConsumption |
クエリの実行に消費されたリソースの量。概要行の queryResourceConsumption と、Summary 以外のレスポンスは、それぞれの行で別々に返されます。Summary 以外のレスポンスの queryResourceConsumption は、結果の最終バッチで返されます。 |
承認スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/adwords
詳細については、OAuth 2.0 の概要をご覧ください。