REST Resource: monetization.subscriptions

Tài nguyên: Gói thuê bao

Một gói thuê bao cho một ứng dụng.

Biểu diễn dưới dạng JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Trường
packageName

string

Không thể thay đổi. Tên gói của ứng dụng mẹ.
productId

string

Không thể thay đổi. Mã sản phẩm duy nhất của sản phẩm. Riêng biệt trong ứng dụng mẹ. Mã sản phẩm phải bao gồm chữ cái viết thường (a-z), chữ số (0-9), dấu gạch dưới (_) và dấu chấm (.). Mã sản phẩm phải bắt đầu bằng chữ cái viết thường hoặc chữ số, đồng thời có độ dài từ 1 đến 40 ký tự (bao gồm cả 1 và 40).
basePlans[]

object (BasePlan)

Tập hợp các gói cơ bản của gói thuê bao này. Thể hiện giá và thời hạn của gói thuê bao nếu không có ưu đãi nào khác được áp dụng.
listings[]

object (SubscriptionListing)

Bắt buộc. Danh sách các thông tin đăng tải được bản địa hoá cho gói thuê bao này. Phải có ít nhất một mục nhập cho ngôn ngữ mặc định của ứng dụng mẹ.
archived
(deprecated)

boolean

Chỉ có đầu ra. Không dùng nữa: không hỗ trợ tính năng lưu trữ gói thuê bao.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Thông tin chi tiết về thuế và việc tuân thủ pháp luật.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Không bắt buộc. Những quốc gia mà người dùng chỉ có thể mua gói thuê bao này bằng các phương thức thanh toán được đăng ký ở chính quốc gia đó. Nếu trống, sẽ không có quy định hạn chế nào về địa điểm thanh toán.

BasePlan

Một gói cơ bản cho một gói thuê bao.

Biểu diễn dưới dạng JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Trường
basePlanId

string

Bắt buộc. Không thể thay đổi. Giá trị nhận dạng duy nhất của gói cơ bản này. Phải là duy nhất trong gói thuê bao và tuân thủ RFC-1034. Tức là mã nhận dạng này chỉ có thể chứa chữ thường (a-z), chữ số (0-9) và dấu gạch nối (-) và dài tối đa 63 ký tự.
state

enum (State)

Chỉ có đầu ra. Trạng thái của gói cơ bản, tức là gói đó có đang hoạt động hay không. Bạn có thể kích hoạt hoặc xoá các gói cơ bản ở trạng thái bản nháp và không hoạt động. Bạn có thể chuyển gói cơ bản đang hoạt động sang trạng thái không hoạt động. Bạn có thể huỷ các gói cơ bản không hoạt động. Bạn không thể thay đổi trường này bằng cách cập nhật tài nguyên. Thay vào đó, hãy sử dụng các điểm cuối chuyên dụng.
regionalConfigs[]

object (RegionalBasePlanConfig)

Thông tin dành riêng cho khu vực của gói cơ bản này.
offerTags[]

object (OfferTag)

Danh sách gồm tối đa 20 thẻ tuỳ chỉnh được chỉ định cho gói cơ bản này và được trả về cho ứng dụng thông qua thư viện thanh toán. Các ưu đãi thuê bao cho gói cơ bản này cũng sẽ nhận được những thẻ ưu đãi này trong thư viện thanh toán.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Thông tin về giá cho mọi vị trí mới mà Play có thể ra mắt trong tương lai. Nếu bạn bỏ qua, BasePlan sẽ không tự động có sẵn ở bất kỳ vị trí mới nào mà Play có thể ra mắt trong tương lai.
Trường nhóm base_plan_type. Loại gói cơ bản này. Bạn phải đặt đúng một. Bạn không thể thay đổi loại gói cơ bản sau khi tạo gói cơ bản. base_plan_type chỉ có thể là một trong những trạng thái sau:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Đặt thời điểm gói cơ bản tự động gia hạn theo một khoảng thời gian đều đặn.
prepaidBasePlanType

