REST Resource: monetization.subscriptions.basePlans.offers

ทรัพยากร: SubscriptionOffer

ข้อเสนอชั่วคราวแบบครั้งเดียว

การแสดง JSON 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
ช่อง
packageName

string

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

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ รหัสของการสมัครใช้บริการหลักที่มีข้อเสนอนี้อยู่
basePlanId

string

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

string

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

enum (State)

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

object (SubscriptionOfferPhase)

ต้องระบุ เฟสของข้อเสนอการสมัครใช้บริการนี้ ต้องมีรายการอย่างน้อย 1 รายการและไม่เกิน 2 รายการ ผู้ใช้จะได้รับเฟสทั้งหมดเหล่านี้ตามลำดับที่ระบุเสมอ
targeting

object (SubscriptionOfferTargeting)

ข้อกำหนดที่ผู้ใช้ต้องปฏิบัติตามเพื่อให้มีสิทธิ์รับข้อเสนอนี้ แสดงข้อกำหนดที่ Play จะประเมินเพื่อตัดสินใจว่าควรแสดงข้อเสนอหรือไม่ นักพัฒนาแอปอาจกรองข้อเสนอเหล่านี้เพิ่มเติมด้วยตนเอง
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

ต้องระบุ การกำหนดค่าเฉพาะภูมิภาคของข้อเสนอนี้ ต้องมีรายการอย่างน้อย 1 รายการ
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

การกำหนดค่าสำหรับสถานที่ตั้งใหม่ที่ Google Play อาจเปิดตัวในอนาคต
offerTags[]

object (OfferTag)

รายการแท็กที่กำหนดเองสูงสุด 20 รายการที่ระบุไว้สำหรับข้อเสนอนี้ และส่งกลับไปยังแอปผ่าน Billing Library

รัฐ

สถานะปัจจุบันของข้อเสนอการสมัครใช้บริการ

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น ไม่ควรใช้
DRAFT ข้อเสนอการสมัครใช้บริการไม่พร้อมใช้งานและไม่เคยพร้อมใช้งานสำหรับผู้ใช้
ACTIVE ข้อเสนอการสมัครใช้บริการนี้พร้อมใช้งานสำหรับผู้ใช้ใหม่และผู้ใช้ปัจจุบัน
INACTIVE ข้อเสนอการสมัครใช้บริการไม่พร้อมใช้งานสำหรับผู้ใช้ใหม่ ผู้ใช้เดิมจะยังคงมีสิทธิ์เข้าถึง

SubscriptionOfferPhase

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

การแสดง JSON 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
ช่อง
recurrenceCount

integer

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

string

ต้องระบุ ระยะเวลาของการเกิดซ้ำครั้งเดียวของระยะนี้ ระบุในรูปแบบ ISO 8601
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

ต้องระบุ การกำหนดค่าเฉพาะภูมิภาคของเฟสข้อเสนอนี้ รายการนี้ต้องมีรายการเดียวสำหรับแต่ละภูมิภาคที่ข้อเสนอการสมัครใช้บริการมีการกำหนดค่าระดับภูมิภาค
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

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

RegionalSubscriptionOfferPhaseConfig

การกำหนดค่าสำหรับเฟสเดียวของข้อเสนอการสมัครใช้บริการในภูมิภาคเดียว

การแสดง JSON 
{
  "regionCode": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of mutually exclusive fields.
}
ช่อง
regionCode

string

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

object (Money)

ราคาแบบสัมบูรณ์ที่ผู้ใช้จ่ายสำหรับเฟสข้อเสนอนี้ ราคาต้องไม่ต่ำกว่าราคาต่ำสุดที่อนุญาตสำหรับภูมิภาคนี้
relativeDiscount

number

ส่วนลดเป็นเปอร์เซ็นต์ที่หักออกจากราคาแพ็กเกจเริ่มต้นตามสัดส่วนในช่วงระยะเวลาของเฟส โดยระบุเป็นเศษส่วนที่มากกว่า 0 และน้อยกว่า 1 อย่างเคร่งครัด ตัวอย่างเช่น ค่า 0.8 แสดงถึงส่วนลด 80% ซึ่งหมายความว่าหากราคาแพ็กเกจเริ่มต้นตามสัดส่วนคือ $100 ราคาข้อเสนอจะเป็น $20 ระบบจะปัดเศษราคาที่ได้เป็นหน่วยที่เรียกเก็บเงินได้ที่ใกล้เคียงที่สุด (เช่น เซนต์สำหรับสกุลเงิน USD) ระบบจะถือว่าส่วนลดแบบสัมพัทธ์ไม่ถูกต้องหากราคาที่ลดแล้วต่ำกว่าราคาต่ำสุดที่อนุญาตในภูมิภาคนี้
absoluteDiscount

