REST Resource: monetization.subscriptions.basePlans.offers

Tài nguyên: SubscriptionOffer

Một ưu đãi tạm thời duy nhất

Biểu diễn dưới dạng 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)
    }
  ]
}
Trường
packageName

string

Bắt buộc. Không thể thay đổi. Tên gói của ứng dụng chứa gói thuê bao gốc.
productId

string

Bắt buộc. Không thể thay đổi. Mã của gói thuê bao chính chứa ưu đãi này.
basePlanId

string

Bắt buộc. Không thể thay đổi. Mã của gói cơ bản mà ưu đãi này là một phần gia hạn.
offerId

string

Bắt buộc. Không thể thay đổi. Mã nhận dạng duy nhất của ưu đãi cho gói thuê bao này. Phải là duy nhất trong gói cơ bản.
state

enum (State)

Chỉ có đầu ra. Trạng thái hiện tại của ưu đãi này. Bạn có thể thay đổi bằng các thao tác Kích hoạt và Huỷ kích hoạt. Lưu ý: Trạng thái gói cơ bản sẽ thay thế trạng thái này, vì vậy, bạn có thể không dùng được ưu đãi đang hoạt động nếu gói cơ bản không hoạt động.
phases[]

object (SubscriptionOfferPhase)

Bắt buộc. Các giai đoạn của dịch vụ thuê bao này. Phải chứa ít nhất một mục và có thể chứa tối đa năm mục. Người dùng sẽ luôn nhận được tất cả giai đoạn này theo thứ tự đã chỉ định. Bạn không thể thêm, xoá hoặc sắp xếp lại thứ tự giai đoạn sau lần tạo đầu tiên.
targeting

object (SubscriptionOfferTargeting)

Những yêu cầu mà người dùng cần đáp ứng để đủ điều kiện nhận ưu đãi này. Thể hiện các yêu cầu mà Play sẽ đánh giá để quyết định xem có nên trả lại ưu đãi hay không. Nhà phát triển có thể tự lọc các ưu đãi này thêm.
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

Bắt buộc. Cấu hình theo khu vực cụ thể của ưu đãi này. Phải có ít nhất một mục nhập.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Cấu hình cho mọi vị trí mới mà Play có thể ra mắt trong tương lai.
offerTags[]

object (OfferTag)

Danh sách tối đa 20 thẻ tuỳ chỉnh được chỉ định cho ưu đãi này rồi trả về ứng dụng thông qua thư viện thanh toán.

Tiểu bang

Trạng thái hiện tại của dịch vụ thuê bao.

Enum
STATE_UNSPECIFIED Không bao giờ sử dụng giá trị mặc định.
DRAFT Ưu đãi này chưa áp dụng và chưa bao giờ áp dụng cho người dùng.
ACTIVE Ưu đãi thuê bao này áp dụng cho cả người dùng mới và người dùng hiện tại.
INACTIVE Ưu đãi thuê bao này không dành cho người dùng mới. Người dùng hiện tại vẫn có quyền truy cập.

SubscriptionOfferPhase

Một giai đoạn của ưu đãi gói thuê bao.

Biểu diễn dưới dạng JSON 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Trường
recurrenceCount

integer

Bắt buộc. Số lần giai đoạn này lặp lại. Nếu giai đoạn ưu đãi này không miễn phí, mỗi lần lặp lại sẽ tính phí người dùng theo giá của giai đoạn ưu đãi này.
duration

string

Bắt buộc. Thời gian lặp lại một lần của giai đoạn này. Được chỉ định theo định dạng ISO 8601.
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Bắt buộc. Cấu hình theo khu vực cụ thể của giai đoạn ưu đãi này. Danh sách này phải chứa đúng một mục nhập cho mỗi khu vực mà ưu đãi thuê bao có cấu hình theo khu vực.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Thông tin về giá cho mọi vị trí mới mà Play có thể ra mắt.

RegionalSubscriptionOfferPhaseConfig

Cấu hình cho một giai đoạn duy nhất của gói thuê bao ở một khu vực.

Biểu diễn dưới dạng 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.
}
Trường
regionCode

string

Bắt buộc. Không thể thay đổi. Khu vực áp dụng cấu hình này.
Trường hợp price_override. Cơ chế ghi đè giá của giai đoạn này. Bắt buộc. price_override chỉ có thể là một trong những trạng thái sau:
price

object (Money)

Giá tuyệt đối mà người dùng phải trả trong giai đoạn ưu đãi này. Giá không được nhỏ hơn giá tối thiểu cho phép đối với khu vực này.
relativeDiscount

number

