REST Resource: operators.clients.users.planStatus

리소스: PlanStatus

PlanStatus에는 사용자가 구매한 모든 최상위 모바일 서비스 패키지의 세부정보가 포함됩니다.

JSON 표현 
{
  "name": string,
  "plans": [
    {
      object (Plan)
    }
  ],
  "languageCode": string,
  "expireTime": string,
  "updateTime": string,
  "title": string,
  "subscriberId": string,
  "accountInfo": {
    object (AccountInfo)
  },
  "uiCompatibility": enum (UiCompatibility),
  "notifications": [
    enum (NotificationType)
  ],
  "planInfoPerClient": {
    object (PlanInfoPerClient)
  },
  "cpidState": enum (CpidState)
}
필드
name

string

다음 형식의 PlanStatus 리소스 이름: operators/{asn_id}/planStatuses/{userKey} PlanStatus 항목을 만들 때 이름은 무시됩니다.
plans[]

object (Plan)

이 사용자가 소유한 요금제 목록입니다.
languageCode

string

필수입니다. BCP-47 언어 코드(예: 'en-US' 또는 'sr-Latn') 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요.
expireTime

string (Timestamp format)

필수입니다. 공유된 계획 그룹 정보가 오래된 시간이 됩니다. 이 시간 이후에는 PlanStatus가 애플리케이션에 제공되지 않습니다. 만료 시간은 미래여야 합니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
updateTime

string (Timestamp format)

필수입니다. 데이터 요금제 에이전트 (DPA)가 백엔드 시스템에서 요금제 상태 정보를 가져온 시간입니다. 계획 상태 정보가 얼마나 최근인지 확인하는 데 사용할 수 있습니다. 업데이트 시간은 과거여야 하며 30일 이상 지나서는 안 됩니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
title

string

사용자가 운영자와 체결한 계약의 제목입니다. UI 헤더에 표시됩니다.
subscriberId

string

사용자를 식별하는 이동통신사 시스템의 고유하고 안정적인 식별자입니다.
accountInfo

object (AccountInfo)

선불 사용자에게 필요합니다. 사용자 계정 잔액에 관한 정보입니다.
uiCompatibility

enum (UiCompatibility)

PlanStatus를 사용자 인터페이스에 사용자에게 표시할 수 있는지 여부를 결정합니다. UI_INCOMPATIBLE로 설정된 경우 PlanStatus는 사용자에게 알림을 전송하는 데 사용할 수 있지만 사용자에게 요금제 정보를 표시하는 데는 사용되지 않습니다.
notifications[]

enum (NotificationType)

GTAF에서 사용자에게 전송한 알림 유형 목록을 포함합니다. 호출자가 이 필드를 채우면 GTAF는 이 필드를 무시합니다.
planInfoPerClient

object (PlanInfoPerClient)

특정 Google 클라이언트와 관련된 데이터 요금제 정보입니다.
cpidState

enum (CpidState)

이 요금제 상태와 연결된 CPID의 상태입니다.

계획

사용자가 구매하는 최상위 모바일 서비스 패키지인 사용자의 모바일 요금제에 관한 세부정보입니다. 요금제는 '30일 동안 10GB 모바일 데이터'와 같이 간단할 수도 있고 구성요소 모음 (요금제 모듈이라고 함)으로 정의할 수도 있습니다. 예를 들어 '2GB 데이터, 무제한 WhatsApp + 무제한 WeChat, 1GB Spotify'로 설명된 ACME 요금제 199에는 세 개의 요금제 모듈이 포함됩니다.

JSON 표현 
{
  "planName": string,
  "planId": string,
  "planCategory": enum (PlanCategory),
  "expirationTime": string,
  "planModules": [
    {
      object (PlanModule)
    }
  ],
  "planState": enum (PlanState)
}
필드
planName

string

사용자의 모바일 요금제 이름입니다.
planId

string

필수입니다. 혜택 등의 기간에 요금제를 참조하는 데 사용되는 요금제 식별자입니다.
planCategory

enum (PlanCategory)

선불 또는 후불 요금제입니다.
expirationTime

string (Timestamp format)

필수입니다. 이 요금제가 만료되는 시간입니다. 대부분의 계획에서 이는 모든 계획 모듈별 만료 시간의 최댓값과 같아야 합니다. 주기적으로 모듈 할당량을 새로고침하는 요금제의 경우 이는 전체 요금제 만료 시간, 즉 요금제 모듈이 새로고침을 중지하는 시간이어야 합니다. 요금제가 만료되지 않는 경우 이 필드는 생략해야 합니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
planModules[]

