REST Resource: monetization.subscriptions

แหล่งข้อมูล: การสมัครใช้บริการ

การสมัครใช้บริการรายการเดียวสำหรับแอป

การแสดง JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
ช่อง
packageName

string

เปลี่ยนแปลงไม่ได้ ชื่อแพ็กเกจของแอปหลัก
productId

string

เปลี่ยนแปลงไม่ได้ รหัสผลิตภัณฑ์ที่ไม่ซ้ำกันของผลิตภัณฑ์ ไม่ซ้ำกันภายในแอปหลัก รหัสผลิตภัณฑ์ต้องประกอบด้วยอักษรตัวพิมพ์เล็ก (a-z) ตัวเลข (0-9) ขีดล่าง (_) และจุด (.) และต้องเริ่มต้นด้วยตัวอักษรตัวพิมพ์เล็กหรือตัวเลข และมีความยาวระหว่าง 1 ถึง 40 อักขระ (รวม)
basePlans[]

object (BasePlan)

ชุดแพ็กเกจเริ่มต้นสำหรับการสมัครใช้บริการนี้ แสดงราคาและระยะเวลาของการสมัครใช้บริการหากไม่มีข้อเสนออื่นๆ
listings[]

object (SubscriptionListing)

ต้องระบุ รายการข้อมูลที่แปลเป็นภาษาท้องถิ่นสำหรับการสมัครใช้บริการนี้ ต้องมีอย่างน้อย 1 รายการสำหรับภาษาเริ่มต้นของแอปหลัก
archived
(deprecated)

boolean

เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ไม่รองรับการเก็บการสมัครใช้บริการ
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

รายละเอียดเกี่ยวกับภาษีและการปฏิบัติตามข้อกำหนดทางกฎหมาย

BasePlan

แพ็กเกจเริ่มต้นรายการเดียวสำหรับการสมัครใช้บริการ

การแสดง JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
ช่อง
basePlanId

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ตัวระบุที่ไม่ซ้ำกันของแพ็กเกจเริ่มต้นนี้ ต้องไม่ซ้ำกันภายในการสมัครใช้บริการและสอดคล้องกับ RFC-1034 กล่าวคือ รหัสนี้ต้องมีอักษรตัวพิมพ์เล็ก (a-z) ตัวเลข (0-9) และขีดกลาง (-) เท่านั้น และมีอักขระไม่เกิน 63 ตัว
state

enum (State)

เอาต์พุตเท่านั้น สถานะของแพ็กเกจเริ่มต้น กล่าวคือ มีสถานะใช้งานอยู่หรือไม่ สามารถเปิดใช้งานหรือลบแพ็กเกจเริ่มต้นฉบับร่างและที่ไม่ได้ใช้งานได้ แพ็กเกจเริ่มต้นที่ใช้งานอยู่สามารถเปลี่ยนสถานะเป็นไม่ได้ใช้งานได้ คุณสามารถยกเลิกแพ็กเกจเริ่มต้นที่ไม่ได้ใช้งานได้ ช่องนี้ไม่สามารถเปลี่ยนโดยการอัปเดตทรัพยากร โปรดใช้ปลายทางเฉพาะแทน
regionalConfigs[]

object (RegionalBasePlanConfig)

ข้อมูลเฉพาะภูมิภาคสำหรับแพ็กเกจเริ่มต้นนี้
offerTags[]

object (OfferTag)

รายการแท็กที่กําหนดเองสูงสุด 20 รายการที่ระบุสําหรับแพ็กเกจเริ่มต้นนี้และกลับไปยังแอปผ่านไลบรารีการเรียกเก็บเงิน ข้อเสนอการสมัครใช้บริการสำหรับแพ็กเกจเริ่มต้นนี้จะได้รับแท็กข้อเสนอเหล่านี้ในคลังการเรียกเก็บเงินด้วย
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