Tỷ lệ phần trăm giá của gói cơ bản được chia theo tỷ lệ theo thời hạn của giai đoạn mà người dùng thanh toán cho giai đoạn ưu đãi này. Ví dụ: Nếu giá gói cơ bản của khu vực này là 12 USD cho kỳ hạn 1 năm, thì mức chiết khấu 50% cho giai đoạn 3 tháng sẽ tương ứng với mức giá 1, 5 USD. Bạn phải chỉ định mức chiết khấu dưới dạng phân số lớn hơn 0 và hoàn toàn nhỏ hơn 1. Giá thu được sẽ được làm tròn đến đơn vị gần nhất có thể tính phí (ví dụ: xu đối với đô la Mỹ). Mức chiết khấu tương đối bị coi là không hợp lệ nếu giá chiết khấu thấp hơn giá tối thiểu được phép tại khu vực này.
absoluteDiscount

object (Money)

Số tiền tuyệt đối bị trừ vào giá gói cơ bản theo tỷ lệ theo thời hạn mà người dùng thanh toán cho giai đoạn ưu đãi này. Ví dụ: Nếu giá gói cơ bản của khu vực này là 12 USD cho kỳ hạn 1 năm, thì mức chiết khấu tuyệt đối 1 USD cho giai đoạn 3 tháng sẽ tương ứng với mức giá 2 USD. Giá kết quả không được nhỏ hơn giá tối thiểu được phép áp dụng cho khu vực này.
free

object

Đặt để chỉ định ưu đãi này miễn phí nhận.

OtherRegionsSubscriptionOfferPhaseConfig

Cấu hình cho mọi vị trí mới mà Play có thể ra mắt trong một giai đoạn ưu đãi.

Biểu diễn dưới dạng 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.
}
Trường
Trường hợp price_override. Cơ chế ghi đè giá của giai đoạn này. Bắt buộc. price_override chỉ có thể là một trong những trạng thái sau:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Giá tuyệt đối mà người dùng phải trả trong giai đoạn ưu đãi này. Giá không được nhỏ hơn giá tối thiểu được phép ở bất kỳ vị trí mới nào mà Play có thể ra mắt.
relativeDiscount

number

Tỷ lệ phần trăm giá của gói cơ bản được chia theo tỷ lệ theo thời hạn của giai đoạn mà người dùng thanh toán cho giai đoạn ưu đãi này. Ví dụ: Nếu giá gói cơ bản của khu vực này là 12 USD cho kỳ hạn 1 năm, thì mức chiết khấu 50% cho giai đoạn 3 tháng sẽ tương ứng với mức giá 1, 5 USD. Bạn phải chỉ định mức chiết khấu dưới dạng phân số lớn hơn 0 và hoàn toàn nhỏ hơn 1. Giá thu được sẽ được làm tròn đến đơn vị gần nhất có thể tính phí (ví dụ: xu đối với đô la Mỹ). Mức chiết khấu tương đối bị coi là không hợp lệ nếu giá chiết khấu thấp hơn giá tối thiểu được phép ở mọi vị trí mới mà Play có thể ra mắt.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Số tiền tuyệt đối bị trừ vào giá gói cơ bản theo tỷ lệ theo thời hạn mà người dùng thanh toán cho giai đoạn ưu đãi này. Ví dụ: Nếu giá gói cơ bản của khu vực này là 12 USD cho kỳ hạn 1 năm, thì mức chiết khấu tuyệt đối 1 USD cho giai đoạn 3 tháng sẽ tương ứng với mức giá 2 USD. Giá ban đầu không được nhỏ hơn giá tối thiểu được phép ở bất kỳ vị trí mới nào mà Play có thể ra mắt.
free

object

Đặt để chỉ định ưu đãi này miễn phí nhận.

OtherRegionsSubscriptionOfferPhasePrices

Thông tin về giá cho mọi vị trí mới mà Play có thể ra mắt.

Biểu diễn dưới dạng JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
Trường
usdPrice

object (Money)

Bắt buộc. Giá tính theo USD để dùng cho mọi vị trí mới mà Play có thể ra mắt.
eurPrice

object (Money)

Bắt buộc. Giá tính theo euro để dùng cho mọi vị trí mới mà Play có thể ra mắt.

SubscriptionOfferTargeting

Xác định quy tắc mà người dùng cần đáp ứng để nhận được ưu đãi này.

Biểu diễn dưới dạng 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.
}
Trường
Trường hợp rule. Để trống đối với trường hợp đủ điều kiện hưởng ưu đãi do nhà phát triển xác định. rule chỉ có thể là một trong những trạng thái sau:
acquisitionRule

object (AcquisitionTargetingRule)

Cung cấp quy tắc nhắm mục tiêu cho hoạt động thu nạp người dùng mới.
upgradeRule

object (UpgradeTargetingRule)

Cung cấp quy tắc nhắm mục tiêu để nâng cấp gói hiện có của người dùng.

AcquisitionTargetingRule

Đại diện cho quy tắc nhắm mục tiêu của biểu mẫu: Người dùng chưa từng có {scope}.

