検索クエリに一致するすべての行を返します。
スローされるエラーのリスト: 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 |
必須。クエリ対象の顧客の ID。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"query": string,
"pageToken": string,
"pageSize": integer,
"validateOnly": boolean,
"returnTotalResultsCount": boolean,
"summaryRowSetting": enum ( |
フィールド | |
---|---|
query |
必須。クエリ文字列。 |
pageToken |
取得するページのトークン。指定しない場合、結果の最初のページが返されます。結果の次のページをリクエストするには、前のレスポンスで |
pageSize |
単一ページから取得する要素の数。リクエストされたページが大きすぎると、サーバーは返されるリソースの数をさらに制限することがあります。 |
validateOnly |
true の場合、リクエストは検証されますが、実行されません。 |
returnTotalResultsCount |
true の場合、LIMIT 句を無視してクエリに一致する結果の総数がレスポンスに含まれます。デフォルトは false です。 |
summaryRowSetting |
集計行を返すかどうかを決定します。デフォルトでは、概要行は返されません。リクエストした場合、他のすべてのクエリ結果が返された後、サマリー行がレスポンスでそのまま送信されます。 |
レスポンスの本文
GoogleAdsService.Search
に対するレスポンス メッセージです。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{ "results": [ { object ( |
フィールド | |
---|---|
results[] |
クエリに一致した行のリスト。 |
nextPageToken |
結果の次のページを取得するために使用されるページネーション トークン。この文字列の内容を次のリクエストの |
totalResultsCount |
LIMIT 句を無視してクエリに一致する結果の合計数。 |
fieldMask |
ユーザーがリクエストしたフィールドを表す FieldMask。 完全修飾フィールド名のカンマ区切りリスト。例: |
summaryRow |
結果の指標の概要を含む概要行。指標のサマリーとは、すべての結果にわたる指標を集計することを意味します。集計とは、合計、平均、率などを指します。 |
queryResourceConsumption |
クエリを処理するために消費されるリソースの量。 |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/adwords
詳しくは、OAuth 2.0 の概要をご覧ください。