REST Resource: monetization.subscriptions.basePlans.offers

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

리소스: SubscriptionOffer

일회성 임시 쿠폰

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)
    }
  ]
}
필드
packageName

string

필수 항목입니다. 변경할 수 없습니다. 상위 정기 결제가 속한 앱의 패키지 이름입니다.

productId

string

필수 항목입니다. 변경할 수 없습니다. 이 혜택이 속한 상위 정기 결제의 ID입니다.

basePlanId

string

필수 항목입니다. 변경할 수 없습니다. 이 혜택의 확장인 기본 요금제 ID입니다.

offerId

string

필수 항목입니다. 변경할 수 없습니다. 이 구독 상품의 고유 ID입니다. 기본 요금제 내에서 고유해야 합니다.

state

enum (State)

출력 전용입니다. 이 오퍼의 현재 상태입니다. 활성화 및 비활성화 작업을 사용하여 변경할 수 있습니다. 주의: 기본 요금제 상태가 이 상태를 대체하므로 기본 요금제가 활성 상태가 아니면 활성 혜택을 사용하지 못할 수 있습니다.

phases[]

object (SubscriptionOfferPhase)

필수 항목입니다. 이 구독 혜택의 단계입니다. 하나 이상의 항목을 포함해야 하며 최대 5개를 포함할 수 있습니다. 사용자는 항상 지정된 순서대로 모든 단계를 받게 됩니다. 초기 생성 후 단계는 추가, 삭제 또는 재정렬할 수 없습니다.

targeting

object (SubscriptionOfferTargeting)

이 혜택을 받으려면 사용자가 충족해야 하는 요구사항입니다. 혜택 반환 여부를 결정하기 위해 Play에서 평가하는 요구사항을 나타냅니다. 개발자는 이러한 혜택을 추가로 필터링할 수 있습니다.

regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

필수 항목입니다. 이 오퍼의 지역별 구성입니다. 항목이 1개 이상 포함되어야 합니다.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

향후 Play에서 출시될 수 있는 모든 새로운 위치의 구성

offerTags[]

object (OfferTag)

이 오퍼에 지정된 최대 20개의 맞춤 태그의 apks.list이며 결제 라이브러리를 통해 앱에 반환됩니다.

상태

정기 결제 오퍼의 현재 상태입니다.

열거형
STATE_UNSPECIFIED 기본값은 사용할 수 없습니다.
DRAFT 정기 결제 혜택은 존재하지 않으며 사용자에게 제공되는 적이 없습니다.
ACTIVE 정기 결제 혜택은 신규 및 기존 사용자에게 제공됩니다.
INACTIVE 신규 사용자는 정기 결제 혜택을 이용할 수 없습니다. 기존 사용자는 액세스 권한을 유지합니다.

구독 혜택 단계

정기 결제 혜택의 단일 단계입니다.

JSON 표현
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
필드
recurrenceCount

integer

필수 항목입니다. 이 단계가 반복되는 횟수입니다. 이 혜택 단계가 무료가 아닌 경우 반복될 때마다 사용자에게 이 혜택 단계의 가격이 청구됩니다.

duration

string

필수 항목입니다. 이 단계의 단일 반복 기간입니다. ISO 8601 형식으로 지정됩니다.

regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

필수 항목입니다. 이 오퍼 단계의 지역별 구성입니다. 이 목록에는 정기 결제 혜택에 지역별 구성이 있는 각 지역에 정확히 하나의 항목이 포함되어야 합니다.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

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

지역별 구독 혜택 단계 구성

단일 리전에서 정기 결제 혜택의 단일 단계를 위한 구성입니다.

JSON 표현
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
필드
regionCode

string

필수 항목입니다. 변경할 수 없습니다. 이 구성이 적용되는 리전입니다.

통합 필드 price_override. 이 단계의 가격 재정의입니다. 필수 항목입니다. price_override은 다음 중 하나여야 합니다.
price

object (Money)

이 혜택 단계에서 사용자가 지불하는 절대 가격입니다. 가격은 이 지역에서 허용되는 최소 가격 이상이어야 합니다.

relativeDiscount

number

사용자가 이 혜택 단계에서 지불하는 단계 기간 동안 일할 계산된 기본 요금제 가격의 비율입니다. 예를 들어 이 지역의 기본 요금제 가격이 1년 동안 12달러인 경우 3개월 동안 50% 할인은 1.50달러입니다. 할인은 0보다 크고 1보다 작은 분수로 지정해야 합니다. 최종 가격은 청구 가능한 단위 (예: USD의 경우 센트)로 반올림됩니다. 할인 가격이 이 지역에서 허용되는 최소 가격보다 낮은 경우 상대적 할인이 유효하지 않은 것으로 간주됩니다.

absoluteDiscount

object (Money)

기본 요금제 가격에서 차감된 절대 금액으로, 이 혜택 단계에서 사용자가 지불하는 단계 기간 동안 일할 계산됩니다. 예를 들어 이 지역의 기본 요금제 가격이 1년 동안 12달러인 경우 3개월 기간에 대해 1달러의 절대 할인이 2달러에 해당합니다. 최종 가격이 이 지역에 허용되는 최소 가격보다 작을 수 없습니다.

free

object

이 혜택을 무료로 지정하려면 지정하면 됩니다.

기타 리전별 요금제 혜택 단계 구성

단일 혜택 단계에서 Play가 출시될 수 있는 모든 새 위치의 구성입니다.

JSON 표현
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
필드
통합 필드 price_override. 이 단계의 가격 재정의입니다. 필수 항목입니다. price_override은 다음 중 하나여야 합니다.
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

이 혜택 단계에서 사용자가 지불하는 절대 가격입니다. 가격은 Play가 출시되는 모든 위치에 허용되는 최소 가격보다 작을 수 없습니다.

