REST Resource: monetization.subscriptions.basePlans.offers

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

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

การแสดง 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 รายการและไม่เกิน 5 รายการ ผู้ใช้จะได้รับเฟสเหล่านี้ทั้งหมดตามลำดับที่ระบุเสมอ เพิ่ม นำออก หรือเรียงลำดับเฟสใหม่ไม่ได้หลังจากการสร้างครั้งแรก

targeting

object (SubscriptionOfferTargeting)

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

regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

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

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

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

offerTags[]

object (OfferTag)

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

รัฐ

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

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,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
ช่อง
regionCode

string

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

ฟิลด์การรวม price_override การปรับราคาสำหรับระยะนี้ ต้องระบุ price_override ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
price

object (Money)

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

relativeDiscount

number

เศษส่วนของราคาแพ็กเกจเริ่มต้นตามสัดส่วนของระยะเวลาที่ผู้ใช้จ่ายสำหรับระยะข้อเสนอนี้ เช่น หากราคาแพ็กเกจเริ่มต้นสําหรับภูมิภาคนี้คือ $12 สําหรับระยะเวลา 1 ปี ส่วนลด 50% สําหรับเฟส 3 เดือนจะเท่ากับราคา $1.50 ต้องระบุส่วนลดเป็นเศษส่วนที่มากกว่า 0 และเล็กกว่า 1 อย่างเคร่งครัด ราคาที่ได้จะได้รับการปัดเศษเป็นหน่วยที่เรียกเก็บเงินได้ที่ใกล้ที่สุด (เช่น หน่วยเซนต์สำหรับดอลลาร์สหรัฐ) ระบบจะถือว่าส่วนลดที่เกี่ยวข้องไม่ถูกต้องหากราคาลดต่ำกว่าราคาขั้นต่ำที่อนุญาตในภูมิภาคนี้

absoluteDiscount

object (Money)

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

free

object

ตั้งค่าเพื่อระบุว่าจะรับข้อเสนอนี้ได้ฟรี

OtherRegionsSubscriptionOfferPhaseConfig

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

การแสดง JSON
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
ช่อง
ฟิลด์การรวม price_override การปรับราคาสำหรับระยะนี้ ต้องระบุ price_override ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

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

relativeDiscount

number

เศษส่วนของราคาแพ็กเกจเริ่มต้นตามสัดส่วนของระยะเวลาที่ผู้ใช้จ่ายสำหรับระยะข้อเสนอนี้ เช่น หากราคาแพ็กเกจเริ่มต้นสําหรับภูมิภาคนี้คือ $12 สําหรับระยะเวลา 1 ปี ส่วนลด 50% สําหรับเฟส 3 เดือนจะเท่ากับราคา $1.50 ต้องระบุส่วนลดเป็นเศษส่วนที่มากกว่า 0 และเล็กกว่า 1 อย่างเคร่งครัด ราคาที่ได้จะได้รับการปัดเศษเป็นหน่วยที่เรียกเก็บเงินได้ที่ใกล้ที่สุด (เช่น หน่วยเซนต์สำหรับดอลลาร์สหรัฐ) ระบบจะถือว่าส่วนลดที่เกี่ยวข้องไม่ถูกต้องหากราคาลดต่ำกว่าราคาขั้นต่ำที่อนุญาตในประเทศใหม่ๆ ที่ Play อาจเปิดตัวส่วนลด

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

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

free

object

ตั้งค่าเพื่อระบุว่าจะรับข้อเสนอนี้ได้ฟรี

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

eurPrice

object (Money)

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

SubscriptionOfferTargeting

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

การแสดง JSON
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
ช่อง
ฟิลด์การรวม rule เว้นว่างไว้หากต้องการรับสิทธิ์รับข้อเสนอที่นักพัฒนาแอปกำหนด rule ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
acquisitionRule

object (AcquisitionTargetingRule)

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

upgradeRule

object (UpgradeTargetingRule)

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

AcquisitionTargetingRule

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

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

object (TargetingRuleScope)

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

TargetingRuleScope

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

การแสดง JSON
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object
  },
  "anySubscriptionInApp": {
    object
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
ช่อง

ฟิลด์การรวม scope

scope ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

thisSubscription

object

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

anySubscriptionInApp

object

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

specificSubscriptionInApp

string

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

UpgradeTargetingRule

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

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

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

OtherRegionsSubscriptionOfferConfig

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

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

boolean

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

วิธีการ

activate

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

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

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

deactivate

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

delete

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

get

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

list

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

patch

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