object (Money)

จำนวนเงินสุทธิที่หักออกจากราคาแพ็กเกจเริ่มต้นตามสัดส่วนตลอดระยะเวลาของเฟส ตัวอย่างเช่น หากราคาแพ็กเกจเริ่มต้นสำหรับภูมิภาคนี้คือ $12 เป็นระยะเวลา 1 ปี ส่วนลดสุทธิ $1 สำหรับเฟสที่มีระยะเวลา 3 เดือนจะสอดคล้องกับราคา $2 ราคาที่ได้ต้องไม่ต่ำกว่าราคาต่ำสุดที่อนุญาตสำหรับภูมิภาคนี้
free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

ตั้งค่าเพื่อระบุว่าข้อเสนอนี้รับได้ฟรี
สิ้นสุดฟิลด์ที่แยกกัน

RegionalSubscriptionOfferPhaseFreePriceOverride

ประเภทนี้ไม่มีช่อง

แสดงการกำหนดค่าการลบล้างราคาฟรีสำหรับเฟสเดียวของข้อเสนอการสมัครใช้บริการ

OtherRegionsSubscriptionOfferPhaseConfig

การกำหนดค่าสำหรับสถานที่ตั้งใหม่ที่ Play อาจเปิดตัวในเฟสข้อเสนอเดียว

การแสดง JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of mutually exclusive fields.
}
ช่อง
การลบล้างราคาของระยะนี้ ต้องระบุ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

ราคาแบบสัมบูรณ์ที่ผู้ใช้จ่ายสำหรับเฟสข้อเสนอนี้ ราคาต้องไม่ต่ำกว่าราคาต่ำสุดที่อนุญาตสำหรับสถานที่ตั้งใหม่ที่ Google Play อาจเปิดตัว
relativeDiscount

number

ส่วนลดเป็นเปอร์เซ็นต์ที่หักออกจากราคาแพ็กเกจเริ่มต้นตามสัดส่วนในช่วงระยะเวลาของเฟส โดยระบุเป็นเศษส่วนที่มากกว่า 0 และน้อยกว่า 1 อย่างเคร่งครัด ตัวอย่างเช่น ค่า 0.8 แสดงถึงส่วนลด 80% ซึ่งหมายความว่าหากราคาแพ็กเกจเริ่มต้นตามสัดส่วนคือ $100 ราคาข้อเสนอจะเป็น $20 ระบบจะปัดเศษราคาที่ได้เป็นหน่วยที่เรียกเก็บเงินได้ที่ใกล้เคียงที่สุด (เช่น เซนต์สำหรับสกุลเงิน USD) ระบบจะถือว่าส่วนลดแบบสัมพัทธ์ไม่ถูกต้องหากราคาที่ลดแล้วต่ำกว่าราคาต่ำสุดที่อนุญาตในสถานที่ตั้งใหม่ที่ Google Play อาจเปิดตัว
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

จำนวนเงินสุทธิที่หักออกจากราคาแพ็กเกจเริ่มต้นตามสัดส่วนตลอดระยะเวลาของเฟส ตัวอย่างเช่น หากราคาแพ็กเกจเริ่มต้นสำหรับภูมิภาคนี้คือ $12 เป็นระยะเวลา 1 ปี ส่วนลดสุทธิ $1 สำหรับเฟสที่มีระยะเวลา 3 เดือนจะสอดคล้องกับราคา $2 ราคาที่ได้ต้องไม่ต่ำกว่าราคาต่ำสุดที่อนุญาตสำหรับสถานที่ตั้งใหม่ที่ Google Play อาจเปิดตัว
free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

ตั้งค่าเพื่อระบุว่าข้อเสนอนี้รับได้ฟรี
สิ้นสุดฟิลด์ที่แยกกัน

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

object (Money)

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

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

ประเภทนี้ไม่มีช่อง

แสดงการกำหนดค่าการลบล้างราคาฟรีสำหรับสถานที่ตั้งใหม่ที่ Play อาจเปิดตัวสำหรับเฟสข้อเสนอเดียว

SubscriptionOfferTargeting

กำหนดกฎที่ผู้ใช้ต้องปฏิบัติตามเพื่อรับข้อเสนอนี้

การแสดง JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of mutually exclusive fields.
}
ช่อง
เว้นว่างไว้สำหรับการมีสิทธิ์รับข้อเสนอที่นักพัฒนาแอปกำหนด ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
acquisitionRule

object (AcquisitionTargetingRule)

กฎการกำหนดเป้าหมายข้อเสนอสำหรับการได้ผู้ใช้ใหม่
upgradeRule

object (UpgradeTargetingRule)