ข้อมูลราคาสำหรับพื้นที่ใหม่ๆ ที่ Play อาจเปิดตัวในอนาคต หากละเว้น BasePlan จะไม่พร้อมให้บริการโดยอัตโนมัติ สถานที่ใหม่ๆ ที่ Play อาจเปิดตัวในอนาคต
ฟิลด์สหภาพ base_plan_type ประเภทของแพ็กเกจเริ่มต้นนี้ ต้องตั้งค่าหนึ่งรายการเท่านั้น base_plan_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

กำหนดเวลาที่ระบบจะต่ออายุแพ็กเกจเริ่มต้นโดยอัตโนมัติในช่วงเวลาที่สม่ำเสมอ
prepaidBasePlanType

object (PrepaidBasePlanType)

กำหนดเวลาที่ไม่ต่ออายุแพ็กเกจเริ่มต้นโดยอัตโนมัติเมื่อช่วงเวลาที่เรียกเก็บเงินสิ้นสุดลง

รัฐ

สถานะปัจจุบันของแพ็กเกจเริ่มต้น

Enum
STATE_UNSPECIFIED ไม่ระบุสถานะ
DRAFT ขณะนี้แพ็กเกจเริ่มต้นอยู่ในสถานะฉบับร่างและยังไม่ได้เปิดใช้งาน คุณสามารถลบได้อย่างปลอดภัยในขณะนี้
ACTIVE แพ็กเกจเริ่มต้นมีการใช้งานอยู่และพร้อมให้สมาชิกใหม่ใช้งาน
INACTIVE แพ็กเกจเริ่มต้นไม่มีการใช้งานและพร้อมให้บริการแก่สมาชิกปัจจุบันเท่านั้น

AutoRenewingBasePlanType

หมายถึงแพ็กเกจเริ่มต้นที่จะต่ออายุโดยอัตโนมัติเมื่อสิ้นสุดระยะเวลาการสมัครใช้บริการ

การแสดง JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
ช่อง
billingPeriodDuration

string

ต้องระบุ ระยะเวลาการสมัครใช้บริการที่ระบุในรูปแบบ ISO 8601 โปรดดูรายการช่วงเวลาที่เรียกเก็บเงินที่ยอมรับได้ในศูนย์ช่วยเหลือ
gracePeriodDuration

string

ระยะเวลาผ่อนผันของการสมัครใช้บริการ ซึ่งระบุในรูปแบบ ISO 8601 ค่าที่ยอมรับได้ ได้แก่ P0D (ศูนย์วัน), P3D (3 วัน), P7D (7 วัน), P14D (14 วัน) และ P30D (30 วัน) หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้นตามระยะเวลาที่เกิดซ้ำ
accountHoldDuration

string

ไม่บังคับ ระยะเวลาการระงับบัญชีของการสมัครใช้บริการ ซึ่งระบุในรูปแบบ ISO 8601 ค่าที่ยอมรับได้จะต้องอยู่ในช่วง DAYS และอยู่ในช่วง P0D (ศูนย์วัน) ถึง P30D (30 วัน) หากไม่ได้ระบุไว้ ค่าเริ่มต้นจะเป็น P30D (30 วัน)
resubscribeState

enum (ResubscribeState)

ผู้ใช้ควรมีสิทธิ์สมัครใช้บริการแพ็กเกจเริ่มต้นนี้อีกครั้งในแพลตฟอร์มต่างๆ ของ Google Play หรือไม่ ค่าเริ่มต้นคือ RESUBSCRIBE_STATE_ACTIVE หากไม่ได้ระบุ
prorationMode

enum (SubscriptionProrationMode)

โหมดสัดส่วนของแพ็กเกจเริ่มต้นจะเป็นตัวกำหนดสิ่งที่จะเกิดขึ้นเมื่อผู้ใช้เปลี่ยนจากแพ็กเกจเริ่มต้นอื่นมาใช้แพ็กเกจนี้ หากไม่ระบุ ค่าเริ่มต้นจะเป็น CHARGE_ON_NEXT_BILLING_DATE
legacyCompatible

boolean

แพ็กเกจเริ่มต้นการต่ออายุนี้เข้ากันได้กับแผนดำเนินการแบบย้อนหลังหรือไม่

