REST Resource: exchanges.orders

リソース: Order

購入者が承認する交渉不可のオファー。

JSON 表現
{
  "name": string,
  "displayName": string,
  "partnerId": [
    string
  ],
  "publisherEmail": string,
  "publisherName": string,
  "budget": {
    object (Budget)
  },
  "status": enum (OrderStatus),
  "wseatConfig": {
    object (WSeatConfig)
  },
  "updateTime": string,
  "buyerInfo": {
    object (BuyerInfo)
  }
}
フィールド
name

string

注文の相対リソース名。サーバーによって生成されます。例: 「exchanges/1234/orders/5678」。出力のみ。

displayName

string

購入者に表示される注文の名前。最大 250 文字。省略可。

partnerId[]

string (int64 format)

Google ディスプレイ&ビデオ 360 のパートナー ID(旧 Doubleclick Bid Manager(DBM))。パートナー ID は 1 つのみ許可されます。必須。

publisherEmail

string

パブリッシャー向けのメール。有効な形式のメールアドレスを入力してください。最大 250 文字。省略可。

publisherName

string

パブリッシャー名。最大 250 文字。必須。

budget

object (Budget)

出力専用。購入者が設定した予算。インスタント ディール シナリオにのみ適用されます。

status

enum (OrderStatus)

注文のステータス。ステータスは、DV3 ユーザーが注文を承認、キャンセル、アーカイブした後に変更されることがあります。また、API で作成後に「CANCELLED」に更新して、この注文が Exchange でキャンセルされたことを通知することもサポートします。

wseatConfig

object (WSeatConfig)

省略可。WSeat 構成: エクスチェンジ側の WSeat 構成を指定します。マルチシート ディールを利用する取引所は、このフィールドを最新の状態に保つことが求められます。

updateTime

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"

buyerInfo

object (BuyerInfo)

出力専用。購入者の情報(パートナーや広告主の詳細など)。インスタント ディール シナリオにのみ適用されます。

予算

予算が指定されています。

JSON 表現
{
  "budgetType": enum (BudgetType),

  // Union field budget can be only one of the following:
  "impressions": string,
  "money": {
    object (Money)
  }
  // End of list of possible types for union field budget.
}
フィールド
budgetType

enum (BudgetType)

指定された予算タイプ。

共用体フィールド budget。含めることができる予算のタイプは 1 つのみです。budget は次のいずれかになります。
impressions

string (int64 format)

インプレッション予算。

money

object (Money)

通貨予算。

BudgetType

予算タイプ

列挙型
BUDGET_TYPE_UNSPECIFIED 予算が指定されていません。入力には使用できません。
BUDGET_TYPE_CURRENCY 通貨予算。
BUDGET_TYPE_IMPRESSION インプレッション予算。

OrderStatus

注文のステータス。

列挙型
ORDER_STATUS_UNSPECIFIED 注文ステータスが指定されていません。予期しない状態です。ネゴシエーションのステータスが不明であることを示します。有効な入力値ではありません。
PENDING_ACCEPTANCE 注文のステータスが承認待ちです。
ACCEPTED 注文ステータスが承認されました。
ARCHIVED 注文ステータスがアーカイブされました。
CANCELLED 注文ステータスがキャンセルされました。
NEGOTIATING 注文ステータスの交渉。インスタント取引シナリオにのみ適用されます。

WSeatConfig

WSeat 構成。

JSON 表現
{
  "exchangeWseatStatus": enum (WSeatStatus),
  "exchangeWseatIds": [
    string
  ],
  "updateTime": string
}
フィールド
exchangeWseatStatus

enum (WSeatStatus)

省略可。WSeat 構成の Exchange 側の現在のステータス。

exchangeWseatIds[]

string (int64 format)

省略可。Exchange 側の WSeat ID。

updateTime

string (Timestamp format)

出力専用。このフィールドは、エクスチェンジによって WSeatConfiguration が更新されると、DV3 によって自動的に更新されます。

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"

WSeatStatus

WSeat Status 列挙型のオプション。

列挙型
W_SEAT_STATUS_UNSPECIFIED WSeatStatus が指定されていません。
W_SEAT_STATUS_ENFORCED WSeatStatus が適用されます。Exchange が WSeatId を DV3 に送信するか、入札レスポンスで wseatids を検証することで WSeatId を適用するかどうかを示します。
W_SEAT_STATUS_NOT_ENFORCED WSeatStatus が適用されていません。Exchange が入札リクエストで wseatid を送信せず、入札リクエストで wseatid を検証しないことを示します。

BuyerInfo

インスタント取引のシナリオにおける購入者の情報。

JSON 表現
{
  "partner": {
    object (PartnerInfo)
  },
  "advertisers": [
    {
      object (AdvertiserInfo)
    }
  ]
}
フィールド
partner

object (PartnerInfo)

出力専用。パートナー情報。

advertisers[]

object (AdvertiserInfo)

出力専用。広告主の情報。

PartnerInfo

インスタント ディール シナリオのパートナー情報。

JSON 表現
{
  "title": string
}
フィールド
title

string

出力専用。ディスプレイ&ビデオ 360 のパートナーの表示タイトル。

AdvertiserInfo

インスタント取引のシナリオの広告主情報。

JSON 表現
{
  "advertiserId": string,
  "domainUri": string
}
フィールド
advertiserId

string (int64 format)

出力専用。ディスプレイ&ビデオ 360 の広告主 ID。

domainUri

string

出力専用。広告主のウェブサイトのドメイン URI。

メソッド

accept

注文を受け付けます。

create

注文を作成します。

get

注文を取得します。

list

注文を一覧表示します。

patch

注文を更新します。