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

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

object (RegionalSubscriptionOfferPhaseConfig)

ต้องระบุ การกำหนดค่าเฉพาะภูมิภาคของเฟสข้อเสนอนี้ รายการนี้ต้องมีเพียง 1 รายการสำหรับแต่ละภูมิภาคที่ข้อเสนอการสมัครใช้บริการมีการกำหนดค่าระดับภูมิภาค
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 (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // 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 ระบบจะปัดเศษราคาที่ได้รับเป็นหน่วยที่เรียกเก็บเงินได้ที่ใกล้เคียงที่สุด (เช่น เซ็นต์สำหรับ USD) ระบบจะถือว่าส่วนลดที่เกี่ยวข้องไม่ถูกต้องหากราคาที่มีส่วนลดน้อยกว่าราคาต่ำสุดที่อนุญาตในภูมิภาคนี้
absoluteDiscount

object (Money)

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

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

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

RegionalSubscriptionOfferPhaseFreePriceOverride

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

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

OtherRegionsSubscriptionOfferPhaseConfig

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

การแสดง JSON 
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // 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 ระบบจะปัดเศษราคาที่ได้รับเป็นหน่วยที่เรียกเก็บเงินได้ที่ใกล้เคียงที่สุด (เช่น เซ็นต์สำหรับ USD) ระบบจะถือว่าส่วนลดที่เกี่ยวข้องเป็นราคาที่ไม่ถูกต้องหากราคาที่ลดแล้วมีมูลค่าน้อยกว่าราคาขั้นต่ำที่อนุญาตในประเทศใหม่ใดก็ตามที่ Play อาจเปิดตัว
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

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

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

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

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

object (Money)

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

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

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

แสดงการกำหนดค่าการลบล้างราคาฟรีสำหรับสถานที่ใหม่ที่ 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 (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
ช่อง

ช่องการรวม scope

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

object (TargetingRuleScopeThisSubscription)

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

object (TargetingRuleScopeAnySubscriptionInApp)

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

string

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

TargetingRuleScopeThisSubscription

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

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

TargetingRuleScopeAnySubscriptionInApp

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

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

UpgradeTargetingRule

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

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

boolean

จำกัดข้อเสนอนี้แค่ 1 ครั้งต่อผู้ใช้ 1 คน หากตั้งค่าเป็น "จริง" ผู้ใช้จะไม่มีสิทธิ์รับข้อเสนอนี้อีกหากสมัครใช้บริการข้อเสนอนี้
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

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