REST Resource: monetization.subscriptions

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

Một gói thuê bao cho ứ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)
  }
}
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. Duy nhất trong ứng dụng gốc. Mã sản phẩm phải bao gồm chữ thường (a-z), số (0-9), dấu gạch dưới (_) và dấu chấm (.). Mã này phải bắt đầu bằng chữ cái viết thường hoặc số và có độ dài từ 1 đến 40 ký tự (bao gồm).

basePlans[]

object (BasePlan)

Bộ gói cơ bản của gói thuê bao này. Đại diện cho 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 trang thông tin đã bản địa hoá cho gói thuê bao này. Phải chứa í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ợ lưu trữ gói thuê bao.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

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

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)
  }
  // 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ủ tiêu chuẩn RFC-1034. Tức là mã nhận dạng này chỉ được chứa chữ cái viết thường (a-z), chữ số (0-9) và dấu gạch nối (-), đồng thời 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 nháp và không hoạt động. Các gói cơ bản đang hoạt động có thể chuyển sang trạng thái không hoạt động. Các gói cơ bản không hoạt động có thể bị huỷ. 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 biệt.

regionalConfigs[]

object (RegionalBasePlanConfig)

Thông tin theo khu vực cụ thể về gói cơ bản này.

offerTags[]

object (OfferTag)

Danh sách tối đa 20 thẻ tuỳ chỉnh được chỉ định cho gói cơ bản này rồi trả về ứng dụng thông qua thư viện thanh toán. Ưu đãi thuê bao cho gói cơ bản này cũng sẽ nhận được các 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 cung cấp ở bất kỳ vị trí mới nào mà Play có thể ra mắt trong tương lai.

Trường hợp base_plan_type. Loại của gói cơ bản này. Bạn phải đặt chính xác một thuộc tính. base_plan_type chỉ có thể là một trong những trạng thái sau:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Thiết lập thời điểm gói cơ bản tự động gia hạn theo định kỳ.

prepaidBasePlanType

object (PrepaidBasePlanType)

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

Tiểu bang

Tình trạng 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ể xoá dữ liệu đó một cách an toàn tại thời điểm này.
ACTIVE Gói cơ bản đang hoạt động và được cung cấp cho người đăng ký mới.
INACTIVE Gói cơ bản hiện không hoạt động và chỉ dành cho những người đăng ký hiện tại.

AutoRenewingBasePlanType

Biểu thị một gói cơ bản tự động gia hạn khi gói thuê bao kết thúc.

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. Kỳ hạn của gói thuê bao, được chỉ định theo đị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.

gracePeriodDuration

string

Thời gian ân hạn của gói thuê bao, được chỉ định theo định dạng ISO 8601. Các giá trị được chấp nhận là P0D (0 ngày), P3D (3 ngày), P7D (7 ngày), P14D (14 ngày) và P30D (30 ngày). Nếu bạn không chỉ định thì hệ thống sẽ sử dụng giá trị mặc định dựa trên khoảng thời gian định kỳ.

accountHoldDuration

string

Không bắt buộc. Thời gian tạm ngưng tài khoản của gói thuê bao, được chỉ định theo định dạng ISO 8601. Giá trị được chấp nhận phải tính bằng DAYS và trong khoảng từ P0D (0 ngày) đến P30D (30 ngày). Nếu không được chỉ định, giá trị mặc định sẽ là P30D (30 ngày).

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. Giá trị mặc định là REsubscribe_STATE_ACTIVE nếu không được chỉ định.

prorationMode

enum (SubscriptionProrationMode)

Chế độ chia theo tỷ lệ cho gói cơ bản sẽ xác định điều gì sẽ 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 không chỉ định, giá trị mặc định sẽ là Charge_ON_NEXT_BILLING_DATE.

legacyCompatible

boolean

Liệu 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 một gói thuê bao cụ thể.

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 của gói thuê bao là tương thích với phiên bản cũ đối với một gói cơ bản gia hạn cụ thể.

Để không có ưu đãi Gói thuê bao nào tương thích với phiên bản 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ế độ chia theo tỷ lệ dùng để gia hạn gói cơ bản.

Enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Chế độ chưa chỉ định.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Người dùng sẽ trả phí cho gói cơ bản mới khi kỳ thanh toán hiện tại kết thúc.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Người dùng sẽ bị tính phí đầy đủ cho gói cơ bản mới ngay lập tức. Thời hạn còn lại của gói thuê bao hiện tại sẽ được dùng để gia hạn gói thanh toán mới.

PrepaidBasePlanType

Biểu thị một gói cơ bản không tự động gia hạn khi gói cơ bản kết thúc và phải được người dùng 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. Kỳ hạn của gói thuê bao, được chỉ định theo đị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.

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 không được chỉ định.

TimeExtension

Thời gian gia hạn của gói cơ bản.

Enum
TIME_EXTENSION_UNSPECIFIED Trạng thái chưa xác định.
TIME_EXTENSION_ACTIVE Phần mở rộng về thời gian đang hoạt động. Người dùng được phép nạp tiền hoặc gia hạn gói trả trước.
TIME_EXTENSION_INACTIVE Phần mở rộng về 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.

RegionalBasePlanConfig

Cấu hình cho 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ã 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 gói cơ bản 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 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.

price

object (Money)

Giá của gói cơ bản ở khu vực đã chỉ định. Bạn phải đặt thuộc tính này nếu gói cơ bản được cung cấp cho người đăng ký mới. Bạn phải đặt đơn vị tiền tệ 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á 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.

newSubscriberAvailability

boolean

Liệu gói cơ bản có được cung cấp cho người đăng ký mới ở bất kỳ vị trí mới nào mà Play có thể ra mắt hay không. Nếu không được 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 nhìn thấy trong 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ữ trên 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ữ trên trang thông tin này. Văn bản thuần tuý.

benefits[]

string

Danh sách 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 tối đa 4 lợi ích theo thứ tự.

description

string

Nội dung mô tả về gói thuê bao này bằng ngôn ngữ trên 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ợ 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 gói thuê bao mới.

delete

Xoá gói thuê bao.

get

Chỉ đọc một gói thuê bao.

list

Liệt kê tất cả các gói thuê bao trong một ứng dụng cụ thể.

patch

Cập nhật gói thuê bao hiện tại.