Method: purchases.subscriptionsv2.scheduleplantransition

安排訂閱方案轉換。

HTTP 要求

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:schedulePlanTransition

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
packageName

string

必填。購買這項訂閱項目的應用程式套件 (例如「com.some.thing」)。

token

string

必填。購買訂閱項目時提供給使用者裝置的權杖。

要求主體

要求主體會包含結構如下的資料:

JSON 表示法
{
  "productId": string,
  "earliestTransitionEffectiveTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "definiteTransition": {
    object (DefiniteTransition)
  },
  "tentativeTransition": {
    object (TentativeTransition)
  }
  // End of mutually exclusive fields.
  "etag": string
}
欄位
productId

string

必填。必須排定轉換作業的訂閱產品 (例如「premium_plan」)。

earliestTransitionEffectiveTime

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

[必要] 方案轉換模式。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
definiteTransition

object (DefiniteTransition)

使用這個模式時,使用者一定會轉換至新方案,且無法取消。

tentativeTransition

object (TentativeTransition)

使用這個模式時,使用者轉換至新方案的狀態為暫定,可以取消。

互斥欄位結束。
etag

string

如果設定這項屬性,且 etag 與這個訂閱項目的最新 etag 不符,API 就會失敗。etag 是從 purchases.subscriptionsv2.get 擷取:https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptionsv2/get

回應主體

purchases.subscriptionsv2.schedulePlanTransition API 的回應。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  }
}
欄位
planTransitionDetails

object (PlanTransitionDetails)

訂閱項目的方案轉換詳細資料。

授權範圍

需要下列 OAuth 範圍:

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

DefiniteTransition

這個類型沒有任何欄位。

用於表示方案轉換已確定。

TentativeTransition

這個類型沒有任何欄位。

用於表示方案轉換為暫定。