Method: exchanges.auctionPackages.patch

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

HTTP リクエスト

PATCH https://dv360seller.googleapis.com/v1beta1/{auctionPackage.name=exchanges/*/auctionPackages/*}

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

パスパラメータ

パラメータ
auctionPackage.name

string

ID。このオークション パッケージの相対ルート名。「exchanges/{seller_id}/auctionpackages/{auction_package_id}」の形式にする必要があります。例: 「exchanges/1234/auctionPackage/5678」。

リクエストの本文

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

JSON 表現
{
  "auctionPackage": {
    "name": string,
    "displayName": string,
    "status": enum (DiscoveryObjectStatus),
    "description": string,
    "format": enum (Format),
    "forecast": {
      "weeklyImpressions": string,
      "weeklyUniques": string,
      "breakdowns": [
        {
          object (TargetingDimensionBreakdown)
        }
      ],
      "appsBreakdown": [
        {
          object (MobileAppSlice)
        }
      ]
    },
    "externalDealId": string,
    "logoUrl": string,
    "floorPrice": {
      "currencyCode": string,
      "units": string,
      "nanos": integer
    },
    "startTime": string,
    "endTime": string,
    "mediumType": enum (MediumType),
    "urgOwners": [
      enum (UnderRepresentedGroup)
    ],
    "dv3MarketplaceUri": string
  },
  "updateMask": string
}
フィールド
auctionPackage.displayName

string

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

auctionPackage.status

enum (DiscoveryObjectStatus)

必須。このオークション パッケージのステータス。ステータスが PAUSED または REMOVED のパッケージは、ディスプレイ&ビデオ 360 の広告主に表示されません。

auctionPackage.description

string

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

auctionPackage.format

enum (Format)

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

auctionPackage.forecast

object (SellerProvidedInventoryAvailabilityEstimate)

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

auctionPackage.externalDealId

string

必須。変更不可。入札リクエストで使用されるエクスチェンジ取引 ID。最大 100 文字。使用できる文字は、英数字、アンダースコア、ダッシュ、ドットです。作成後の更新はできません。

auctionPackage.logoUrl

string

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

auctionPackage.floorPrice

object (Money)

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

auctionPackage.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"

auctionPackage.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"

auctionPackage.mediumType

enum (MediumType)

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

auctionPackage.urgOwners[]

enum (UnderRepresentedGroup)

省略可。オーナーが所属するマイノリティ グループ(該当する場合)。

updateMask

string (FieldMask format)

省略可。更新するフィールドを制御するマスク。

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

auctionPackage.dv3MarketplaceUri

string

出力専用。マーケットプレイスのオークション パッケージのディスプレイ&ビデオ 360 リンク。

レスポンスの本文

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

認可スコープ

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

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

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