Method: exchanges.orders.patch

注文を更新します。

HTTP リクエスト

PATCH https://dv360seller.googleapis.com/v1beta1/{order.name=exchanges/*/orders/*}

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

パスパラメータ

パラメータ
order.name

string

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "order": {
    "name": string,
    "displayName": string,
    "partnerId": [
      string
    ],
    "publisherEmail": string,
    "publisherName": string,
    "budget": {
      "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.
    },
    "status": enum (OrderStatus),
    "wseatConfig": {
      "exchangeWseatStatus": enum (WSeatStatus),
      "exchangeWseatIds": [
        string
      ],
      "updateTime": string
    },
    "updateTime": string,
    "buyerInfo": {
      "partner": {
        object (PartnerInfo)
      },
      "advertisers": [
        {
          object (AdvertiserInfo)
        }
      ]
    }
  },
  "updateMask": string
}
フィールド
order.displayName

string

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

string (int64 format)

Google ディスプレイ＆ビデオ 360 のパートナー ID（旧 Doubleclick Bid Manager（DBM））。パートナー ID は 1 つのみ許可されます。必須。
order.publisherEmail

string

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

string

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

object (Budget)

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

enum (OrderStatus)

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

object (WSeatConfig)

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

object (BuyerInfo)

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

string (FieldMask format)

更新するフィールドを制御するマスク。必須。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

レスポンスの本文

成功した場合、レスポンスの本文には Order のインスタンスが含まれます。

認可スコープ

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

  • https://www.googleapis.com/auth/doubleclickbidmanager

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