REST Resource: monetization.subscriptions

리소스: 구독

앱의 단일 구독입니다.

JSON 표현 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
필드
packageName

string

변경할 수 없습니다. 상위 앱의 패키지 이름입니다.
productId

string

변경할 수 없습니다. 제품의 고유 제품 ID입니다. 상위 앱 내에서 고유해야 합니다. 제품 ID는 소문자 (a~z), 숫자 (0~9), 밑줄 (_), 점 (.)으로만 구성되어야 하며, 소문자 또는 숫자로 시작해야 하며 1~40자 (영문 기준) 사이여야 합니다.
basePlans[]

object (BasePlan)

이 정기 결제의 기본 요금제 집합입니다. 다른 혜택이 적용되지 않는 경우 정기 결제의 가격과 기간을 나타냅니다.
listings[]

object (SubscriptionListing)

필수 항목입니다. 이 정기 결제의 현지화된 등록정보 목록입니다. 상위 앱의 기본 언어 항목을 하나 이상 포함해야 합니다.
archived

boolean

출력 전용. 이 구독의 보관처리 여부입니다. 보관처리된 구독은 더 이상 구독자에게 제공되지 않으며, 업데이트할 수 없으며, 보관처리된 항목 표시가 전달되지 않는 한 목록 요청에 반환되지 않습니다.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

세금 및 법률 준수에 관한 세부정보

기본 요금제

정기 결제의 단일 기본 요금제입니다.

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.
}
필드
basePlanId

string

필수 항목입니다. 변경할 수 없습니다. 이 기본 요금제의 고유 식별자입니다. 구독 내에서 고유해야 하며 RFC-1034를 준수해야 합니다. 즉, 이 ID에는 소문자(a~z), 숫자(0~9), 하이픈(-)만 포함할 수 있으며 최대 63자(영문 기준)까지만 허용됩니다.
state

enum (State)

출력 전용. 기본 요금제의 상태(예: 활성 여부)입니다. 임시 및 비활성 기본 요금제는 활성화하거나 삭제할 수 있습니다. 활성 기본 요금제를 비활성화할 수 있습니다. 비활성 기본 요금제는 취소할 수 있습니다. 리소스를 업데이트하여 이 필드를 변경할 수 없습니다. 대신 전용 엔드포인트를 사용하세요.
regionalConfigs[]

object (RegionalBasePlanConfig)

이 기본 요금제에 대한 지역별 정보
offerTags[]

object (OfferTag)

이 기본 요금제에 지정된 최대 20개의 맞춤 태그 목록이며 결제 라이브러리를 통해 앱에 반환됩니다. 이 기본 요금제의 정기 결제 혜택도 결제 라이브러리에서 이러한 혜택 태그를 수신합니다.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

향후 Play에서 출시할 모든 새로운 지역의 가격 책정 정보입니다. 생략하면 향후 Play에서 출시하는 새 위치에 BasePlan을 자동으로 사용할 수 없습니다.
통합 필드 base_plan_type는 이 기본 요금제의 유형입니다. 정확히 1개를 설정해야 합니다. base_plan_type은 다음 중 하나여야 합니다.
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

기본 요금제가 일정한 간격으로 자동 갱신되는 시점을 설정합니다.
prepaidBasePlanType

object (PrepaidBasePlanType)

결제 기간이 종료될 때 기본 요금제가 자동으로 갱신되지 않는 기간을 설정합니다.

상태

기본 요금제의 현재 상태입니다.

열거형
STATE_UNSPECIFIED 지정되지 않은 상태.
DRAFT 기본 요금제가 현재 초안 상태이며 활성화되지 않았습니다. 이 시점에서는 안전하게 삭제할 수 있습니다.
ACTIVE 기본 요금제가 활성 상태이며 신규 정기 결제 사용자에게 제공됩니다.
INACTIVE 기본 요금제는 비활성 상태이며 기존 정기 결제 사용자만 이용할 수 있습니다.

자동 갱신기본요금제 유형

정기 결제 기간이 끝날 때 자동으로 갱신되는 기본 요금제를 나타냅니다.

JSON 표현 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
필드
billingPeriodDuration

string

필수 항목입니다. ISO 8601 형식으로 지정된 정기 결제 기간입니다. 허용되는 결제 기간 목록은 고객센터를 참고하세요.
gracePeriodDuration

string

ISO 8601 형식으로 지정된 정기 결제의 유예 기간입니다. 허용되는 값은 P0D (0일), P3D (3일), P7D (7일), P14D (14일), P30D (30일)입니다. 지정하지 않으면 반복 기간에 따라 기본값이 사용됩니다.
resubscribeState

enum (ResubscribeState)

사용자가 Google Play 플랫폼에서 이 기본 요금제를 다시 구독할 수 있어야 하는지 여부입니다. 지정하지 않을 경우 기본값은 RESUBSCRIPTION_STATE_ACTIVE입니다.
prorationMode

enum (SubscriptionProrationMode)

기본 요금제의 비례 배분 모드는 사용자가 다른 기본 요금제에서 이 요금제로 전환할 때 발생하는 결과를 결정합니다. 지정하지 않으면 기본값은 CHARGE_ON_NEXT_BILLING_DATE입니다.
legacyCompatible

boolean

갱신 기본 요금제가 이전 버전과 호환되는지 여부

