REST Resource: monetization.subscriptions.basePlans.offers

Tài nguyên: SubscriptionOffer

Một ưu đãi 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)
    }
  ]
}
Trường
packageName

string

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

string

Bắt buộc. Không thể thay đổi. Mã của gói thuê bao chính mà ưu đãi này thuộc về.
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 mở rộng.
offerId

string

Bắt buộc. Không thể thay đổi. Mã nhận dạng duy nhất của ưu đã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 cách sử dụ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, ưu đãi đang hoạt động có thể không dùng được 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 gói thuê bao này. Phải chứa ít nhất một và tối đa hai mục. 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.
targeting

object (SubscriptionOfferTargeting)

Các yêu cầu mà người dùng cần đáp ứng để đủ điều kiện nhận ưu đãi này. Đại diện cho 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 chứa ít nhất một mục.
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 và được trả về ứng dụng thông qua Thư viện Billing.

Tiểu bang

Trạng thái hiện tại của ưu đãi gói thuê bao.

Enum
STATE_UNSPECIFIED Giá trị mặc định, không bao giờ được sử dụng.
DRAFT Ưu đãi của gói thuê bao hiện không và chưa từng được cung cấp cho người dùng.
ACTIVE Ưu đãi gói thuê bao dành 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 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 lặp lại giai đoạn này. Nếu giai đoạn ưu đãi này không miễn phí, thì mỗi lần định kỳ, người dùng sẽ phải trả giá của giai đoạn ưu đãi này.
duration

string

Bắt buộc. Thời lượng của một lần lặp lại 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 địa điểm 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 ưu đãi gói thuê bao ở một khu vực duy nhất.

Biểu diễn dưới dạng 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.
}
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.
Giá ghi đè của giai đoạn này. Bắt buộc. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
price

object (Money)

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

number

Tỷ lệ phần trăm chiết khấu được trừ vào giá gói cơ bản theo tỷ lệ trong suốt thời gian của giai đoạn, được chỉ định dưới dạng phân số lớn hơn 0 và nhỏ hơn 1. Ví dụ: giá trị 0.8 thể hiện mức chiết khấu 80%, nghĩa là nếu giá gói cơ bản theo tỷ lệ là 100 USD, thì giá ưu đãi sẽ là 20 USD. Giá thu được sẽ được làm tròn đến đơn vị thanh toán gần nhất (ví dụ: xu đối với USD). Mức chiết khấu tương đối được coi là không hợp lệ nếu giá sau 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 được trừ vào giá của gói cơ bản, được tính theo tỷ lệ trong suốt thời gian của giai đoạn ưu đãi. Ví dụ: nếu giá của gói cơ bản cho khu vực này là 12 USD trong thời hạn 1 năm, thì số tiền chiết khấu tuyệt đối là 1 USD cho một giai đoạn có thời hạn 3 tháng sẽ tương ứng với mức giá là 2 USD. Giá sau khi chuyển đổi không được thấp hơn mức giá tối thiểu được phép cho khu vực này.
free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

Đặt để chỉ định rằng ưu đãi này được cung cấp miễn phí.
Kết thúc các trường loại trừ lẫn nhau.

RegionalSubscriptionOfferPhaseFreePriceOverride

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

Biểu thị cấu hình ghi đè giá miễn phí cho một giai đoạn của ưu đãi gói thuê bao

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 
{

  // 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.
}
Trường
Giá ghi đè của giai đoạn này. Bắt buộc. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

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

number

Tỷ lệ phần trăm chiết khấu được trừ vào giá gói cơ bản theo tỷ lệ trong suốt thời gian của giai đoạn, được chỉ định dưới dạng phân số lớn hơn 0 và nhỏ hơn 1. Ví dụ: giá trị 0.8 thể hiện mức chiết khấu 80%, nghĩa là nếu giá gói cơ bản theo tỷ lệ là 100 USD, thì giá ưu đãi sẽ là 20 USD. Giá thu được sẽ được làm tròn đến đơn vị thanh toán gần nhất (ví dụ: xu đối với USD). Mức chiết khấu tương đối được coi là không hợp lệ nếu giá chiết khấu cuối cùng thấp hơn giá tối thiểu được cho phép ở bất kỳ địa điểm mới nào mà Play có thể ra mắt.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

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

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

