Method: exchanges.auctionPackages.patch

更新竞价包。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
auctionPackage.name

string

标识符。此竞价包的相对路由名称。应采用以下格式:“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 的资源包不会向 DV3 广告客户显示。

auctionPackage.description

string

必需。此资源包的说明文本。必须采用 UTF-8 编码,且大小上限为 2000 个字符。

auctionPackage.format

enum (Format)

必需。不可变。底层广告格式类型。创建后不允许更新。

auctionPackage.forecast

object (SellerProvidedInventoryAvailabilityEstimate)

可选。此竞价包广告资源的预测细分。DV3 广告客户可以查看这些细分并根据这些细分进行过滤。

auctionPackage.externalDealId

string

必需。不可变。出价请求中使用的广告交易平台交易 ID。最多 100 个字符。允许的字符包括字母数字字符、下划线、短划线和英文句点。创建后不允许更新。

auctionPackage.logoUrl

string

仅限输出。此竞价包徽标的网址。

auctionPackage.floorPrice

object (Money)

必需。此竞价包的底价。

auctionPackage.startTime

string (Timestamp format)

必需。此产品生效的时间。必须早于 endTime。开始时间不能超过未来 1 年。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 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 规范化(即转换为 UTC 零时区格式并在末尾附加 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

仅限输出。广告交易平台中竞价包的 Dv360 链接。

响应正文

如果成功,则响应正文包含一个 AuctionPackage 实例。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 OAuth 2.0 Overview。