Method: advertisers.manualTriggers.list

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

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

advertiserId が 1 つ必要です。

警告: 手動トリガーを使用している広告申込情報は、ディスプレイとディスプレイで配信されなくなりました。動画 360。この手法は 2023 年 8 月 1 日に廃止されます。詳しくは、機能サポート終了のお知らせをご覧ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

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

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1200 の値にしてください。指定しない場合のデフォルトは 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

例:

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

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

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

リクエスト本文

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

レスポンスの本文

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

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 の概要をご覧ください。