Đặt để chỉ định rằng ưu đãi này được cung cấp miễn phí.
Kết thúc các trường loại trừ lẫn nhau.

OtherRegionsSubscriptionOfferPhasePrices

Thông tin về giá cho mọi địa điểm 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á (bằng USD) áp dụng cho mọi địa điểm mới mà Play có thể ra mắt.
eurPrice

object (Money)

Bắt buộc. Giá tính bằng EUR để áp dụng cho mọi địa điểm mới mà Play có thể ra mắt.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

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

Đại diện cho cấu hình ghi đè giá miễn phí cho mọi vị trí mới mà Play có thể ra mắt cho một giai đoạn ưu đãi.

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 
{

  // 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.
}
Trường
Để trống nếu muốn sử dụng điều kiện do nhà phát triển xác định. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
acquisitionRule

object (AcquisitionTargetingRule)

Quy tắc nhắm mục tiêu ưu đãi để thu nạp người dùng mới.
upgradeRule

object (UpgradeTargetingRule)

Quy tắc nhắm mục tiêu ưu đãi để nâng cấp gói hiện có của người dùng.
Kết thúc các trường loại trừ lẫn nhau.

AcquisitionTargetingRule

Đại diện cho một 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} trước đây.

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ể so khớp để nhắm ưu đãi đến người dùng dựa trên quyền hưởng trước đây hoặc hiện tại.

Biểu diễn dưới dạng 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.
}
Trường
Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
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à mọi gói thuê bao 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ã gói thuê bao được chỉ định. Phải là một gói thuê bao trong cùng một ứng dụng mẹ.
Kết thúc các trường loại trừ lẫn nhau.

TargetingRuleScopeThisSubscription

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

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

TargetingRuleScopeAnySubscriptionInApp

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

Đạ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 một quy tắc nhắm mục tiêu có dạng: Người dùng hiện có {scope} [với kỳ thanh toán {billingPeriod}].

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

boolean

Giới hạn ưu đãi này chỉ một lần cho mỗi người dùng. Nếu bạn đặt 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ọ đã từng đă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 lượng cụ thể của kỳ thanh toán (được chỉ định theo định dạng ISO 8601) mà người dùng phải đăng ký để đủ điều kiện áp dụng quy tắc này. Nếu bạn không chỉ định, người dùng đăng ký kỳ thanh toán nào cũng đủ điều kiện.

RegionalSubscriptionOfferConfig

Cấu hình cho một ưu đãi của gó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ã vùng mà cấu hình này áp dụng, theo quy định của ISO 3166-2, ví dụ: "US".
newSubscriberAvailability

boolean

Liệu ưu đãi của gói thuê bao ở khu vực được chỉ định có dành cho người đăng ký mới hay không. Gói thuê bao của người đăng ký hiện tại sẽ không bị huỷ nếu bạn đặt giá trị này 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 địa điểm mới mà Play có thể ra mắt, được chỉ định trong một ưu đãi của gói thuê bao.

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

boolean

Liệu ưu đãi của gói thuê bao có được cung cấp ở 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 của gói thuê bao.

batchGet

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

batchUpdate

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

deactivate

 Huỷ kích hoạt ưu đãi của gói thuê bao.

delete

 Xoá ưu đãi của gói thuê bao.

get

 Đọc một sản phẩm duy nhất

list

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

patch

 Cập nhật ưu đãi của gói thuê bao hiện có.

Mã lỗi

Các thao tác của tài nguyên này trả về các mã lỗi HTTP sau:

Mã lỗi Lý do Mô tả Độ phân giải