object (PrepaidBasePlanType)

Đặt thời điểm gói cơ bản không tự động gia hạn khi kết thúc kỳ thanh toán.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Được đặt cho gói cơ bản trả góp, trong đó người dùng cam kết thanh toán một số lần cụ thể.

Tiểu bang

Trạng thái hiện tại của gói cơ bản.

Enum
STATE_UNSPECIFIED Trạng thái chưa xác định.
DRAFT Gói cơ bản hiện đang ở trạng thái bản nháp và chưa được kích hoạt. Bạn có thể yên tâm xoá tệp này tại thời điểm này.
ACTIVE Gói cơ bản đang hoạt động và người đăng ký mới có thể mua gói này.
INACTIVE Gói cơ bản không hoạt động và chỉ dành cho người đăng ký hiện tại.

AutoRenewingBasePlanType

Đại diện cho một gói cơ bản tự động gia hạn khi hết thời hạn thuê bao.

Biểu diễn dưới dạng JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Trường
billingPeriodDuration

string

Bắt buộc. Không thể thay đổi. Kỳ hạn của gói thuê bao được chỉ định ở định dạng ISO 8601. Để xem danh sách các kỳ thanh toán được chấp nhận, hãy tham khảo trung tâm trợ giúp. Thời hạn là cố định sau khi bạn tạo gói cơ bản.
gracePeriodDuration

string

Thời gian ân hạn của gói thuê bao, được chỉ định ở định dạng ISO 8601. Giá trị được chấp nhận phải tính bằng ngày và nằm trong khoảng từ P0D đến giá trị nhỏ hơn giữa 30D và khoảng thời gian thanh toán của gói cơ bản.

Nếu bạn không chỉ định, hệ thống sẽ sử dụng giá trị mặc định dựa trên kỳ thanh toán.

Tổng thời gian ân hạn và thời gian tạm ngưng tài khoản phải nằm trong khoảng từ P30D đến P60D.
accountHoldDuration

string

Không bắt buộc. Khoảng thời gian tạm ngưng tài khoản của gói thuê bao, được chỉ định ở định dạng ISO 8601. Giá trị được chấp nhận phải tính bằng ngày và nằm trong khoảng từ P0D đến P60D.

Nếu bạn không chỉ định, giá trị mặc định sẽ là P30D.

Tổng thời gian ân hạn và thời gian tạm ngưng tài khoản phải nằm trong khoảng từ P30D đến P60D.
resubscribeState

enum (ResubscribeState)

Người dùng có thể đăng ký lại gói cơ bản này trên các nền tảng của Google Play hay không. Mặc định là RESUBSCRIBE_STATE_ACTIVE nếu bạn không chỉ định.
prorationMode

enum (SubscriptionProrationMode)

Chế độ tính phí theo tỷ lệ cho gói cơ bản sẽ xác định điều gì xảy ra khi người dùng chuyển sang gói này từ một gói cơ bản khác. Nếu bạn không chỉ định, giá trị mặc định sẽ là CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Gói cơ bản gia hạn có tương thích ngược hay không.

Gói cơ bản tương thích ngược do phương thức querySkuDetailsAsync() trả về (Thư viện Google Play Billing không dùng phương thức này nữa).

Bạn chỉ có thể đánh dấu một gói cơ bản gia hạn là tương thích với phiên bản cũ cho một gói thuê bao nhất định.
legacyCompatibleSubscriptionOfferId

string

Mã ưu đãi của gói thuê bao tương thích với phiên bản cũ.

Ưu đãi thuê bao tương thích ngược do phương thức querySkuDetailsAsync() trả về (Thư viện Google Play Billing không dùng phương thức này nữa).

Bạn chỉ có thể đánh dấu một ưu đãi thuê bao là tương thích với phiên bản cũ cho một gói cơ bản gia hạn nhất định.

Để không có ưu đãi thuê bao nào tương thích với gói cũ, hãy đặt trường này thành chuỗi trống.

ResubscribeState

