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)

ต้องระบุ apks.list ของข้อมูลที่แปลแล้วสําหรับการสมัครใช้บริการนี้ ต้องมีรายการสําหรับภาษาเริ่มต้นของแอประดับบนสุดเป็นอย่างน้อย

archived

boolean

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

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

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

แพ็กเกจเริ่มต้น

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

การแสดง 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)

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

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

ข้อมูลราคาสําหรับสถานที่ใหม่ๆ ที่ Play อาจเปิดให้บริการในอนาคต หากไม่ระบุ BasePlan จะไม่สามารถใช้งานตําแหน่งใหม่โดยอัตโนมัติ ซึ่ง Play อาจเปิดให้บริการในอนาคต

ช่อง Union base_plan_type ประเภทแพ็กเกจเริ่มต้นนี้ ต้องตั้งค่าแอปหนึ่งรายการเท่านั้น base_plan_type ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

กําหนดเวลาที่แพ็กเกจเริ่มต้นจะต่ออายุโดยอัตโนมัติเป็นระยะๆ

prepaidBasePlanType

object (PrepaidBasePlanType)

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

รัฐ

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

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

ประเภทแพ็กเกจเริ่มต้นการต่ออายุใหม่อัตโนมัติ

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

การแสดง JSON
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": 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 วัน) หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้นโดยอิงตามระยะเวลาที่เกิดซ้ํา

resubscribeState

enum (ResubscribeState)

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

prorationMode

enum (SubscriptionProrationMode)

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

legacyCompatible

boolean

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

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

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

legacyCompatibleSubscriptionOfferId

string

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

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

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

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

สถานะการสมัครอีกครั้ง

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

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

โหมดการสมัครใช้บริการตามสัดส่วน

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

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

ประเภทแพ็กเกจแบบชําระเงินล่วงหน้า

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

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

string

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

timeExtension

enum (TimeExtension)

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

ส่วนขยายเวลา

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

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

การกําหนดค่าแพ็กเกจเริ่มต้นระดับภูมิภาค

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

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

string

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

newSubscriberAvailability

boolean

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

price

object (Money)

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

การกําหนดค่าแพ็กเกจระดับภูมิภาคอื่นๆ

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

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

object (Money)

ต้องระบุ ราคาเป็นสกุลเงินดอลลาร์สหรัฐสําหรับใช้ในประเทศใหม่ๆ ที่ Play อาจจะเปิดตัว

eurPrice

object (Money)

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

newSubscriberAvailability

boolean

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

รายชื่อการสมัครใช้บริการ

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

การแสดง 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

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

create

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

delete

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

get

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

list

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

patch

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