REST Resource: sellers.products

资源:Product

单个商品。

JSON 表示法
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "creativeSpecifications": [
    {
      object (CreativeSpecification)
    }
  ],
  "bookingLeadDuration": string,
  "assignmentLeadDuration": string,
  "minFlightDuration": string,
  "maxFlightDuration": string,
  "slotDuration": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "currencyCode": string
}
字段
name

string

商品的资源名称,格式为:sellers/{seller}/products/{product}。例如 sellers/seller111/products/product123

externalId

string

用于将此实体映射到外部来源的 ID。

displayName

string

必需。商品的显示名称。

必须采用 UTF-8 编码,大小不超过 240 个字节。

description

string

用于描述商品的附加自由格式字段。

labels

map (key: string, value: string)

用于描述此商品的自由格式标签集。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

creativeSpecifications[]

object (CreativeSpecification)

必需。允许为此产品投放的广告素材的列表。

bookingLeadDuration

string (Duration format)

必需。必须提供潜在客户有效期才能预订产品。现在 + bookingLeadDuration 应晚于排期开始。

该持续时间以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

assignmentLeadDuration

string (Duration format)

必需。必须填写潜在客户有效期,才能分配广告素材。

该持续时间以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

minFlightDuration

string (Duration format)

此产品的最短飞行时长。

该持续时间以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

maxFlightDuration

string (Duration format)

必需。此产品的飞行时长上限。

该持续时间以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

slotDuration

string (Duration format)

必需。此产品的空档时长。

该持续时间以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

createTime

string (Timestamp format)

仅限输出。商品的创建时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。商品的上次更新时间时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

state

enum (State)

仅限输出。此商品的状态。

currencyCode

string

必需。ISO 4217 中定义的由 3 个字母组成的大写货币代码。

产品状态的可能值。

枚举
STATE_UNSPECIFIED 在此版本中未指定或未知的产品状态时的默认值。
STATE_ACTIVE 产品有效。
STATE_DELETED 产品已删除。

方法

create

创建新产品。

delete

删除现有商品。

get

检索单个商品。

list

列出商品。

patch

更新现有商品。