Method: advertisers.negativeKeywordLists.negativeKeywords.list

除外キーワード リストの除外キーワードを一覧表示します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。親除外キーワード リストが属するディスプレイ＆ビデオ 360 広告主の ID。
negativeKeywordListId

string (int64 format)

必須。リクエストされた除外キーワードが属する親除外キーワード リストの ID。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1～1000 の値にしてください。指定しない場合、デフォルトの 100 が使用されます。無効な値が指定されている場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

サーバーが返す必要がある結果のページを特定するトークンです。

通常、これは negativeKeywords.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
orderBy

string

リストの並べ替え基準として使用するフィールド。有効な値は次のとおりです。

  • keywordValue（デフォルト）

デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名に接尾辞「desc」を追加する必要があります。例: keywordValue desc。
filter

string

除外キーワード フィールドでフィルタできます。

サポートされている構文:

  • 除外キーワードのフィルタ式に含めることができる制限は 1 つだけです。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで HAS (:) 演算子を使用する必要があります。

サポートされているフィールド:

  • keywordValue

例:

  • キーワードの値に「google」が含まれるすべての除外キーワード: keywordValue : "google"

このフィールドの長さは 500 文字以下にする必要があります。

詳しくは、LIST リクエストをフィルタするガイドをご覧ください。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

NegativeKeywordService.ListNegativeKeywords に対するレスポンス メッセージ。

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

JSON 表現 
{
  "negativeKeywords": [
    {
      object (NegativeKeyword)
    }
  ],
  "nextPageToken": string
}
フィールド
negativeKeywords[]

object (NegativeKeyword)

除外キーワードのリスト。

リストが空の場合は、このリストは表示されません。
nextPageToken

string

結果の次のページを取得するためのトークン。

結果の次のページを取得するには、この値を後続の negativeKeywords.list メソッド呼び出しの pageToken フィールドに渡します。

認可スコープ

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

  • https://www.googleapis.com/auth/display-video

詳しくは、OAuth 2.0 の概要をご覧ください。