Method: customers.googleAds.search

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

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

HTTP リクエスト

POST https://googleads.googleapis.com/v15/customers/{customerId}/googleAds: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

1 ページ内で取得する要素の数。大きすぎるページがリクエストされた場合、サーバーは返されるリソースの数をさらに制限することを決定することがあります。
validateOnly

boolean

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

boolean

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

enum (SummaryRowSetting)

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

レスポンスの本文

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

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (GoogleAdsRow)

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

string

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

string (int64 format)

LIMIT 句を無視したクエリに一致する結果の合計数。
fieldMask

string (FieldMask format)

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

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

object (GoogleAdsRow)

結果の指標の概要を含む概要行。指標の概要とは、すべての結果の指標を集計することを意味します。集計とは、合計、平均、レートなどの集計です。
queryResourceConsumption

string (int64 format)

クエリを処理するために消費されたリソースの量。

認可スコープ

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

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

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