Method: advertisers.manualTriggers.list

特定の広告主 ID で現在のユーザーがアクセスできる手動トリガーを一覧表示します。

順序は orderBy パラメータで定義されます。

advertiserId は 1 つだけ必要です。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/manualTriggers

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。取得した手動トリガーが属する広告主の ID。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1～100 の範囲で指定してください。指定しない場合のデフォルトは 100 です。
pageToken

string

サーバーが返す必要がある結果のページを特定するトークンです。 通常、これは前回の manualTriggers.list メソッドの呼び出しで返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
orderBy

string

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

  • displayName（デフォルト）
  • state

デフォルトの並べ替え順は昇順です。フィールドを降順で指定するには、フィールド名に「desc」という接尾辞を追加する必要があります。たとえば、displayName desc のようにします。
filter

string

手動トリガー プロパティでフィルタできます。

サポートされる構文:

  • フィルタ式は 1 つ以上の制限で構成されます。
  • 制限は AND または OR 論理演算子で組み合わせることができます。一連の制限では、暗黙的に AND が使用されます。
  • 制限の形式は {field} {operator} {value} です。
  • 演算子は EQUALS (=) にする必要があります。
  • サポートされているフィールド:
    • displayName
    • state 例:

  • 広告主のすべての有効な手動トリガー: state="ACTIVE"

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

リクエスト本文

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

レスポンスの本文

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

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

object (ManualTrigger)

手動トリガーのリスト。

空の場合、このリストは存在しません。
nextPageToken

string

結果の次のページを取得するためのトークン。 この値を、後続の manualTriggers.list メソッドの呼び出しで [pageToken][ListManualTriggersResponse.page_token] フィールドに渡して、結果の次のページを取得します。

認可スコープ

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

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

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