REST Resource: exchanges.orders.products

• 资源：Product
  • JSON 表示法
• CreativeConfig
  • JSON 表示法
• CreativeType
• DimensionCreativeConfig
  • JSON 表示法
• DurationCreativeConfig
  • JSON 表示法
• DurationMatchType
• SkippableMatchType
• MakegoodDetails
  • JSON 表示法
• CreativeSource
• AudienceTargetingConfig
  • JSON 表示法
• AudienceType
• TargetingCriteria
  • JSON 表示法
• SelectedTargetingOption
  • JSON 表示法
• TargetingType
• AudienceSelection
  • JSON 表示法
• OrGroup
  • JSON 表示法
• TargetingSelection
  • JSON 表示法
• ForecastResult
  • JSON 表示法
• 天气预报
  • JSON 表示法
• ForecastCategory
• CpmRange
  • JSON 表示法
• ForecastBreakdownData
  • JSON 表示法
• ForecastBreakdown
  • JSON 表示法
• ErrorDetails
  • JSON 表示法
• InstantDealErrorStatus
• FrequencyCap
  • JSON 表示法
• TimeUnit
• 方法

资源：Product

产品

JSON 表示法

{ "name": string, "displayName": string, "externalDealId": string, "transactionType": enum (TransactionType), "pricingType": enum (PricingType), "updateTime": string, "startTime": string, "endTime": string, "rateDetails": { object (RateDetails) }, "creativeConfig": [ { object (CreativeConfig) } ], "makegood": boolean, "makegoodDetails": { object (MakegoodDetails) }, "creativeSource": enum (CreativeSource), "mediumType": enum (MediumType), "audienceTargetingConfig": { object (AudienceTargetingConfig) }, "targetingCriteria": { object (TargetingCriteria) }, "forecastResult": { object (ForecastResult) }, "errorDetails": { object (ErrorDetails) }, "frequencyCap": { object (FrequencyCap) }, "etag": string }

字段
name	string 商品的相对路由名称。由服务器生成。示例：“exchanges/1234/orders/5678/products/abc”。仅限输出。
displayName	string 商品的显示名称。 必须采用 UTF-8 编码，大小上限为 240 字节。必填。
externalDealId	string 外部 ID。这是广告交易平台系统中的交易 ID。最多 100 个字符。允许使用的字符包括字母数字字符、下划线、短划线和英文句点。在所有商品中必须是唯一的。必填。
transactionType	enum (TransactionType) 商品交易类型。必填。
pricingType	enum (PricingType) 商品的定价类型。必填。
updateTime (deprecated)	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"。
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"。
endTime	string (Timestamp format) 相应商品变为非有效状态的时间。目前不能晚于 2036 年。必填。 采用 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"。
rateDetails	object (RateDetails) 费率详情。必填。
creativeConfig[]	object (CreativeConfig) 产品的广告素材要求。对于预留交易类型商品，此属性为必需属性。
makegood (deprecated)	boolean 此项已弃用！ 表示相应商品是否为补偿商品。
makegoodDetails (deprecated)	object (MakegoodDetails) 此项已弃用！ 商品的补救措施详情。如果商品是补偿性广告，则必须提供此属性。
creativeSource	enum (CreativeSource) 商品的广告素材来源。可选，默认值为 CREATIVE_SOURCE_ADVERTISER。商品创建后无法更改。
mediumType	enum (MediumType) 商品的媒体类型。如果未指定，则默认为 DIGITAL，以实现向后兼容。商品创建后无法更改。
audienceTargetingConfig	object (AudienceTargetingConfig) 可选。在广告资源交易平台中，所选的受众群体定位配置已在交易级应用。
targetingCriteria	object (TargetingCriteria) 仅限输出。商品定位条件参考。仅适用于即时交易方案。
forecastResult	object (ForecastResult) 商品预测结果。如果定位条件不为空且未提供预测，则此字段为必需字段。仅适用于即时交易方案。
errorDetails	object (ErrorDetails) 如果无法更新特定商品字段，则必须指定错误详情。如果因定位条件而无法提供预测结果，或者无法更新产品，则必须提供此值。仅适用于即时交易方案。
frequencyCap	object (FrequencyCap) 仅限输出。买家选择的频次上限。仅适用于即时交易方案。
etag	string 更新商品时需要指定的 ETag。仅当 etag 字段不为空时，才需要在更新时指定此字段。仅适用于即时交易方案。

