Method: monetization.subscriptions.basePlans.batchUpdateStates

啟用或停用一或多個訂閱項目的基本方案。

將巢狀要求的 latencyTolerance 欄位設為 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

必要欄位。要啟用的 Base Plan 的父項應用程式 (套件名稱)。

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)

選用設定。這項產品更新的傳播延遲容許值。預設為「延遲敏感」。