Method: monetization.subscriptions.basePlans.offers.batchUpdateStates

批量更新订阅优惠状态。

将嵌套请求中的 latencyTolerance 字段设置为 PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT 可实现最大更新吞吐量。

HTTP 请求

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates

网址采用 gRPC 转码语法。

路径参数

参数
packageName

string

必需。要更新的订阅优惠所对应的父级应用(软件包名称)。

必须与所有要更新的 SubscriptionOffer 资源中的 packageName 字段相同。

productId

string

必需。如果所有要更新的优惠属于同一订阅,则为父级订阅的商品 ID。如果此请求涉及多个订阅,请将该字段设置为“-”。必须设置。

basePlanId

string

必需。要更新的优惠所对应的父级基础方案 (ID)。可以指定为“-”,以更新多个基础方案中的优惠。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "requests": [
    {
      object (UpdateSubscriptionOfferStateRequest)
    }
  ]
}
字段
requests[]

object (UpdateSubscriptionOfferStateRequest)

必需。最多包含 100 个元素的更新请求列表。各个请求申请更新的优惠必须各不相同。

响应正文

针对 offers.batchUpdateStates 的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "subscriptionOffers": [
    {
      object (SubscriptionOffer)
    }
  ]
}
字段
subscriptionOffers[]

object (SubscriptionOffer)

更新后的订阅优惠列表。

授权范围

需要以下 OAuth 范围:

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

UpdateSubscriptionOfferStateRequest

用于更新订阅优惠状态的请求消息。

JSON 表示法
{

  // Union field state_transition_type can be only one of the following:
  "activateSubscriptionOfferRequest": {
    object (ActivateSubscriptionOfferRequest)
  },
  "deactivateSubscriptionOfferRequest": {
    object (DeactivateSubscriptionOfferRequest)
  }
  // End of list of possible types for union field state_transition_type.
}
字段
联合字段 state_transition_type。要应用的状态转换的类型,只能设置一个值。state_transition_type 只能是下列其中一项:
activateSubscriptionOfferRequest

object (ActivateSubscriptionOfferRequest)

激活优惠。优惠激活后,新订阅者将可享受。

deactivateSubscriptionOfferRequest

object (DeactivateSubscriptionOfferRequest)

停用优惠。优惠停用后,新订阅者将无法享受,但现有订阅者可保留其订阅。

ActivateSubscriptionOfferRequest

针对 ActivateSubscriptionOffer 的请求消息。

JSON 表示法
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
字段
packageName

string

必需。要激活的优惠所对应的父级应用(软件包名称)。

productId

string

必需。要激活的优惠所对应的父级订阅 (ID)。

basePlanId

string

必需。要激活的优惠所对应的父级基础方案 (ID)。

offerId

string

必需。要激活的优惠的唯一优惠 ID。

latencyTolerance

enum (ProductUpdateLatencyTolerance)

可选。相应商品更新的传播延迟容忍度。默认设置为对延迟敏感。

DeactivateSubscriptionOfferRequest

针对 offers.deactivate 的请求消息。

JSON 表示法
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
字段
packageName

string

必需。要停用的优惠的父应用(软件包名称)。

productId

string

必需。要停用的优惠的父级订阅 (ID)。

basePlanId

string

必需。要停用的优惠的父级基础方案 (ID)。

offerId

string

必需。要停用的优惠的唯一优惠 ID。

latencyTolerance

enum (ProductUpdateLatencyTolerance)

可选。相应商品更新的传播延迟容忍度。默认设置为对延迟敏感。