relativeDiscount

number

사용자가 이 혜택 단계에서 지불하는 단계 기간 동안 일할 계산된 기본 요금제 가격의 비율입니다. 예를 들어 이 지역의 기본 요금제 가격이 1년 동안 12달러인 경우 3개월 동안 50% 할인은 1.50달러입니다. 할인은 0보다 크고 1보다 작은 분수로 지정해야 합니다. 최종 가격은 청구 가능한 단위 (예: USD의 경우 센트)로 반올림됩니다. 할인이 Play가 실행될 수 있는 모든 신규 위치에서 허용되는 최저 가격보다 낮은 경우 상대적 할인이 유효하지 않은 것으로 간주됩니다.

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

기본 요금제 가격에서 차감된 절대 금액으로, 이 혜택 단계에서 사용자가 지불하는 단계 기간 동안 일할 계산됩니다. 예를 들어 이 지역의 기본 요금제 가격이 1년 동안 12달러인 경우 3개월 기간에 대해 1달러의 절대 할인이 2달러에 해당합니다. 최종 가격은 Play가 출시되는 새 위치에 허용된 최소 가격보다 작을 수 없습니다.

free

object

이 혜택을 무료로 지정하려면 지정하면 됩니다.

기타 지역 구독 혜택 단계 가격

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

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

object (Money)

필수 항목입니다. Play가 출시될 수 있는 모든 신규 지역에 사용할 수 있는 USD 기준 가격입니다.

eurPrice

object (Money)

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

구독 혜택 타겟팅

사용자가 이 혜택을 받기 위해 충족해야 하는 규칙을 정의합니다.

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

통합 필드 rule.

rule는 다음 중 하나여야 합니다.

acquisitionRule

object (AcquisitionTargetingRule)

신규 사용자 획득에 대한 오퍼 타겟팅 규칙

upgradeRule

object (UpgradeTargetingRule)

사용자 기존 요금제 업그레이드를 위한 오퍼 타겟팅 규칙

획득 타겟팅 규칙

다음과 같은 형식의 타겟팅 규칙을 나타냅니다. 사용자가 {scope}를 이전에 사용한 적이 없습니다.

JSON 표현
{
  "scope": {
    object (TargetingRuleScope)
  }
}
필드
scope

object (TargetingRuleScope)

필수 항목입니다. 이 규칙에서 고려하는 구독 범위입니다. '이 정기 결제' 및 '앱에서 모든 정기 결제'만 허용됩니다.

타겟팅 규칙 범위

이전 또는 현재 사용 권한을 기반으로 사용자에게 타겟팅할 혜택을 타겟팅하기 위해 적용할 수 있는 정기 결제의 범위를 정의합니다.

JSON 표현
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object
  },
  "anySubscriptionInApp": {
    object
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
필드

통합 필드 scope.

scope는 다음 중 하나여야 합니다.

thisSubscription

object

현재 타겟팅 규칙의 범위는 이 제품이 정의된 정기 결제입니다.

anySubscriptionInApp

object

현재 타겟팅 규칙의 범위는 상위 앱의 모든 구독입니다.

specificSubscriptionInApp

string

현재 타겟팅 규칙의 범위는 지정된 구독 ID가 있는 구독입니다. 동일한 상위 앱 내의 구독이어야 합니다.

업그레이드 타겟팅 규칙

사용자가 현재 {scope}([결제 기간 {billing_period}])인 형식의 타겟팅 규칙을 나타냅니다.

JSON 표현
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
필드
oncePerUser

boolean

이 쿠폰은 사용자당 한 번만 사용할 수 있습니다. True로 설정하면 사용자가 이 혜택을 정기 결제한 적이 있는 경우 다시 이 혜택을 사용할 수 없습니다.

scope

object (TargetingRuleScope)

필수 항목입니다. 이 규칙에서 고려하는 구독 범위입니다. '이 정기 결제' 및 '특정 정기 결제'만 허용합니다.

billingPeriodDuration

string

이 규칙을 충족하기 위해 사용자가 현재 구독해야 하는 ISO 8601 형식으로 지정된 특정 결제 기간 기간입니다. 지정하지 않으면 결제 기간을 구독한 사용자가 일치됩니다.

RegionalSubscriptionOfferConfig

단일 리전의 정기 결제 혜택 구성

JSON 표현
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
필드
regionCode

string

필수 항목입니다. 변경할 수 없습니다. 이 구성이 적용되는 지역 코드입니다(ISO 3166-2에 정의되어 있음). 예: "US

newSubscriberAvailability

boolean

지정된 지역에서 정기 결제 상품을 신규 정기 결제 사용자에게 제공할 수 있는지 나타냅니다. 이 값이 false로 설정된 경우 기존 정기 결제는 취소되지 않습니다. 지정하지 않으면 기본값은 false입니다.

OtherRegionSubscriptionOfferConfig

정기 결제 혜택에 지정된 위치에서 Play가 실행될 수 있는 모든 새로운 위치의 구성입니다.

JSON 표현
{
  "otherRegionsNewSubscriberAvailability": boolean
}
필드
otherRegionsNewSubscriberAvailability

boolean

향후 새로운 위치에 정기 결제 혜택이 제공될지 나타냅니다. 지정하지 않으면 기본값은 false입니다.

메서드

activate

정기 결제 혜택을 활성화합니다.

create

새 정기 결제 혜택을 만듭니다.

deactivate

정기 결제 상품을 비활성화합니다.

delete

정기 결제 혜택을 삭제합니다.

get

단일 혜택 읽기

list

지정된 구독의 모든 혜택을 나열합니다.

patch

기존 정기 결제 혜택을 업데이트합니다.