แพ็กเกจเริ่มต้นที่เข้ากันได้แบบย้อนหลังจะส่งคืนโดยวิธี querySkuDetailsAsync() ที่เลิกใช้แล้วของ Google Play Billing Library

ทำเครื่องหมายแพ็กเกจเริ่มต้นแบบต่ออายุใหม่ได้เพียง 1 แพ็กเกจว่าเข้ากันได้กับแผนเดิมในการสมัครใช้บริการหนึ่งๆ
legacyCompatibleSubscriptionOfferId

string

รหัสข้อเสนอการสมัครใช้บริการที่เข้ากันได้แบบเดิม

ระบบจะส่งข้อเสนอการสมัครใช้บริการที่เข้ากันได้แบบย้อนหลังโดยวิธี querySkuDetailsAsync() ที่เลิกใช้แล้วของ Google Play Billing Library

ทำเครื่องหมายข้อเสนอการสมัครใช้บริการได้เพียง 1 รายการว่าเข้ากันได้กับแพ็กเกจเริ่มต้นในแพ็กเกจเริ่มต้นหนึ่งๆ ที่ต่ออายุ

หากไม่ต้องการใช้ข้อเสนอการสมัครใช้บริการเนื่องจากเข้ากันได้กับแผนเดิม ให้ตั้งค่าช่องนี้เป็นสตริงว่างเปล่า

ResubscribeState

สถานะการสมัครใช้บริการอีกครั้งของแพ็กเกจเริ่มต้น

Enum
RESUBSCRIBE_STATE_UNSPECIFIED ไม่ระบุสถานะ
RESUBSCRIBE_STATE_ACTIVE การสมัครใช้บริการอีกครั้งทำงานอยู่
RESUBSCRIBE_STATE_INACTIVE การสมัครใช้บริการอีกครั้งไม่ทำงาน

SubscriptionProrationMode

โหมดการแบ่งตามสัดส่วนที่ใช้สำหรับการต่ออายุแพ็กเกจเริ่มต้น

Enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED โหมดที่ไม่ระบุ
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE ระบบจะเรียกเก็บเงินค่าแพ็กเกจเริ่มต้นใหม่จากผู้ใช้เมื่อสิ้นสุดช่วงเวลาที่เรียกเก็บเงินปัจจุบัน
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY ระบบจะเรียกเก็บเงินสำหรับแพ็กเกจเริ่มต้นใหม่จากผู้ใช้ทันทีและเต็มจำนวน ระบบจะนำระยะเวลาที่เหลือของการสมัครใช้บริการที่มีอยู่ไปใช้ขยายระยะเวลาของแผนการเรียกเก็บเงินใหม่

PrepaidBasePlanType

หมายถึงแพ็กเกจเริ่มต้นที่ไม่ต่ออายุโดยอัตโนมัติเมื่อสิ้นสุดแพ็กเกจเริ่มต้น และผู้ใช้ต้องต่ออายุด้วยตนเอง

การแสดง JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
ช่อง
billingPeriodDuration

string

ต้องระบุ ระยะเวลาการสมัครใช้บริการที่ระบุในรูปแบบ ISO 8601 โปรดดูรายการช่วงเวลาที่เรียกเก็บเงินที่ยอมรับได้ในศูนย์ช่วยเหลือ
timeExtension

enum (TimeExtension)

ผู้ใช้ควรที่จะขยายแพ็กเกจเริ่มต้นแบบชำระล่วงหน้านี้ในแพลตฟอร์ม Google Play ได้หรือไม่ ค่าเริ่มต้นคือ TIME_EXTENSION_ACTIVE หากไม่ได้ระบุไว้

TimeExtension

การขยายเวลาของแพ็กเกจเริ่มต้น

Enum
TIME_EXTENSION_UNSPECIFIED ไม่ระบุสถานะ
TIME_EXTENSION_ACTIVE ใช้ส่วนขยายเวลาอยู่ ผู้ใช้มีสิทธิ์เติมเงินหรือขยายเวลาแพ็กเกจแบบชำระเงินล่วงหน้า
TIME_EXTENSION_INACTIVE ไม่มีการใช้งานส่วนขยายเวลา ผู้ใช้ไม่สามารถเติมเงินหรือขยายเวลาแพ็กเกจแบบชำระเงินล่วงหน้า