CreativeConfig

产品的广告素材要求配置。

JSON 表示法
{ "creativeType": enum (CreativeType), "dimensionCreativeConfig": { object (DimensionCreativeConfig) }, "durationCreativeConfig": { object (DurationCreativeConfig) } }

字段
creativeType	enum (CreativeType) 广告素材类型。必填。
dimensionCreativeConfig	object (DimensionCreativeConfig) 展示广告素材的配置。 原生广告素材 (CREATIVE_TYPE_NATIVE) 不支持此字段。
durationCreativeConfig	object (DurationCreativeConfig) 视频广告素材的配置。

CreativeType

可能的广告素材类型。

枚举
CREATIVE_TYPE_UNSPECIFIED	未指定广告素材类型。输入值无效。
CREATIVE_TYPE_DISPLAY	展示广告素材类型。
CREATIVE_TYPE_VIDEO	视频广告素材类型。
CREATIVE_TYPE_AUDIO	音频广告素材类型。
CREATIVE_TYPE_NATIVE	原生广告素材的类型。

DimensionCreativeConfig

展示广告素材尺寸（以像素为单位）。

JSON 表示法
{ "width": integer, "height": integer }

字段
width	integer 展示广告素材宽度。必填。
height	integer 展示广告素材高度。必填。

DurationCreativeConfig

时长内的广告素材配置。

JSON 表示法
{ "duration": string, "durationMatchType": enum (DurationMatchType), "skippableMatchType": enum (SkippableMatchType) }

字段
duration	string (Duration format) 视频广告素材的持续时间（以秒为单位）。必需 该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
durationMatchType	enum (DurationMatchType) 时长匹配条件。
skippableMatchType	enum (SkippableMatchType) 视频广告素材的可跳过类型。

DurationMatchType

时长匹配条件可能采用的格式。

枚举
DURATION_MATCH_TYPE_UNSPECIFIED	此版本中未指定或未知时长匹配条件。输入值无效。
DURATION_MATCH_TYPE_EQUAL_TO	广告素材时长必须与所需时长相同。
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO	广告素材时长必须等于或小于所需时长。

SkippableMatchType

商品的可能格式。

枚举
SKIPPABLE_MATCH_TYPE_UNSPECIFIED	此版本中未指定或未知可跳过的类型。输入值无效。
SKIPPABLE_MATCH_TYPE_SKIPPABLE	广告素材必须可跳过。
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE	广告素材必须不可跳过。
SKIPPABLE_MATCH_TYPE_ANY	广告素材可以是可跳过的，也可以是不可跳过的。

MakegoodDetails

补救详细信息的配置。

JSON 表示法
{ "originalExternalDealId": string, "reason": string }

字段
originalExternalDealId	string 请求补偿项的原始外部交易 ID。最多 100 个字符。允许使用的字符包括字母数字字符、下划线、短划线和英文句点。必填。
reason	string 由卖家发起的补偿项的原因。最多 250 个字符。必填。

CreativeSource

广告素材来源；广告素材的投放来源。

枚举
CREATIVE_SOURCE_UNSPECIFIED	在此版本中，广告素材来源未指定或未知。输入值无效。
CREATIVE_SOURCE_ADVERTISER	广告素材将由 DV3 投放。
CREATIVE_SOURCE_PUBLISHER	广告素材将由发布商投放。目前不支持发布商托管的广告素材；任何尝试将广告素材来源设置为 CREATIVE_SOURCE_PUBLISHER 的请求都会失败。

AudienceTargetingConfig

受众群体定位的配置。

JSON 表示法
{ "audienceType": enum (AudienceType) }

字段
audienceType	enum (AudienceType) 受众群体类型。必填。

AudienceType

受众群体类型。