object (PlanModule)

세부 요금제 모듈 (하위 요금제) 정보입니다.
planState

enum (PlanState)

사용자 요금제의 상태입니다(예: 활성, 비활성 등).

PlanCategory

가능한 요금제 카테고리 유형입니다.

열거형
PLAN_CATEGORY_UNSPECIFIED 지정되지 않음.
PREPAID 선불 요금제
POSTPAID 후불 요금제

PlanModule

요금제 내 각 데이터 요금제 모듈 (또는 하위 요금제)의 정보입니다.

JSON 표현 
{
  "coarseBalanceLevel": enum (BalanceLevel),
  "trafficCategories": [
    enum (PlanModuleTrafficCategory)
  ],
  "expirationTime": string,
  "overUsagePolicy": enum (OverUsagePolicy),
  "maxRateKbps": string,
  "description": string,
  "moduleName": string,
  "usedBytes": string,
  "planModuleState": enum (PlanState),
  "refreshPeriod": enum (RefreshPeriod),

  // Union field balance can be only one of the following:
  "byteBalance": {
    object (ByteQuota)
  },
  "timeBalance": {
    object (TimeQuota)
  }
  // End of list of possible types for union field balance.
}
필드
coarseBalanceLevel

enum (BalanceLevel)

대략적인 잔액 정보입니다.
trafficCategories[]

enum (PlanModuleTrafficCategory)

이 계획 모듈에 청구될 트래픽 카테고리 목록입니다.
expirationTime

string (Timestamp format)

필수입니다. 계획 모듈별 만료 시간입니다. 할당량이 주기적으로 새로고침되는 계획 모듈의 경우 다음 모듈 새로고침 시간입니다. 요금제 모듈이 만료되지 않는 경우 이 필드는 생략해야 합니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
overUsagePolicy

enum (OverUsagePolicy)

사용량 초과 정책(예: 제한됨)
maxRateKbps

string (int64 format)

이 계획 모듈에서 허용되는 최대 데이터 속도(Kbps)입니다. 실제로 관찰되는 데이터 속도는 네트워크 상태에 따라 0~maxRateKbps입니다. maxRateKbps를 생략하거나 0으로 설정하면 이 계획 모듈에 대해 제한이 실행되지 않음을 나타냅니다.
description

string

필수입니다. 계획 모듈 설명입니다. 사용자에게 표시될 수 있으며 이 계획 모듈의 시장 설명과 유사해야 합니다.
moduleName

string

필수입니다. 계획 모듈의 이름입니다.
usedBytes

string (int64 format)

이 요금제 모듈에서 사용자가 사용한 총 바이트 수입니다.
planModuleState

enum (PlanState)

계획 모듈의 상태입니다(예: 활성, 비활성 등).
refreshPeriod

enum (RefreshPeriod)

이 계획 모듈의 새로고침 기간입니다. 계획 모듈이 할당량을 새로고침하지 않는 경우 REFRESH_PERIOD_NONE입니다. 할당량을 새로고침하는 요금제 모듈은 새로고침 기간마다 한 번씩 새로고침합니다.
통합 필드 balance. 필수입니다. 계획 모듈 잔액 정보는 byte_balance, time_balance, coarse_balance_level 중 하나여야 합니다. balance은 다음 중 하나여야 합니다.
byteBalance

object (ByteQuota)

바이트 기반 요금제 모듈 잔액 정보입니다. 주기적으로 새로고침되는 모듈의 경우 이 필드는 새로고침 기간당 바이트 잔액을 나타냅니다.
timeBalance

object (TimeQuota)

시간 기반 계획 모듈 잔액 정보입니다. 주기적으로 새로고침되는 모듈의 경우 이 필드는 새로고침 기간당 시간 잔액을 나타냅니다.

ByteQuota

바이트 기반 요금제 모듈 할당량/잔액 정보입니다.

JSON 표현 
{
  "quotaBytes": string,
  "remainingBytes": string
}
필드
quotaBytes

string (int64 format)

모듈 할당량(바이트)입니다. 무제한 요금제의 경우 2^63 - 1 (9223372036854775807)로 설정해야 합니다.
remainingBytes

string (int64 format)

잔액 부족 알림에 필요합니다. 남은 할당량 잔액(바이트)입니다.

TimeQuota

시간 기반 요금제 모듈 할당량/잔액 정보입니다.

