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 mà gói thuê bao mẹ thuộc về.
productId

string

Bắt buộc. Không thể thay đổi. Mã của gói thuê bao mẹ 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à 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 gói thuê bao này. Phải là giá trị nhận dạng 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à Tắ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 được cung cấp 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 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.
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. Thể hiện các yêu cầu mà Play sẽ đánh giá để quyết định xem có trả về ư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ủa ưu đãi này. Phải chứa í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 mặt hàng này và đượ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 gói thuê bao.

Enum
STATE_UNSPECIFIED Giá trị mặc định, không được sử dụng.
DRAFT Ưu đãi gói thuê bao này không được cung cấp và chưa bao giờ được cung cấp cho người dùng.
ACTIVE Ưu đãi gói thuê bao này dành 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 giữ 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 lặp lại, người dùng sẽ phải trả phí theo 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 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 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 của ưu đã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 (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // 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 hợp nhất price_override. Giá ghi đè của giai đoạn này. Bắt buộc. price_override chỉ có thể là một trong những loại sau:
price

object (Money)

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 giá tối thiểu được phép cho khu vực này.
relativeDiscount

number

Phần giá của gói cơ bản được tính theo tỷ lệ trong thời gian của giai đoạn mà người dùng trả phí cho giai đoạn ưu đãi này. Ví dụ: nếu giá gói cơ bản cho khu vực này là 12 USD trong thời hạn 1 năm, thì mức chiết khấu 50% cho một giai đoạn có thời hạn 3 tháng sẽ tương ứng với giá 1, 5 USD. Mức chiết khấu phải được chỉ định dưới dạng phân số lớn hơn 0 và nhỏ hơn 1. Giá nhận được sẽ được làm tròn đến đơn vị tính tiề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 nhỏ 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á gói cơ bản theo tỷ lệ trong thời gian người dùng trả phí cho giai đoạn ưu đãi này. Ví dụ: nếu giá gói cơ bản cho khu vực này là 12 USD trong thời hạn 1 năm, thì mức giảm giá tuyệt đối 1 USD cho một giai đoạn có thời hạn 3 tháng sẽ tương ứng với giá 2 USD. Giá thu được không được thấp hơn 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 là miễn phí.

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 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 
{

  // 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.
}
Trường
Trường hợp hợp nhất price_override. Giá ghi đè của giai đoạn này. Bắt buộc. price_override chỉ có thể là một trong những loại sau:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

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 giá tối thiểu được phép tại bất kỳ vị trí mới nào mà Play có thể ra mắt.
relativeDiscount

number

Phần giá của gói cơ bản được tính theo tỷ lệ trong thời gian của giai đoạn mà người dùng trả phí cho giai đoạn ưu đãi này. Ví dụ: nếu giá gói cơ bản cho khu vực này là 12 USD trong thời hạn 1 năm, thì mức chiết khấu 50% cho một giai đoạn có thời hạn 3 tháng sẽ tương ứng với giá 1, 5 USD. Mức chiết khấu phải được chỉ định dưới dạng phân số lớn hơn 0 và nhỏ hơn 1. Giá nhận được sẽ được làm tròn đến đơn vị tính tiền gần nhất (ví dụ: xu đối với USD). 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 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.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Số tiền tuyệt đối được trừ vào giá gói cơ bản theo tỷ lệ trong thời gian người dùng trả phí cho giai đoạn ưu đãi này. Ví dụ: nếu giá gói cơ bản cho khu vực này là 12 USD trong thời hạn 1 năm, thì mức giảm giá tuyệt đối 1 USD cho một giai đoạn có thời hạn 3 tháng sẽ tương ứng với giá 2 USD. Giá sau khi điều chỉnh không được thấp hơn giá tối thiểu được phép tại 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 là 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)
  }
}
Trường
usdPrice

object (Money)

Bắt buộc. Giá tính theo USD để sử 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 bằng EUR để sử dụng cho mọi vị trí mới mà Play có thể ra mắt.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

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ọ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 
{

  // 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 hợp nhất rule. Để trống đối với điều kiện sử dụng ưu đãi do nhà phát triển xác định. rule chỉ có thể là một trong những loại sau:
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 tại của người dùng.

AcquisitionTargetingRule

Biểu thị một 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)
  }
}
Trường
scope

object (TargetingRuleScope)

Bắt buộc. Phạm vi của các 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 các gói thuê bao mà quy tắc nhắm mục tiêu có thể so khớp để nhắm mục tiêu ưu đãi cho 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 (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
Trường

Trường hợp hợp nhất scope.

scope chỉ có thể là một trong những loạ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à 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à gói thuê bao trong cùng một ứng dụng mẹ.

TargetingRuleScopeThisSubscription

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

Biểu thị 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.

Biểu thị 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

Biểu thị một quy tắc nhắm mục tiêu ở dạng: 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

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

object (TargetingRuleScope)

Bắt buộc. Phạm vi của các 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 ở định dạng ISO 8601, mà người dùng phải đang đă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 những người dùng đã đăng ký bất kỳ kỳ thanh toán nào.

RegionalSubscriptionOfferConfig

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

boolean

Liệu ưu đãi 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 bạn không chỉ định, giá trị mặc định sẽ là false.

OtherRegionsSubscriptionOfferConfig

Cấu hình cho mọi vị trí mới mà Play có thể ra mắt được chỉ định trên 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 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 bạn không chỉ định, giá trị mặc định sẽ là false.

Phương thức

activate

 Kích hoạt ưu đãi 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 gói thuê bao.

batchUpdateStates

 Cập nhật hàng loạt trạng thái ưu đãi gói thuê bao.

create

 Tạo ưu đãi thuê bao mới.

deactivate

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

delete

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

get

 Đọc một ưu đãi

list

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

patch

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