RegionalBasePlanConfig

การกําหนดค่าสําหรับแพ็กเกจเริ่มต้นสําหรับภูมิภาคหนึ่งๆ โดยเฉพาะ

การแสดง JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
ช่อง
regionCode

string

ต้องระบุ รหัสภูมิภาคที่ใช้การกำหนดค่านี้ตามที่กำหนดโดย ISO 3166-2 เช่น "US"
newSubscriberAvailability

boolean

แพ็กเกจเริ่มต้นในภูมิภาคที่ระบุพร้อมให้บริการสำหรับสมาชิกใหม่หรือไม่ สมาชิกปัจจุบันจะไม่ถูกยกเลิกการสมัครใช้บริการหากตั้งค่านี้เป็น "เท็จ" หากไม่ระบุ ระบบจะใช้ค่าเริ่มต้นเป็น "เท็จ"
price

object (Money)

ราคาของแพ็กเกจเริ่มต้นในภูมิภาคที่ระบุ ต้องตั้งค่าหากแพ็กเกจเริ่มต้นพร้อมให้บริการสำหรับสมาชิกใหม่ ต้องตั้งค่าในสกุลเงินที่ลิงก์กับภูมิภาคที่ระบุ

OtherRegionsBasePlanConfig

ข้อมูลราคาสำหรับสถานที่ใหม่ๆ ที่ Play อาจเปิดตัว

การแสดง JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
ช่อง
usdPrice

object (Money)

ต้องระบุ ราคาเป็นสกุลเงิน USD สำหรับใช้กับสถานที่ใหม่ๆ ที่ Play อาจเปิดตัว
eurPrice

object (Money)

ต้องระบุ ราคาเป็นสกุลเงินยูโร (EUR €) เพื่อใช้กับสถานที่ใหม่ๆ ที่ Play อาจเปิดตัว
newSubscriberAvailability

boolean

แพ็กเกจเริ่มต้นพร้อมให้บริการสำหรับสมาชิกใหม่ในประเทศใหม่ๆ ที่ Play อาจเปิดตัวหรือไม่ หากไม่ระบุ ระบบจะใช้ค่าเริ่มต้นเป็น "เท็จ"

SubscriptionListing

ข้อมูลเมตาที่ผู้บริโภคมองเห็นได้ของการสมัครใช้บริการ

การแสดง JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
ช่อง
languageCode

string

ต้องระบุ ภาษาของรายชื่อนี้ตามที่กำหนดโดย BCP-47 เช่น "en-US"
title

string

ต้องระบุ ชื่อของการสมัครใช้บริการนี้ในภาษาของข้อมูลนี้ ข้อความธรรมดา
benefits[]

string

รายการสิทธิประโยชน์ที่แสดงต่อผู้ใช้ในแพลตฟอร์มต่างๆ เช่น Play Store และในขั้นตอนการกู้คืนในภาษาของข้อมูลนี้ ข้อความธรรมดา รายการสิทธิประโยชน์ที่เรียงลำดับได้สูงสุด 4 ข้อ
description

string

คำอธิบายของการสมัครใช้บริการนี้ในภาษาของข้อมูลนี้ ความยาวสูงสุด 80 อักขระ ข้อความธรรมดา

วิธีการ

archive
(deprecated)

 เลิกใช้งานแล้ว: ไม่รองรับการเก็บการสมัครใช้บริการ

batchGet

 อ่านการสมัครรับข้อมูลอย่างน้อย 1 รายการ

batchUpdate

 อัปเดตการสมัครใช้บริการเป็นกลุ่ม

create

 สร้างการสมัครใช้บริการใหม่

delete

 ลบการสมัครใช้บริการ

get

 อ่านการสมัครใช้บริการรายการเดียว

list

 แสดงรายการการสมัครใช้บริการทั้งหมดภายใต้แอปที่ระบุ

patch

 อัปเดตการสมัครใช้บริการที่มีอยู่