Method: monetization.subscriptions.basePlans.batchUpdateStates

启用或停用一项或多项订阅的基础方案。

将嵌套请求上的 delayTolerance 字段设置为 PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT,以实现最大更新吞吐量。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
packageName

string

必需。更新后的基础方案的父级应用(软件包名称)。

productId

string

必需。父级订阅的商品 ID(如果所有更新后的基础方案都属于同一订阅)。如果此批量更新涉及多个订阅,请将此字段设置为“-”。必须设置。

请求正文

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

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

object (UpdateBasePlanStateRequest)

必需。最多包含 100 个元素的更新请求列表。所有请求都必须更新不同的基础方案。

响应正文

basePlans.batchUpdateStates 的响应消息。

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

JSON 表示法
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ]
}
字段
subscriptions[]

object (Subscription)

已更新订阅的列表。此列表会以相同的顺序将请求逐一匹配。

授权范围

需要以下 OAuth 范围:

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

UpdateBasePlanStateRequest

用于更新订阅基础方案状态的请求消息。

JSON 表示法
{

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

object (ActivateBasePlanRequest)

启用基础方案。基础方案激活后,即可供新订阅者使用。

deactivateBasePlanRequest

object (DeactivateBasePlanRequest)

停用某个基础方案。停用后,新订阅者将无法再使用基础方案,但现有订阅者仍可继续使用自己的订阅

ActivateBasePlanRequest

ActivateBasePlan 的请求消息。

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

string

必需。要激活的基础方案的父级应用(软件包名称)。

productId

string

必需。要激活的基础方案的父级订阅 (ID)。

basePlanId

string

必需。要启用的基础方案的唯一 ID。

latencyTolerance

enum (ProductUpdateLatencyTolerance)

可选。传播此产品更新的延迟容忍度。默认为对延迟时间敏感。

DeactivateBasePlanRequest

basePlans.deactivate 的请求消息。

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

string

必需。要停用的基础方案的父级应用(软件包名称)。

productId

string

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

basePlanId

string

必需。要停用的基础方案的唯一 ID。

latencyTolerance

enum (ProductUpdateLatencyTolerance)

可选。传播此产品更新的延迟容忍度。默认为对延迟时间敏感。