REST Resource: inventorySources

资源：InventorySource

广告资源来源。

JSON 表示法 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
字段
name

string

仅限输出。广告资源来源的资源名称。
inventorySourceId

string (int64 format)

仅限输出。商品目录来源的唯一 ID。由系统分配。
displayName

string

广告资源来源的显示名称。

必须采用 UTF-8 编码，大小上限为 240 字节。
inventorySourceType

enum (InventorySourceType)

表示广告资源来源的类型。
inventorySourceProductType

enum (InventorySourceProductType)

仅限输出。广告资源来源的商品类型，表示其销售广告资源的方式。
commitment

enum (InventorySourceCommitment)

相应广告资源来源的投放是有保证还是无保证。
deliveryMethod

enum (InventorySourceDeliveryMethod)

相应广告资源来源的投放方式。

  • 对于非保证型广告资源来源，唯一可接受的值是 INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC。
  • 对于有保证的广告资源来源，可接受的值为 INVENTORY_SOURCE_DELIVERY_METHOD_TAG 和 INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC。
dealId

string

交易平台空间中唯一标识广告资源来源的 ID。

在每个广告交易平台中，对于不同的买方必须是唯一的，但在不同广告交易平台中不一定必须是唯一的。
status

object (InventorySourceStatus)

广告资源来源的状态设置。
exchange

enum (Exchange)

相应广告资源来源所属的广告交易平台。
updateTime

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"。
rateDetails

object (RateDetails)

必需。相应广告资源来源的费率详细信息。
publisherName

string

相应广告资源来源的发布商/卖方名称。
timeRange

object (TimeRange)

相应广告资源来源开始和停止投放的时间范围。
creativeConfigs[]

object (CreativeConfig)

相应广告资源来源的广告素材要求。

不适用于竞价包。
guaranteedOrderId

string

不可变。相应广告资源来源所属的保量订单的 ID。

仅在 commitment 为 INVENTORY_SOURCE_COMMITMENT_GUARANTEED 时适用。
readWriteAccessors

object (InventorySourceAccessors)

对广告资源来源具有读写权限的合作伙伴或广告客户。

仅当 commitment 为 INVENTORY_SOURCE_COMMITMENT_GUARANTEED 时输出，在这种情况下，读/写访问器会从父级继承保证的顺序。

当 commitment 为 INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED 时，必须设置此参数。

如果 commitment 为 INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED 且此字段中设置了合作伙伴，则该合作伙伴下的所有广告客户都将自动拥有对相应广告资源来源的只读访问权限。这些广告客户将不会包含在 readAdvertiserIds 中。
readAdvertiserIds[]

string (int64 format)

仅限输出。对广告资源来源具有只读权限的广告客户的 ID。
readPartnerIds[]

string (int64 format)

仅限输出。对广告资源来源具有只读权限的合作伙伴的 ID。

相应字段中合作伙伴的所有广告客户都将继承对广告资源来源的只读权限。

InventorySourceType

可能的广告资源来源类型。

枚举
INVENTORY_SOURCE_TYPE_UNSPECIFIED 此版本中未指定或未知广告资源来源类型。
INVENTORY_SOURCE_TYPE_PRIVATE 私下交易广告资源来源。
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE 竞价包。

InventorySourceProductType

广告资源来源的可能商品类型。

枚举
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED 此版本中未指定或未知商品类型。不支持通过 API 修改相应产品类型的广告资源来源。
PREFERRED_DEAL 广告资源来源通过首选交易出售广告资源。
PRIVATE_AUCTION 广告资源来源通过私下竞价出售广告资源。
PROGRAMMATIC_GUARANTEED 广告资源来源通过有保证的程序化交易销售广告资源。
TAG_GUARANTEED 广告资源来源通过“基于代码的有保证广告资源”销售广告资源。
YOUTUBE_RESERVE 广告资源来源通过 YouTube 预订型广告资源销售广告资源。
INSTANT_RESERVE 广告资源来源通过即时预订销售广告资源。不支持通过 API 修改相应产品类型的广告资源来源。
GUARANTEED_PACKAGE 广告资源来源通过有保证的广告资源包销售广告资源。不支持通过 API 修改相应产品类型的广告资源来源。
PROGRAMMATIC_TV 广告资源来源通过程序化电视广告销售广告资源。不支持通过 API 修改相应产品类型的广告资源来源。
AUCTION_PACKAGE 广告资源来源通过竞价包销售广告资源。不支持通过 API 修改相应产品类型的广告资源来源。

InventorySourceCommitment

广告资源来源可能采用的承诺类型。

枚举
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED 此版本中未指定或未知承诺。
INVENTORY_SOURCE_COMMITMENT_GUARANTEED 承诺是保证投放。
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED 承诺的是无保证的投放。

InventorySourceDeliveryMethod

广告资源来源的可能投放方式。

枚举
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED 此版本中未指定或未知交付方法。
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC 投放方式为程序化。
INVENTORY_SOURCE_DELIVERY_METHOD_TAG 投放方式为代码。

InventorySourceStatus

广告资源来源的状态相关设置。

JSON 表示法 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
字段
entityStatus

enum (EntityStatus)

广告资源来源是否可投放广告。

可接受的值包括 ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED 和 ENTITY_STATUS_PAUSED。默认值为 ENTITY_STATUS_ACTIVE。
entityPauseReason

string

用户提供的暂停相应广告资源来源的原因。

不得超过 100 个字符。