Trạng thái đăng ký lại gói cơ bản.

Enum
RESUBSCRIBE_STATE_UNSPECIFIED Trạng thái chưa xác định.
RESUBSCRIBE_STATE_ACTIVE Tính năng đăng ký lại đang hoạt động.
RESUBSCRIBE_STATE_INACTIVE Tính năng đăng ký lại không hoạt động.

SubscriptionProrationMode

Chế độ tính phí theo tỷ lệ được dùng để gia hạn gói cơ bản.

Enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Chế độ không xác định.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Người dùng sẽ thanh toán cho gói cơ bản mới vào cuối kỳ thanh toán hiện tại.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Người dùng sẽ thanh toán toàn bộ cho gói cơ bản mới ngay lập tức. Thời gian còn lại của gói thuê bao hiện tại sẽ được dùng để kéo dài thời hạn của gói thanh toán mới.

PrepaidBasePlanType

Đại diện cho một gói cơ bản không tự động gia hạn khi hết hạn và người dùng phải gia hạn theo cách thủ công.

Biểu diễn dưới dạng JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Trường
billingPeriodDuration

string

Bắt buộc. Không thể thay đổi. Kỳ hạn của gói thuê bao được chỉ định ở định dạng ISO 8601. Để xem danh sách các kỳ thanh toán được chấp nhận, hãy tham khảo trung tâm trợ giúp. Thời hạn là cố định sau khi bạn tạo gói cơ bản.
timeExtension

enum (TimeExtension)

Người dùng có thể gia hạn gói cơ bản trả trước này trên các nền tảng của Google Play hay không. Giá trị mặc định là TIME_EXTENSION_ACTIVE nếu bạn không chỉ định.

TimeExtension

Gia hạn thời gian sử dụng gói cơ bản.

Enum
TIME_EXTENSION_UNSPECIFIED Trạng thái chưa xác định.
TIME_EXTENSION_ACTIVE Đang trong thời gian gia hạn. Người dùng được phép nạp tiền hoặc gia hạn gói trả trước.
TIME_EXTENSION_INACTIVE Tính năng gia hạn thời gian không hoạt động. Người dùng không thể nạp tiền hoặc gia hạn gói trả trước.

InstallmentsBasePlanType

Thể hiện một gói cơ bản trả góp mà người dùng cam kết thanh toán một số lần cụ thể.

Biểu diễn dưới dạng JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Trường
billingPeriodDuration

string

Bắt buộc. Không thể thay đổi. Kỳ hạn của gói thuê bao được chỉ định ở định dạng ISO 8601. Để xem danh sách các kỳ thanh toán được chấp nhận, hãy tham khảo trung tâm trợ giúp. Thời hạn là cố định sau khi bạn tạo gói cơ bản.
committedPaymentsCount

integer

Bắt buộc. Không thể thay đổi. Số khoản thanh toán mà người dùng cam kết. Bạn không thể thay đổi gói này sau khi tạo gói cơ bản.
renewalType

enum (RenewalType)

Bắt buộc. Không thể thay đổi. Loại hình gia hạn gói cơ bản trả góp. Xác định hành vi khi hết thời hạn cam kết ban đầu. Bạn không thể thay đổi loại gia hạn sau khi tạo gói cơ bản.
gracePeriodDuration

string

Thời gian ân hạn của gói thuê bao, được chỉ định ở định dạng ISO 8601. Giá trị được chấp nhận phải tính bằng ngày và nằm trong khoảng từ P0D đến giá trị nhỏ hơn giữa 30D và khoảng thời gian thanh toán của gói cơ bản.

Nếu bạn không chỉ định, hệ thống sẽ sử dụng giá trị mặc định dựa trên kỳ thanh toán.

Tổng thời gian ân hạn và thời gian tạm ngưng tài khoản phải nằm trong khoảng từ P30D đến P60D.
accountHoldDuration

string

Không bắt buộc. Khoảng thời gian tạm ngưng tài khoản của gói thuê bao, được chỉ định ở định dạng ISO 8601. Giá trị được chấp nhận phải tính bằng ngày và nằm trong khoảng từ P0D đến P60D.

