Method: customers.searchAds360.searchStream

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

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

HTTP リクエスト

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

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

パスパラメータ

パラメータ
customerId

string

必須。クエリ対象の顧客の ID。

リクエスト本文

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

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

string

必須。クエリ文字列。
batchSize

integer

各ストリーム レスポンス バッチで返される行数。リクエストされたバッチが大きすぎると、サーバーは返される行をさらに制限することを決定できます。
summaryRowSetting

enum (SummaryRowSetting)

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

レスポンスの本文

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

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

JSON 表現 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
フィールド
results[]

object (SearchAds360Row)

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

string (FieldMask format)

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

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

object (SearchAds360Row)

結果の指標の概要を含む概要行。指標の概要とは、すべての結果にわたる指標を集計することを意味します。集計とは、合計、平均、率などを指します。
customColumnHeaders[]

object (CustomColumnHeader)

結果のカスタム列のヘッダー。
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

結果に含まれるコンバージョン カスタム指標のヘッダー。
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

結果に表示されるコンバージョン カスタム ディメンションのヘッダー。
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

結果に含まれる未加工のイベント コンバージョン指標のヘッダー。
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

結果に表示される未処理のイベント コンバージョン ディメンションのヘッダー。
requestId

string

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

認可スコープ

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

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