枚举
AUDIENCE_TYPE_UNSPECIFIED	未指定的受众群体类型。不适用于输入。
AUDIENCE_TYPE_COMMERCE	商务受众群体类型。

TargetingCriteria

指定了定位条件。

JSON 表示法
{ "selectedTargetingOptions": [ { object (SelectedTargetingOption) } ] }

字段
selectedTargetingOptions[]	object (SelectedTargetingOption) 所选选项。

SelectedTargetingOption

单个定位类型的所选定位选项。

JSON 表示法
{ "type": enum (TargetingType), // Union field value can be only one of the following: "audienceSelection": { object (AudienceSelection) }, "targetingSelection": { object (TargetingSelection) } // End of list of possible types for union field value. }

字段
type	enum (TargetingType) 与所选选项相关联的定位类型。
联合字段 value。只能包含一种选择类型。所选内容必须与为“type”字段选择的 TargetingType 相对应。value 只能是下列其中一项：
audienceSelection	object (AudienceSelection) 所选受众群体。
targetingSelection	object (TargetingSelection) 一组通用的所选选项 ID。

TargetingType

定位类型。

枚举
TARGETING_TYPE_UNSPECIFIED	未指定定位类型，对于输入无效。
TARGETING_TYPE_AUDIENCE	定位类型的受众群体。
TARGETING_TYPE_COUNTRY	定位类型国家/地区。
TARGETING_TYPE_DMA	定位类型为 DMA。
TARGETING_TYPE_PROGRAMMER	定位类型程序员。
TARGETING_TYPE_BRAND	定位类型品牌。
TARGETING_TYPE_CONTENT_GENRE	定位类型内容类型。
TARGETING_TYPE_DEVICE	定位类型设备。
TARGETING_TYPE_OPERATING_SYSTEM	定位类型操作系统。
TARGETING_TYPE_RATING	定位类型评分。
TARGETING_TYPE_ENVIRONMENT	定位类型环境。
TARGETING_TYPE_LANGUAGE	定位类型语言。
TARGETING_TYPE_GEO	地理位置定位类型。
TARGETING_TYPE_AGE	定位类型年龄。
TARGETING_TYPE_GENDER	定位类型性别。
TARGETING_TYPE_CONTEXTUAL_SEGMENT	定位类型的内容相关细分受众群。
TARGETING_TYPE_REQUEST_FORMAT	定位类型请求格式。
TARGETING_TYPE_PUBLISHER	定位类型发布商。
TARGETING_TYPE_INVENTORY_SIZE	定位类型大小。
TARGETING_TYPE_NETWORK	定位类型网络。
TARGETING_TYPE_PLATFORM	定位类型平台。
TARGETING_TYPE_VIDEO_DELIVERY_TYPE	定位类型视频广告投放类型。
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE	定位类型视频播放器最小尺寸。

AudienceSelection

所选的受众群体定位选项。

JSON 表示法
{ "includedOrGroups": [ { object (OrGroup) } ], "excludedOptionIds": [ string ] }

字段
includedOrGroups[]	object (OrGroup) 包含的选项通过 AND 进行连接，每个包含的选项可以是单个选项，也可以是通过 OR 连接的一组选项。
excludedOptionIds[]	string (int64 format) 排除的选项用 OR 连接。

OrGroup

一组通过 OR 连接的所选选项。

JSON 表示法
{ "optionIds": [ string ] }

字段
optionIds[]	string (int64 format) 所选选项 ID。

TargetingSelection

一组或多组所选选项 ID，适用于大多数定位类型。

JSON 表示法
{ "optionIds": [ string ] }

字段
optionIds[]	string (int64 format) 所选选项 ID。

ForecastResult

指定了预测结果。

JSON 表示法
{ "forecasts": [ { object (Forecast) } ] }

字段
forecasts[]	object (Forecast) 预测。为每个指定元素设置的“forecastCategory”必须是唯一的。

预测

指定预测类别的预测。

JSON 表示法
{ "forecastCategory": enum (ForecastCategory), // Union field forecast_data can be only one of the following: "number": string, "percentage": integer, "cpmPrice": { object (Money) }, "cpmRange": { object (CpmRange) }, "forecastBreakdownData": { object (ForecastBreakdownData) } // End of list of possible types for union field forecast_data. }

字段
forecastCategory	enum (ForecastCategory) 所表示的预测统计信息的指定预测类别。
联合字段 forecast_data。只能包含一种类型的统计数据。填充的数据必须与“forecastCategory”字段相对应。forecast_data 只能是下列其中一项：
number	string (int64 format) 数字数据。
percentage	integer 百分比数据。
cpmPrice	object (Money) 每千次展示费用价格数据。
cpmRange	object (CpmRange) 每千次展示费用价格范围数据。
forecastBreakdownData	object (ForecastBreakdownData) 预测细分数据。

ForecastCategory

预测类别。

枚举
FORECAST_CATEGORY_UNSPECIFIED	未指定的类别。不适用于输入。
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES	优化建议总数。数字数据。
FORECAST_CATEGORY_TOTAL_AUDIENCE	总受众群体。数字数据。
FORECAST_CATEGORY_DIGITAL_TRP	数字目标收视点。百分比数据。
FORECAST_CATEGORY_SUGGESTED_CPM	建议的每千次展示费用价格。每千次展示费用范围或每千次展示费用价格数据。
FORECAST_CATEGORY_UNIQUE_REACH	预测覆盖的唯一身份用户数。数字数据。
FORECAST_CATEGORY_FORECAST_BREAKDOWN	预测细分。预测细分数据。

CpmRange

“每千次展示费用范围”包含每千次展示费用的最小值和最大值。

JSON 表示法
{ "minCpm": { object (Money) }, "maxCpm": { object (Money) } }

字段
minCpm	object (Money) 每千次展示费用范围的下限。
maxCpm	object (Money) 每千次展示费用范围的上限。

ForecastBreakdownData

预测细分数据包含预测细分列表。

JSON 表示法
{ "forecastBreakdowns": [ { object (ForecastBreakdown) } ] }

字段
forecastBreakdowns[]	object (ForecastBreakdown) 预测细分列表。

ForecastBreakdown

所选定位选项的预测细分。

JSON 表示法
{ "selectedTargetingOption": { object (SelectedTargetingOption) }, // Union field breakdown_data can be only one of the following: "impressions": string // End of list of possible types for union field breakdown_data. }

字段
selectedTargetingOption	object (SelectedTargetingOption) 单个定位类型的所选定位选项。
联合字段 breakdown_data。只能包含一种细分数据。breakdown_data 只能是下列其中一项：
impressions	string (int64 format) 预测展示次数。

ErrorDetails

更新出错时指定的错误详细信息。

JSON 表示法
{ "message": string, "instantDealErrorStatus": enum (InstantDealErrorStatus) }

字段
message	string 更新出错时指定的 message。
instantDealErrorStatus	enum (InstantDealErrorStatus) 当即时交易的更新存在错误时指定的错误状态。

InstantDealErrorStatus

指定了在即时交易更新出错时的错误状态。

枚举
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED	未指定的错误状态。
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE	错误状态表示广告资源不可用。
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE	错误状态表示天气预报不可用。
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT	错误状态表示存在无效的输入字段。

FrequencyCap

在指定时间段内，同一广告可向用户展示的次数

JSON 表示法
{ "timeUnit": enum (TimeUnit), "maxImpressions": string }

字段
timeUnit	enum (TimeUnit) 应用频次上限的时间单位。
maxImpressions	string (int64 format) 在此期间，同一用户看到同一广告的次数上限。

TimeUnit

应用频次上限的时间单位。

枚举
TIME_UNIT_UNSPECIFIED	未指定时间单位。
TIME_UNIT_LIFETIME	频次上限将应用于整个生命周期。
TIME_UNIT_MONTHS	频次上限将应用于多个月。
TIME_UNIT_WEEKS	频次上限将应用于多个周。
TIME_UNIT_DAYS	频次上限将应用于一定天数。

方法
create	创建商品。
get	获取商品。
list	列出商品。
patch	更新商品。