REST Resource: monetization.subscriptions.basePlans.offers

Tài nguyên: SubscriptionOffer

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

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)
    }
  ]
}
Các 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.

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à gói 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. Có thể thay đổi bằng thao tác Kích hoạt và Huỷ kích hoạt. Lưu ý: Trạng thái của gói cơ bản sẽ thay thế trạng thái này. Vì vậy, bạn có thể không có đượ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 ưu đãi này dành cho gói thuê bao. Phải chứa ít nhất một mục nhập và có thể chứa tối đa năm mục nhập. Người dùng sẽ luôn nhận được tất cả các giai đoạn này theo thứ tự đã chỉ định. Không được thêm, xoá hoặc sắp xếp lại các 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ả về một ưu đãi hay không. Nhà phát triển có thể tự lọc thêm các ưu đãi này.

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ể phát hành 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. Thẻ này sẽ được 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 ưu đãi cho gói thuê bao.

Enum
STATE_UNSPECIFIED Không bao giờ nên sử dụng giá trị mặc định.
DRAFT Ưu đãi cho gói thuê bao hiện chưa và chưa bao giờ được cung cấp cho người dùng.
ACTIVE Ưu đãi 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 gói thuê bao 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 duy nhất của ưu đãi cho gói thuê bao.

Biểu diễn dưới dạng JSON
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Các 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 lượng lặp lại một lần của giai đoạn này. Được chỉ định ở đị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 từng khu vực mà ưu đãi gói thuê bao có cấu hình 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 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.
}
Các 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 nhóm 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 đây:
price

object (Money)

Mức 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 đố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ệ so với thời hạn của giai đoạn mà người dùng trả trong 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á là 1,5 USD. Chiết khấu phải được chỉ định là phân số lớn hơn 0 và nhỏ hơn 1. Giá thu được sẽ được làm tròn đến đơn vị có thể lập hoá đơn gần nhất (ví dụ: xu cho USD). 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 ở khu vực này.

absoluteDiscount

object (Money)

Số tiền tuyệt đối trừ đi giá gói cơ bản theo tỷ lệ so với 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 ở 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 giá 2 USD. Giá thu được không được nhỏ hơn giá tối thiểu được phép đối với khu vực này.

free

object

Đặt để nêu rõ rằng bạn được nhận ưu đãi này miễn phí.

OtherRegionsSubscriptionOfferPhaseConfig

Cấu hình cho mọi vị trí mới mà Play có thể khởi chạy 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.
}
Các trường
Trường nhóm 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 đây:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Mức 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 mức giá tối thiểu cho 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ệ so với thời hạn của giai đoạn mà người dùng trả trong 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á là 1,5 USD. Chiết khấu phải được chỉ định là phân số lớn hơn 0 và nhỏ hơn 1. Giá thu được sẽ được làm tròn đến đơn vị có thể lập hoá đơn gần nhất (ví dụ: xu cho USD). 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 mức 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 trừ đi giá gói cơ bản theo tỷ lệ so với 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 ở 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 giá 2 USD. Mức giá thu được không được thấp hơn mức giá tối thiểu cho phép ở bất kỳ vị trí mới nào mà Play có thể ra mắt.

free

object

Đặt để nêu rõ rằng bạn được nhận ưu đãi này miễn phí.

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)
  }
}
Các trường
usdPrice

object (Money)

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

eurPrice

object (Money)

Bắt buộc. Giá tính bằng EUR để sử dụng ở 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.
}
Các trường
Trường nhóm rule. Để trống mục đ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 đây:
acquisitionRule

object (AcquisitionTargetingRule)

Quy tắc nhắm mục tiêu của lời đề nghị đối với hoạt động thu nạp người dùng mới.

upgradeRule

object (UpgradeTargetingRule)

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

AcquisitionTargetingRule

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

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

object (TargetingRuleScope)

Bắt buộc. Phạm vi của gói thuê bao mà quy tắc này sẽ 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 mục tiêu ưu đãi đến người dùng dựa trên quyền trong quá khứ 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
  },
  "anySubscriptionInApp": {
    object
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
Các trường

Trường nhóm scope.

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

thisSubscription

object

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

anySubscriptionInApp

object

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ẹ.

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
}
Các trường
oncePerUser

boolean

Ưu đãi này chỉ áp dụng một lần cho mỗi người dùng. 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 lại ưu đãi này 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 sẽ 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 bạn không chỉ định, hệ thống sẽ so khớp người dùng đã đăng ký với một kỳ thanh toán bất kỳ.

RegionalSubscriptionOfferConfig

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

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

string

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

newSubscriberAvailability

boolean

Liệu chương trình ưu đãi cho gói thuê bao trong khu vực đã chỉ định có dành cho người đăng ký mới 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 bạn không chỉ định thì 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 được chỉ định trong một ưu đãi đăng ký.

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

boolean

Liệu ưu đãi thuê bao ở bất kỳ vị trí mới nào mà Play có thể ra mắt trong tương lai. Nếu bạn không chỉ định thì 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 cho gói thuê bao.

batchUpdateStates

Cập nhật một loạt trạng thái ưu đãi của 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á gói thuê bao ưu đãi.

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 hiện có cho gói thuê bao.