Nếu bạn không chỉ định, giá trị mặc định sẽ là P30D.

Tổng thời gian ân hạn và thời gian tạm ngưng tài khoản phải nằm trong khoảng từ P30D đến P60D.
resubscribeState

enum (ResubscribeState)

Người dùng có thể đăng ký lại gói cơ bản này trên các nền tảng của Google Play hay không. Mặc định là RESUBSCRIBE_STATE_ACTIVE nếu bạn không chỉ định.
prorationMode

enum (SubscriptionProrationMode)

Chế độ tính phí theo tỷ lệ cho gói cơ bản sẽ xác định điều gì xảy ra khi người dùng chuyển sang gói này từ một gói cơ bản khác. Nếu bạn không chỉ định, giá trị mặc định sẽ là CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Loại hình gia hạn gói cơ bản trả góp. Xác định hành vi khi hết thời hạn cam kết ban đầu. Bạn không thể thay đổi loại gia hạn sau khi tạo gói cơ bản.

Enum
RENEWAL_TYPE_UNSPECIFIED Trạng thái chưa xác định.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Gia hạn định kỳ trong thời gian của kỳ thanh toán mà không cần cam kết.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Gia hạn với cam kết có thời hạn tương tự như cam kết ban đầu.

RegionalBasePlanConfig

Cấu hình cho một gói cơ bản dành riêng cho một khu vực.

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

string

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

boolean

Gói cơ bản ở khu vực được chỉ định có áp dụng cho người đăng ký mới hay không. Nếu bạn đặt giá trị này thành false, thì gói thuê bao của người đăng ký hiện tại sẽ không bị huỷ. Nếu bạn không chỉ định, giá trị này sẽ mặc định là false.
price

object (Money)

Giá của gói cơ bản ở khu vực được chỉ định. Bạn phải đặt giá trị này nếu người đăng ký mới có thể sử dụng gói cơ bản. Bạn phải đặt đơn vị tiền tệ được liên kết với khu vực đã chỉ định.

OtherRegionsBasePlanConfig

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)
  },
  "newSubscriberAvailability": boolean
}
Trường
usdPrice

object (Money)

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

boolean

Liệu gói cơ bản có được cung cấp cho người đăng ký mới ở những vị trí mới mà Play có thể ra mắt hay không. Nếu bạn không chỉ định, giá trị này sẽ mặc định là false.

SubscriptionListing

Siêu dữ liệu mà người tiêu dùng có thể thấy của một gói thuê bao.

Biểu diễn dưới dạng JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Trường
languageCode

string

Bắt buộc. Ngôn ngữ của trang thông tin này, theo định nghĩa của BCP-47, ví dụ: "en-US".
title

string

Bắt buộc. Tiêu đề của gói thuê bao này bằng ngôn ngữ của trang thông tin này. Văn bản thuần tuý.
benefits[]

string

Danh sách các lợi ích mà người dùng thấy trên các nền tảng như Cửa hàng Play và trong quy trình khôi phục bằng ngôn ngữ của trang thông tin này. Văn bản thuần tuý. Danh sách có thứ tự gồm tối đa 4 lợi ích.
description

string

Nội dung mô tả về gói thuê bao này bằng ngôn ngữ của trang thông tin này. Độ dài tối đa – 80 ký tự. Văn bản thuần tuý.

Phương thức

archive
(deprecated)

 Không dùng nữa: không hỗ trợ tính năng lưu trữ gói thuê bao.

batchGet

 Đọc một hoặc nhiều gói thuê bao.

batchUpdate

 Cập nhật một loạt gói thuê bao.

create

 Tạo một gói thuê bao mới.

delete

 Xoá một gói thuê bao.

get

 Đọc một gói thuê bao.

list

 Liệt kê tất cả các gói thuê bao thuộc một ứng dụng nhất định.

patch

 Cập nhật một gói thuê bao hiện có.