JSON 표현 
{
  "quotaMinutes": string,
  "remainingMinutes": string
}
필드
quotaMinutes

string (int64 format)

시간 기반 요금제의 모듈 할당량(분)입니다(예: 180분
remainingMinutes

string (int64 format)

시간 기반 요금제의 남은 할당량 잔액(분)입니다(예: 40분

BalanceLevel

대략적인 계획 모듈 데이터 균형 정보입니다.

열거형
BALANCE_LEVEL_UNSPECIFIED 지정되지 않음.
NO_PLAN 데이터 요금제가 없습니다.
OUT_OF_DATA 데이터 잔액이 0입니다.
LOW_QUOTA 데이터 잔액 (또는 남은 시간)이 원래 팩 잔액 (또는 시간)의 10~25% 이하입니다. 운송업체는 적절하다고 판단되는 대로 각 팩의 정확한 기준을 결정할 수 있습니다(MAY).
HIGH_QUOTA 데이터 잔액 (또는 남은 시간)이 원래 팩 잔액 (또는 시간)의 10~25% 를 초과합니다. 운송업체는 적절하다고 판단되는 대로 각 팩의 정확한 기준을 결정할 수 있습니다(MAY). 데이터 잔액이 많습니다.

PlanModuleTrafficCategory

계획 모듈 트래픽 카테고리입니다. 특정 계획 모듈에 속하는 애플리케이션 트래픽 집합을 설명합니다.

열거형
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED 지정되지 않음.
GENERIC 일반적이며 모든 트래픽에 적용됩니다.
VIDEO 모든 동영상 트래픽
VIDEO_BROWSING 동영상/오디오 스트리밍 부분을 제외한 모든 동영상 앱 트래픽을 나타내는 동영상 디스커버리 (탐색) 트래픽
VIDEO_OFFLINE 동영상 오프라인 트래픽으로, VIDEO_BROWSING 및 동영상/오디오 오프라인 (스트리밍 아님) 트래픽의 합계입니다.
MUSIC 음악 앱 트래픽
GAMING 게임 앱 트래픽
SOCIAL 소셜 앱 트래픽입니다.
MESSAGING 메시지 앱 트래픽
APP_STORE 새 앱 업데이트 또는 다운로드와 같은 앱 스토어 트래픽

OverUsagePolicy

초과 사용 정책: 사용자가 할당량을 소진하면 어떻게 되나요?

열거형
OVER_USAGE_POLICY_UNSPECIFIED 지정되지 않음.
THROTTLED 속도가 제한됩니다.
BLOCKED 연결이 차단되었습니다.
PAY_AS_YOU_GO 종량제 요금

PlanState

사용자 계획/계획 모듈의 다양한 상태를 나타내는 열거형입니다.

열거형
ACTIVE 계획/PlanModule이 활성 상태이며 사용자가 모듈의 일부로 제공되는 데이터를 사용할 수 있습니다.
INACTIVE 계획/계획 모듈이 비활성 상태이며 사용자에게 모듈이 계속 표시되지만 사용자는 모듈에 포함된 데이터를 사용할 수 없습니다. 모듈이 특정 시간대에만 데이터를 제공하거나 사용자가 모듈을 구매했지만 아직 활성화되지 않은 경우에 발생할 수 있습니다.
EXPIRING_SOON 계획/PlanModule이 곧 만료됩니다. 호출자는 이 값을 설정할 시점을 결정하기 위해 적절한 수준을 선택해야 합니다. 이렇게 하면 요금제가 자동으로 활성화됩니다.
NEWLY_ACTIVE 이전에 비활성 상태였거나 존재하지 않았던 계획/PlanModule이 방금 활성화되었습니다. 이 상태는 활성화 시간 후 매우 짧은 기간 동안만 사용해야 하며, 그렇지 않으면 ACTIVE 상태를 대신 사용해야 합니다. NEWLY_ACTIVE 모듈과 함께 전송되는 데이터 요금제 상태 알림은 TTL이 짧아야 합니다. NEWLY_ACTIVE 상태가 매우 빠르게 부정확해지기 때문입니다.
EXPIRED 계획/PlanModule이 만료되었습니다. 이 열거형 값을 설정하면 요금제 만료 알림이 트리거됩니다.

RefreshPeriod

계획 모듈이 재설정되는 정기적인 간격인 새로고침 기간을 나타냅니다.

열거형
REFRESH_PERIOD_NONE 새로고침 기간이 없습니다. 계획 모듈이 반복되지 않는 경우에 사용됩니다.
DAILY 계획 모듈은 매일 재설정됩니다.
MONTHLY 계획 모듈은 매월 재설정됩니다.
BIWEEKLY 계획 모듈은 2주마다 재설정됩니다.
WEEKLY 계획 모듈은 매주 재설정됩니다.

AccountInfo

선불 사용자의 계정 잔액에 관한 정보입니다.

JSON 표현 
{
  "accountBalance": {
    object (Money)
  },
  "loanBalance": {
    object (Money)
  },
  "unpaidLoan": {
    object (Money)
  },
  "accountBalanceStatus": enum (AccountBalanceStatus),
  "validUntil": string,
  "payAsYouGoCharge": {
    object (Money)
  },
  "accountTopUp": {
    object (Money)
  }
}
필드
accountBalance

object (Money)

필수입니다. 사용자 계정에 남아 있는 계정 잔액입니다.
loanBalance

object (Money)

해당하는 경우 필수입니다. 이동통신사의 금전 대출로 추가된 사용자 계정에 남아 있는 계정 잔액입니다. 있는 경우 accountBalance 필드에 이 잔액이 포함되지 않습니다.
unpaidLoan

object (Money)

금전 대출로 인해 사용자가 이동통신사에 지불해야 하는 금액입니다.
accountBalanceStatus

enum (AccountBalanceStatus)

필수입니다. 계정 잔액의 상태를 나타냅니다. validUntil 시간과 accountBalanceStatus 필드가 일치하지 않는 경우 accountBalanceStatus가 사용됩니다.
validUntil

string (Timestamp format)

필수입니다. 계정 잔액이 유효한 시간입니다. 이 필드는 사용자에게 계정 잔액에 대해 '

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
payAsYouGoCharge

object (Money)

사용자가 사용한 만큼만 지불 상태에서 요금제를 사용하여 지출한 금액입니다. 이 필드가 운송업체에 의해 채워져 GTAF와 계정 정보를 공유하는 경우 GTAF는 사용자에게 종량제 상태에서 비용을 지출하고 있음을 나타내는 알림을 전송하려고 시도합니다.
accountTopUp

object (Money)

계정 잔액 충전 알림에 필요합니다. 사용자가 계정 잔액에 추가한 금액입니다. 이 필드가 운송업체에 의해 채워져 GTAF와 계정 정보를 공유하는 경우 GTAF는 계정이 충전되었음을 나타내는 알림을 사용자에게 전송하려고 시도합니다.

Money

금액과 통화 유형을 나타냅니다.

JSON 표현 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
필드
currencyCode

string

ISO 4217에 정의된 3자리 통화 코드입니다.
units

string (int64 format)

금액의 전체 단위입니다. 예를 들어 currencyCode가 "USD"이면 1단위는 1달러(USD)입니다.
nanos

integer

금액의 나노 (10^-9) 단위 수입니다. 이 값은 -999,999,999~+999,999,999(끝값 포함) 사이여야 합니다. units가 양수이면 nanos는 양수 또는 0이어야 합니다. units가 0이면 nanos는 양수, 0 또는 음수일 수 있습니다. units가 음수이면 nanos는 음수 또는 0이어야 합니다. 예를 들어 $-1.75는 units=-1 및 nanos=-750,000,000으로 나타냅니다.

AccountBalanceStatus

사용자 지갑의 상태입니다.

열거형
VALID 사용자 계정 잔액이 유효하며 구매에 사용할 수 있습니다.
INVALID 사용자 계정 잔액이 유효하지 않으며 계정을 변경하지 않고는 사용할 수 없습니다.

UiCompatibility

공유되는 PlanStatus를 사용자에게 표시할 수 있는지를 나타내는 열거형입니다.

열거형
UI_COMPATIBILITY_UNSPECIFIED 기본적으로 PlanStatus는 UI와 호환된다고 가정합니다.
UI_COMPATIBLE 전체 PlanStatus가 UI와 호환되며 요금제 정보를 사용자에게 표시할 수 있음을 나타냅니다.
UI_INCOMPATIBLE PlanStatus가 UI와 호환되지 않음을 나타냅니다. 필드는 사용자에게 알림을 전송하는 데 사용할 수 있지만 사용자에게 요금제 정보를 표시하는 데는 사용할 수 없습니다.

NotificationType

모바일 데이터 요금제 설정 사용자에게 전송되는 알림 유형입니다.

열거형
NOTIFICATION_UNDEFINED 알 수 없는 알림 장르 유형
NOTIFICATION_LOW_BALANCE_WARNING 잔액 부족을 경고하는 알림
NOTIFICATION_DATA_EXPIRATION_WARNING 데이터 요금제가 만료된다고 사용자에게 경고하는 알림
NOTIFICATION_OUT_OF_DATA 사용자의 데이터가 소진되었음을 알리는 알림
NOTIFICATION_PLAN_ACTIVATION 사용자가 구매한 요금제가 활성화되었다는 알림
NOTIFICATION_PAY_AS_YOU_GO 사용자에게 선불 상태에서 데이터 요금을 지불하고 있음을 알리는 알림
NOTIFICATION_ACCOUNT_TOP_UP 사용자에게 계정 잔액이 충전되었음을 알리는 알림
NOTIFICATION_DATA_EXPIRED 사용자에게 데이터 요금제가 만료되었음을 알리는 알림

PlanInfoPerClient

특정 Google 클라이언트와 관련된 데이터 요금제 정보입니다.

JSON 표현 
{
  "youtube": {
    object (YouTube)
  },
  "androidSystemInfo": {
    object (AndroidSystemInfo)
  }
}
필드
youtube

object (YouTube)

YouTube 관련 요금제 정보입니다.
androidSystemInfo

object (AndroidSystemInfo)

Android 시스템과 관련된 계획 정보입니다.

YouTube

YouTube와 관련된 데이터 요금제 정보입니다.

JSON 표현 
{
  "rateLimitedStreaming": {
    object (RateLimitedStreaming)
  }
}
필드
rateLimitedStreaming

object (RateLimitedStreaming)

전송되는 동영상의 비트 전송률을 제한하는 YouTube 요금제 인식 스트리밍 (PAS) 기능

RateLimitedStreaming

YouTube가 속도 제한 스트리밍 사용자 환경을 개선할 수 있도록 하는 데이터 요금제 정보입니다.

JSON 표현 
{
  "maxMediaRateKbps": integer
}
필드
maxMediaRateKbps

integer

이 사용자에 대해 지원되는 YouTube 비트 전송률 (단위: 초당 1,000비트)입니다.

AndroidSystemInfo

전체 Android 시스템과 관련된 데이터 요금제 정보입니다.

JSON 표현 
{
  "cellularInfo": [
    {
      object (CellularInfo)
    }
  ]
}
필드
cellularInfo[]

object (CellularInfo)

연결 유형별 모바일 정보입니다. 예를 들어 4G, 5G 등 연결 유형마다 cellularInfo 메시지가 하나씩 있습니다.

CellularInfo

요금제에서 사용자에게 제공하는 모바일 데이터 연결에 관한 정보입니다.

JSON 표현 
{
  "connectionType": enum (ConnectionType),
  "meteredness": enum (Meteredness)
}
필드
connectionType

enum (ConnectionType)

운영자가 사용자에게 제공하는 연결 유형입니다.
meteredness

enum (Meteredness)

사용자 요금제의 요금제 상태입니다.

ConnectionType

연결 유형: 2G, 3G, 4G

열거형
CONNECTION_TYPE_UNSPECIFIED 지정되지 않음.
CONNECTION_2_G 2G.
CONNECTION_3_G 3G
CONNECTION_4_G 4G
CONNECTION_5_G 5G
CONNECTION_ALL 모든 음악을 좋아하며

계량

사용자가 보유한 요금제 유형

열거형
METEREDNESS_UNSPECIFIED GTAF는 사용자 요금제의 측정 상태를 알지 못합니다.
METEREDNESS_UNMETERED 사용자가 무제한 요금제를 사용하고 있습니다.
METEREDNESS_METERED 사용자가 종량제 요금제를 사용하고 있습니다.

CpidState

CPID 상태를 나타내는 이동통신사의 열거형입니다.

열거형
CPID_STATE_UNSPECIFIED CPID의 상태가 지정되지 않았습니다. 이는 CPID가 유효한 것으로 처리됩니다.
CPID_INVALIDATED CPID가 무효화되며 클라이언트는 CPID 엔드포인트에서 새 CPID를 가져와야 합니다.

메서드

create

 모바일 운영자 (고유한 자율 시스템 번호 (ASN)로 식별됨)가 특정 클라이언트에서 사용할 사용자의 새 PlanStatus 항목을 추가할 수 있습니다.