Method: customers.searchAds360.search

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customerId

string

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

リクエスト本文

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

JSON 表現 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
フィールド
query

string

必須。クエリ文字列。
pageToken

string

取得するページのトークン。指定しない場合、結果の最初のページが返されます。前のレスポンスの nextPageToken から取得した値を使用して、結果の次のページをリクエストします。
pageSize

integer

単一ページから取得する要素の数。ページが大きすぎる場合、サーバーは返されるリソースの数をさらに制限することがあります。
validateOnly

boolean

true の場合、リクエストは検証されますが実行されません。
returnTotalResultsCount

boolean

true の場合、LIMIT 句を無視してクエリに一致する結果の総数がレスポンスに含まれます。デフォルトは false です。
summaryRowSetting

enum (SummaryRowSetting)

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

レスポンスの本文

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

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

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

object (SearchAds360Row)

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

string

結果の次のページを取得するために使用されるページ設定トークン。この文字列の内容を、次のリクエストの pageToken 属性として渡します。最後のページについての nextPageToken は返されません。
totalResultsCount

string (int64 format)

LIMIT 句を無視して、クエリに一致する結果の総数。
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)

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

認可スコープ

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

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