이전 버전과 호환되는 기본 요금제는 Google Play 결제 라이브러리의 지원 중단된 메서드 querySkuDetailsAsync()에서 반환됩니다.

특정 정기 결제의 갱신 기본 요금제 하나만 기존 버전과 호환 가능한 것으로 표시할 수 있습니다.
legacyCompatibleSubscriptionOfferId

string

기존 버전과 호환되는 구독 혜택 ID입니다.

이전 버전과 호환되는 정기 결제 혜택은 Google Play 결제 라이브러리의 지원 중단된 메서드 querySkuDetailsAsync()에서 반환됩니다.

갱신되는 기본 요금제에서는 정기 결제 혜택 1개만 기존과 호환되는 것으로 표시할 수 있습니다.

구독 혜택을 기존 버전과 호환되도록 설정하려면 이 필드를 빈 문자열로 설정하세요.

ResubscribeState

기본 요금제 재가입 상태입니다.

열거형
RESUBSCRIBE_STATE_UNSPECIFIED 지정되지 않은 상태.
RESUBSCRIBE_STATE_ACTIVE 정기 결제를 재신청했습니다.
RESUBSCRIBE_STATE_INACTIVE 재구독이 비활성 상태입니다.

구독 비례 배분 모드

기본 요금제 갱신에 사용되는 비례 배분 모드입니다.

열거형
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED 지정되지 않은 모드입니다.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE 현재 결제 기간이 끝나면 새 기본 요금제가 청구됩니다.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY 사용자에게 새로운 기본 요금제의 요금이 즉시 전액 청구됩니다. 기존 요금제의 남은 기간은 새 요금제의 기간을 연장하는 데 사용됩니다.

선불 기본 요금제 유형

기본 요금제가 종료될 때 자동으로 갱신되지 않고 사용자가 수동으로 갱신해야 하는 기본 요금제를 나타냅니다.

JSON 표현 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
필드
billingPeriodDuration

string

필수 항목입니다. ISO 8601 형식으로 지정된 정기 결제 기간입니다. 허용되는 결제 기간 목록은 고객센터를 참고하세요.
timeExtension

enum (TimeExtension)

사용자가 Google Play 표시 경로에서 이 선불 기본 요금제를 연장할 수 있는지 여부입니다. 지정하지 않을 경우 기본값은 TIME_EXTENSION_ACTIVE입니다.

시간 연장

기본 요금제 시간 광고 확장입니다.

열거형
TIME_EXTENSION_UNSPECIFIED 지정되지 않은 상태.
TIME_EXTENSION_ACTIVE 시간 연장이 활성화되었습니다. 사용자는 선불 요금제를 충전하거나 연장할 수 있습니다.
TIME_EXTENSION_INACTIVE 시간 광고 확장이 비활성 상태입니다. 사용자는 선불 요금제를 충전하거나 연장할 수 없습니다.

RegionalBasePlanConfig 구성

리전별 기본 요금제의 구성입니다.

JSON 표현 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
필드
regionCode

string

필수 항목입니다. ISO 3166-2에 정의된 대로 이 구성이 적용되는 지역 코드입니다(예: 'US').
newSubscriberAvailability

boolean

새 정기 결제 사용자에게 지정된 리전의 기본 요금제를 제공할 수 있는지 여부 이 값을 false로 설정하면 기존 정기 결제 사용자의 정기 결제가 취소되지 않습니다. 지정하지 않으면 기본값은 false입니다.
price

object (Money)

지정된 리전의 기본 요금제 가격입니다. 신규 정기 결제 사용자가 기본 요금제를 사용할 수 있는 경우 설정해야 합니다. 지정된 지역에 연결된 통화로 설정해야 합니다.

기타 리전 기반 요금제 구성

Play가 출시되는 모든 지역의 가격 정보

JSON 표현 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
필드
usdPrice

object (Money)

필수 항목입니다. Play가 출시되는 모든 지역에 사용할 수 있는 가격(USD)
eurPrice

object (Money)

필수 항목입니다. Play가 출시되는 모든 지역에 사용할 수 있는 유로 가격입니다.
newSubscriberAvailability

boolean

Play에서 출시할 수 있는 모든 신규 지역의 신규 정기 결제 사용자에게 기본 요금제를 제공할지 나타냅니다. 지정하지 않으면 기본값은 false입니다.

구독 목록

소비자에게 표시되는 정기 결제의 메타데이터

JSON 표현 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
필드
languageCode

string

필수 항목입니다. 이 등록정보의 언어로 BCP-47에서 정의합니다(예: 'en-US').
title

string

필수 항목입니다. 등록정보의 언어로 된 구독 제목입니다. 일반 텍스트
benefits[]

string

Play 스토어와 같은 플랫폼 및 이 등록정보의 언어로 제공되는 복원 절차에서 사용자에게 표시되는 혜택 목록입니다. 일반 텍스트 최대 4가지 혜택이 정렬된 목록입니다.
description

string

등록정보에 포함된 언어로 된 이 구독에 대한 설명입니다. 최대 길이는 80자(영문 기준)입니다. 일반 텍스트

방법

archive

 구독을 보관처리합니다.

create

 새 구독을 만듭니다.

delete

 구독을 삭제합니다.

get

 단일 구독을 읽습니다.

list

 지정된 앱의 모든 정기 결제를 나열합니다.

patch

 기존 정기 결제를 업데이트합니다.