- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- UpdateBasePlanStateRequest
- ActivateBasePlanRequest
- DeactivateBasePlanRequest
- 試試看!
啟用或停用一或多個訂閱項目的基本方案。
將巢狀要求的延遲時間 Tolerance 欄位設為 PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT,才能達到最大更新處理量。
HTTP 要求
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchUpdateStates
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
packageName |
必要欄位。已更新基本方案的父項應用程式 (套件名稱)。 |
productId |
必要欄位。如果所有更新的基本方案都屬於同一個訂閱項目,則父項訂閱項目的產品 ID。如果這項批次更新作業涵蓋多個訂閱項目,請將這個欄位設為「-」。必須設定。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{
"requests": [
{
object ( |
欄位 | |
---|---|
requests[] |
必要欄位。更新要求清單,最多包含 100 個元素。所有要求都必須更新不同的基本方案。 |
回應主體
basePlans.batchUpdateStates 的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{
"subscriptions": [
{
object ( |
欄位 | |
---|---|
subscriptions[] |
更新訂閱項目的清單。這份清單會以同一個順序,將要求中的一個要求比對成一個。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/androidpublisher
UpdateBasePlanStateRequest
要求訊息來更新訂閱基本方案的狀態。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 state_transition_type 。要套用的狀態轉換類型,只能設定一項。state_transition_type 只能是下列其中一項: |
|
activateBasePlanRequest |
啟用基本方案。啟用後,新訂閱者就能使用基本方案。 |
deactivateBasePlanRequest |
停用基本方案。停用後,新訂閱者就無法享有基本方案,但現有訂閱者仍可繼續訂閱 |
ActivateBasePlanRequest
ActivateBasePlan 的要求訊息。
JSON 表示法 |
---|
{
"packageName": string,
"productId": string,
"basePlanId": string,
"latencyTolerance": enum ( |
欄位 | |
---|---|
packageName |
必要欄位。要啟用的基本方案的父項應用程式 (套件名稱)。 |
productId |
必要欄位。要啟用的基本方案的上層訂閱項目 (ID)。 |
basePlanId |
必要欄位。要啟用的基本方案專屬基本方案 ID。 |
latencyTolerance |
選用設定。這項產品更新傳播的延遲時間容忍度。預設為易受延遲時間影響。 |
DeactivateBasePlanRequest
basePlans.deactivate 的要求訊息。
JSON 表示法 |
---|
{
"packageName": string,
"productId": string,
"basePlanId": string,
"latencyTolerance": enum ( |
欄位 | |
---|---|
packageName |
必要欄位。要停用的基本方案的父項應用程式 (套件名稱)。 |
productId |
必要欄位。要停用的基本方案父項訂閱項目 (ID)。 |
basePlanId |
必要欄位。要停用的基本方案專屬基本方案 ID。 |
latencyTolerance |
選用設定。這項產品更新傳播的延遲時間容忍度。預設為易受延遲時間影響。 |