仅在 entityStatus 设置为 ENTITY_STATUS_PAUSED 时适用。
sellerStatus

enum (EntityStatus)

仅限输出。卖方为广告资源来源设置的状态。

仅适用于直接从发布商处同步的广告资源来源。可接受的值包括 ENTITY_STATUS_ACTIVE 和 ENTITY_STATUS_PAUSED。
sellerPauseReason

string

仅限输出。卖家暂停相应广告资源来源的原因。

仅适用于直接从发布商处同步的广告资源来源，且仅当 sellerStatus 设置为 ENTITY_STATUS_PAUSED 时适用。
configStatus

enum (InventorySourceConfigStatus)

仅限输出。广告资源来源的配置状态。

仅适用于有保证的广告资源来源。可接受的值包括 INVENTORY_SOURCE_CONFIG_STATUS_PENDING 和 INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED。

必须先配置广告资源来源（填写必填字段、选择广告素材并选择默认广告系列），然后才能投放广告。

InventorySourceConfigStatus

有保证的广告资源来源可能具有的配置状态。

枚举
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED 此版本中未指定或未知审批状态。
INVENTORY_SOURCE_CONFIG_STATUS_PENDING 有保证的广告资源来源的初始状态。处于此状态的广告资源来源需要进行配置。
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED 买方配置保证型广告资源来源后的状态。

RateDetails

广告资源来源的相关费率设置。

JSON 表示法 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
字段
inventorySourceRateType

enum (InventorySourceRateType)

费率类型。

可接受的值包括 INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED、INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR 和 INVENTORY_SOURCE_RATE_TYPE_CPD。
rate

object (Money)

相应广告资源来源的费率。
unitsPurchased

string (int64 format)

对于有保证的广告资源来源，此项为必需。卖方保证的展示次数。
minimumSpend

object (Money)

仅限输出。买方预先承诺在相应广告资源来源上支出的金额。

仅适用于有保证的广告资源来源。

InventorySourceRateType

广告资源可能采用的费率类型。

枚举
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED 此版本中未指定或未知费率类型。
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED 费率类型为 CPM（固定）。
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR 费率类型为 CPM（底价）。
INVENTORY_SOURCE_RATE_TYPE_CPD 费率类型为“每日费用”。
INVENTORY_SOURCE_RATE_TYPE_FLAT 费率类型为“固定”。

Money

表示含有货币类型的金额。

JSON 表示法 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
字段
currencyCode

string

ISO 4217 中定义的由 3 个字母组成的货币代码。
units

string (int64 format)

金额的整数单位。例如，如果 currencyCode 是 "USD"，则 1 单位就是一美元。
nanos

integer

金额的纳诺 (10^-9) 单位数。这个值必须在 -999999999（含）和 +999999999（含）之间。如果 units 是正数，nanos 必须是正数或零。如果 units 为零，nanos 可以是正数、零或负数。如果 units 是负数，nanos 必须是负数或零。例如，$-1.75 表示为 units=-1 和 nanos=-750000000。

TimeRange

时间范围。

JSON 表示法 
{
  "startTime": string,
  "endTime": string
}
字段
startTime

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"。
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"。

CreativeConfig

广告资源来源的广告素材要求配置。

JSON 表示法 
{
  "creativeType": enum (CreativeType),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
字段
creativeType

enum (CreativeType)

可分配给广告资源来源的广告素材类型。仅支持以下类型：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

联合字段 creative_config_scheme。当 creative_type 为以下值之一时，适用此字段：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

可分配给广告资源来源的广告素材的配置。creative_config_scheme 只能是下列其中一项：
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

展示广告素材的配置。当 creativeType 为 CREATIVE_TYPE_STANDARD 时适用。
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

视频广告素材的配置。当 creativeType 为 CREATIVE_TYPE_VIDEO 时适用。

InventorySourceDisplayCreativeConfig

展示广告素材的配置。

JSON 表示法 
{
  "creativeSize": {
    object (Dimensions)
  }
}
字段
creativeSize

object (Dimensions)

可分配给相应广告资源来源的展示广告素材的尺寸要求。

InventorySourceVideoCreativeConfig

视频广告素材的配置。

JSON 表示法 
{
  "duration": string
}
字段
duration

string (Duration format)

可分配给相应广告资源来源的视频广告素材的时长要求。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。

InventorySourceAccessors

有权访问相应广告资源来源的合作伙伴或广告客户。

JSON 表示法 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
字段
联合字段 accessors。有权访问相应广告资源来源的合作伙伴或广告客户。accessors 只能是下列其中一项：
partner

object (PartnerAccessor)

有权访问广告资源来源的合作伙伴。
advertisers

object (AdvertiserAccessors)

有权访问相应广告资源来源的广告客户。所有广告客户都必须属于同一合作伙伴。

PartnerAccessor

有权访问广告资源来源的合作伙伴。

JSON 表示法 
{
  "partnerId": string
}
字段
partnerId

string (int64 format)

合作伙伴的 ID。

AdvertiserAccessors

有权访问相应广告资源来源的广告客户。

JSON 表示法 
{
  "advertiserIds": [
    string
  ]
}
字段
advertiserIds[]

string (int64 format)

广告客户的 ID。

方法

create

 创建新的广告资源来源。

editInventorySourceReadWriteAccessors

 修改广告资源来源的读写访问器。

get

 获取广告资源来源。

list

 列出当前用户可访问的广告资源来源。

patch

 更新现有广告资源来源。