กฎการกำหนดเป้าหมายข้อเสนอสำหรับการอัปเกรดแพ็กเกจที่มีอยู่ของผู้ใช้
สิ้นสุดฟิลด์ที่แยกกัน

AcquisitionTargetingRule

แสดงกฎการกำหนดเป้าหมายของแบบฟอร์ม: ผู้ใช้ไม่เคยมี {scope} มาก่อน

การแสดง JSON 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
ช่อง
scope

object (TargetingRuleScope)

ต้องระบุ ขอบเขตของการสมัครใช้บริการที่กฎนี้พิจารณา อนุญาตเฉพาะ "การสมัครใช้บริการนี้" และ "การสมัครใช้บริการใดๆ ในแอป"

TargetingRuleScope

กำหนดขอบเขตของการสมัครใช้บริการที่กฎการกำหนดเป้าหมายสามารถจับคู่เพื่อกำหนดเป้าหมายข้อเสนอไปยังผู้ใช้ตามสิทธิ์ในอดีตหรือปัจจุบัน

การแสดง JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of mutually exclusive fields.
}
ช่อง
ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
thisSubscription

object (TargetingRuleScopeThisSubscription)

ขอบเขตของกฎการกำหนดเป้าหมายปัจจุบันคือการสมัครใช้บริการที่มีการกำหนดข้อเสนอนี้
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

ขอบเขตของกฎการกำหนดเป้าหมายปัจจุบันคือการสมัครใช้บริการใดก็ได้ในแอปหลัก
specificSubscriptionInApp

string

ขอบเขตของกฎการกำหนดเป้าหมายปัจจุบันคือการสมัครใช้บริการที่มีรหัสการสมัครใช้บริการที่ระบุ ต้องเป็นการสมัครใช้บริการภายในแอปหลักเดียวกัน
สิ้นสุดฟิลด์ที่แยกกัน

TargetingRuleScopeThisSubscription

ประเภทนี้ไม่มีช่อง

แสดงขอบเขตของกฎการกำหนดเป้าหมายที่สอดคล้องกับการสมัครใช้บริการที่มีการกำหนดข้อเสนอนี้

TargetingRuleScopeAnySubscriptionInApp

ประเภทนี้ไม่มีช่อง

แสดงขอบเขตของกฎการกำหนดเป้าหมายที่สอดคล้องกับการสมัครใช้บริการใดๆ ในแอปหลัก

UpgradeTargetingRule

แสดงกฎการกำหนดเป้าหมายของแบบฟอร์ม: ปัจจุบันผู้ใช้มี {scope} [พร้อมช่วงเวลาที่เรียกเก็บเงิน {billingPeriod}]

การแสดง JSON 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
ช่อง
oncePerUser

boolean

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

object (TargetingRuleScope)

ต้องระบุ ขอบเขตของการสมัครใช้บริการที่กฎนี้พิจารณา อนุญาตเฉพาะ "การสมัครใช้บริการนี้" และ "การสมัครใช้บริการที่เฉพาะเจาะจงในแอป"
billingPeriodDuration

string

ระยะเวลาของช่วงเวลาที่เรียกเก็บเงินที่เฉพาะเจาะจงซึ่งระบุไว้ในรูปแบบ ISO 8601 ที่ผู้ใช้ต้องสมัครใช้บริการอยู่ในปัจจุบันจึงจะมีสิทธิ์ใช้กฎนี้ หากไม่ได้ระบุ ผู้ใช้ที่สมัครใช้บริการในช่วงเวลาที่เรียกเก็บเงินใดก็ได้จะมีคุณสมบัติตรงตามสิทธิ์

RegionalSubscriptionOfferConfig

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

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

string

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

boolean

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

OtherRegionsSubscriptionOfferConfig

การกำหนดค่าสำหรับสถานที่ตั้งใหม่ที่ Play อาจเปิดตัวซึ่งระบุไว้ในข้อเสนอการสมัครใช้บริการ

การแสดง JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
ช่อง
otherRegionsNewSubscriberAvailability

boolean

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

เมธอด

activate

 เปิดใช้งานข้อเสนอการสมัครใช้บริการ

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

 สร้างข้อเสนอการสมัครใช้บริการใหม่

deactivate

 ปิดใช้งานข้อเสนอการสมัครใช้บริการ

delete

 ลบข้อเสนอการสมัครใช้บริการ

get

 อ่านข้อเสนอเดียว

list

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

patch

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

รหัสข้อผิดพลาด

การดำเนินการของทรัพยากรนี้จะแสดงรหัสข้อผิดพลาดของ HTTP ต่อไปนี้

รหัสข้อผิดพลาด เหตุผล คำอธิบาย ความละเอียด