REST Resource: monetization.subscriptions

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

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

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

string

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

string

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

object (BasePlan)

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

object (SubscriptionListing)

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

boolean

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

object (SubscriptionTaxAndComplianceSettings)

รายละเอียดเกี่ยวกับภาษีและการปฏิบัติตามกฎหมาย
restrictedPaymentCountries

object (RestrictedPaymentCountries)

ไม่บังคับ ประเทศที่จำกัดการซื้อการสมัครใช้บริการนี้ไว้เฉพาะวิธีการชำระเงินที่จดทะเบียนในประเทศเดียวกัน หากว่างเปล่า จะไม่มีการจำกัดสถานที่ชำระเงิน

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)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // 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 ประเภทของแพ็กเกจเริ่มต้นนี้ ต้องตั้งค่าเพียง 1 รายการ base_plan_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

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

object (InstallmentsBasePlanType)

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

รัฐ

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

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 (0 วัน) ถึง 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 ไม่ได้เปิดใช้งานการขยายเวลา ผู้ใช้จะเติมเงินหรือขยายเวลาแพ็กเกจแบบชำระเงินล่วงหน้าไม่ได้

InstallmentsBasePlanType

แสดงแพ็กเกจเริ่มต้นการผ่อนชำระที่ผู้ใช้มีสัญญาผูกมัดตามจำนวนการชำระเงินที่ระบุ

การแสดง JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
ช่อง
billingPeriodDuration

string

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

integer

ต้องระบุ จำนวนการชำระเงินที่ผู้ใช้มีข้อผูกพัน
renewalType

enum (RenewalType)

ต้องระบุ ประเภทการต่ออายุแพ็กเกจเริ่มต้นสำหรับการผ่อนชำระ กำหนดการทำงานเมื่อสิ้นสุดสัญญาผูกมัดเริ่มต้น
gracePeriodDuration

string

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

string

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

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

RenewalType

ประเภทการต่ออายุแพ็กเกจเริ่มต้นสำหรับการผ่อนชำระ กำหนดการทำงานเมื่อสิ้นสุดสัญญาผูกมัดเริ่มต้น

Enum
RENEWAL_TYPE_UNSPECIFIED สถานะที่ไม่ได้ระบุ
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT ต่ออายุเป็นระยะๆ สำหรับช่วงเวลาที่เรียกเก็บเงินโดยไม่มีข้อผูกมัด
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT ต่ออายุโดยมีระยะเวลาผูกมัดกับระยะเวลาเริ่มต้น

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)

ต้องระบุ ราคาเป็นสกุลเงินยูโรที่จะใช้สำหรับสถานที่ใหม่ที่ 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 อักขระ ข้อความธรรมดา

RestrictedPaymentCountries

ประเทศที่จำกัดการซื้อผลิตภัณฑ์นี้ไว้สำหรับวิธีการชำระเงินที่จดทะเบียนในประเทศเดียวกัน หากว่างเปล่า จะไม่มีการจำกัดสถานที่ชำระเงิน

การแสดง JSON 
{
  "regionCodes": [
    string
  ]
}
ช่อง
regionCodes[]

string

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

เมธอด

archive
(deprecated)

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

batchGet

 อ่านการสมัครใช้บริการอย่างน้อย 1 รายการ

batchUpdate

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

create

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

delete

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

get

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

list

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

patch

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