Biểu diễn dưới dạng JSON 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
Trường
scope

object (TargetingRuleScope)

Bắt buộc. Phạm vi của gói thuê bao mà quy tắc này xem xét. Chỉ cho phép "gói thuê bao này" và "bất kỳ gói thuê bao nào trong ứng dụng".

TargetingRuleScope

Xác định phạm vi của gói thuê bao mà quy tắc nhắm mục tiêu có thể khớp để nhắm đến ưu đãi cho người dùng dựa trên quyền trước đây hoặc hiện tại.

Biểu diễn dưới dạng 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.
}
Trường

Trường hợp scope.

scope chỉ có thể là một trong những trạng thái sau:
thisSubscription

object (TargetingRuleScopeThisSubscription)

Phạm vi của quy tắc nhắm mục tiêu hiện tại là gói thuê bao mà ưu đãi này được xác định.
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

Phạm vi của quy tắc nhắm mục tiêu hiện tại là bất kỳ gói thuê bao nào trong ứng dụng mẹ.
specificSubscriptionInApp

string

Phạm vi của quy tắc nhắm mục tiêu hiện tại là gói thuê bao có mã nhận dạng gói thuê bao được chỉ định. Phải là gói thuê bao trong cùng một ứng dụng mẹ.

TargetingRuleScopeThisSubscription

Loại này không có trường.

Đại diện cho phạm vi quy tắc nhắm mục tiêu tương ứng với các đăng ký mà ưu đãi này được xác định.

TargetingRuleScopeAnySubscriptionInApp

Loại này không có trường.

Đại diện cho phạm vi quy tắc nhắm mục tiêu tương ứng với bất kỳ gói thuê bao nào trong ứng dụng mẹ.

UpgradeTargetingRule

Đại diện cho quy tắc nhắm mục tiêu của biểu mẫu: Người dùng hiện có {scope} [với kỳ thanh toán {billing_period}].

Biểu diễn dưới dạng JSON 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
Trường
oncePerUser

boolean

Mỗi người dùng chỉ được nhận ưu đãi một lần. Nếu bạn đặt chính sách này thành true, thì người dùng sẽ không bao giờ đủ điều kiện nhận ưu đãi này nữa nếu họ đã đăng ký nhận ưu đãi này.
scope

object (TargetingRuleScope)

Bắt buộc. Phạm vi của gói thuê bao mà quy tắc này xem xét. Chỉ cho phép "gói thuê bao này" và "gói thuê bao cụ thể trong ứng dụng".
billingPeriodDuration

string

Thời hạn thanh toán cụ thể, được chỉ định theo định dạng ISO 8601, mà người dùng hiện phải đăng ký để đủ điều kiện áp dụng quy tắc này. Nếu không chỉ định, người dùng đã đăng ký bất kỳ kỳ thanh toán nào sẽ được so khớp.

RegionalSubscriptionOfferConfig

Cấu hình cho ưu đãi thuê bao ở một khu vực.

Biểu diễn dưới dạng JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
Trường
regionCode

string

Bắt buộc. Không thể thay đổi. Mã khu vực áp dụng cấu hình này, theo quy định trong ISO 3166-2, ví dụ: "US".
newSubscriberAvailability

boolean

Liệu người đăng ký mới có thể sử dụng ưu đãi thuê bao trong khu vực đã chỉ định hay không. Những người đăng ký hiện tại sẽ không bị huỷ gói thuê bao nếu giá trị này được đặt thành false. Nếu không được chỉ định, giá trị này sẽ mặc định là false.

OtherRegionsSubscriptionOfferConfig

Cấu hình cho mọi vị trí mới mà Play có thể khởi chạy ở nơi đã chỉ định trong một ưu đãi thuê bao.

Biểu diễn dưới dạng JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Trường
otherRegionsNewSubscriberAvailability

boolean

Liệu ưu đãi thuê bao này có xuất hiện ở bất kỳ vị trí mới nào mà Play có thể ra mắt trong tương lai hay không. Nếu không được chỉ định, giá trị này sẽ mặc định là false.

Phương thức

activate

 Kích hoạt ưu đãi cho gói thuê bao.

batchGet

 Đọc một hoặc nhiều ưu đãi thuê bao.

batchUpdate

 Cập nhật một loạt ưu đãi thuê bao.

batchUpdateStates

 Cập nhật một loạt trạng thái của ưu đãi cho gói thuê bao.

create

 Tạo một ưu đãi mới cho gói thuê bao.

deactivate

 Huỷ kích hoạt ưu đãi thuê bao.

delete

 Xoá ưu đãi cho gói thuê bao.

get

 Đọc một ưu đãi

list

 Liệt kê tất cả ưu đãi trong một gói thuê bao cụ thể.

patch

 Cập nhật một ưu đãi thuê bao hiện có.