REST Resource: exchanges.auctionPackages

リソース: AuctionPackage

単一のオークション パッケージをカプセル化します。ディスプレイ&ビデオ 360 の広告主様は、マーケットプレイス ディスカバリー UI からディスプレイ&ビデオ 360 のすべてのオークション パッケージを閲覧し、販売者の操作なしでこれらのパッケージの使用をオプトインできます。

JSON 表現
{
  "name": string,
  "displayName": string,
  "status": enum (DiscoveryObjectStatus),
  "description": string,
  "format": enum (Format),
  "forecast": {
    object (SellerProvidedInventoryAvailabilityEstimate)
  },
  "externalDealId": string,
  "logoUrl": string,
  "floorPrice": {
    object (Money)
  },
  "startTime": string,
  "endTime": string,
  "mediumType": enum (MediumType),
  "urgOwners": [
    enum (UnderRepresentedGroup)
  ],
  "dv3MarketplaceUri": string
}
フィールド
name

string

このオークション パッケージの相対ルート名。形式は「exchanges/{seller_id}/auctionpackages/{auction_package_id}」です。例: 「exchanges/1234/auctionPackage/5678」出力専用。

displayName

string

このオークション パッケージの表示名。UTF-8 でエンコードし、最大サイズは 240 文字にする必要があります。必須。

status

enum (DiscoveryObjectStatus)

このオークション パッケージのステータス。ステータスが [一時停止中] または [削除済み] のパッケージは、ディスプレイ&ビデオ 360 の広告主には表示されません。必須。

description

string

このパッケージの説明テキスト。UTF-8 でエンコードし、最大サイズは 2,000 文字にする必要があります。必須。

format

enum (Format)

基盤となる広告フォーマットのタイプ。必須。作成後に更新することはできません。

forecast

object (SellerProvidedInventoryAvailabilityEstimate)

このオークション パッケージの広告枠の予測の内訳。DV3 の広告主様は、これらの内訳を表示してフィルタできます。省略可。

externalDealId

string

入札リクエストで使用されるエクスチェンジ取引 ID。最大半角 100 文字。使用できる文字は、英数字、アンダースコア、ダッシュ、ドットです。必須。必須。作成後に更新を許可しない。

logoUrl

string

出力専用。このオークション パッケージのロゴの URL。

出力専用。

floorPrice

object (Money)

このオークション パッケージの最小価格。必須。

startTime

string (Timestamp format)

この商品が有効になる日時。endTime より前の日時を指定してください。開始時間は 1 年以上先の日時を指定することはできません。必須。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

この商品が非アクティブになる日時。必須。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

mediumType

enum (MediumType)

必須。オークション パッケージのメディアタイプ。

urgOwners[]

enum (UnderRepresentedGroup)

省略可。オーナーがメンバーとなっている、代表性の低いグループ(存在する場合)。

dv3MarketplaceUri

string

出力専用。マーケットプレイスのオークション パッケージの Dv360 リンク。

形式

オークション パッケージの広告フォーマット。

列挙型
DEAL_FORMAT_UNSPECIFIED 取引フォーマットが指定されていません。入力には使用できません。
DEAL_FORMAT_DISPLAY 表示フォーマット。
DEAL_FORMAT_VIDEO 動画形式。
DEAL_FORMAT_AUDIO オーディオ形式。

メソッド

create

新しいオークション パッケージを作成します。

get

オークション パッケージを取得します。

list

オークション パッケージを一覧表示します。

patch

オークション パッケージを更新します。
指定したパッケージのロゴをアップロードします。