REST Resource: deployments.configs

리소스: 구성

배포의 구성입니다.

JSON 표현 
{
  "name": string,
  "title": string,
  "description": string,
  "defaultUpdateDescription": {
    object (UpdateDescription)
  },
  "localizedUpdateDescriptions": [
    {
      object (LocalizedUpdateDescription)
    }
  ],
  "urgencyMode": enum (UrgencyMode),
  "scheduledInstallDelay": enum (ScheduledInstallDelay),
  "wifiOnlyTime": enum (WifiOnlyTime),
  "updateMaintenanceWindow": {
    object (TimeWindow)
  },
  "packageSizeAwareBatteryThreshold": boolean,
  "offPeakUpdate": {
    object (OffPeakUpdate)
  },
  "countryRestriction": {
    object (IncludeExclude)
  },
  "mobileNetworkRestriction": {
    object (IncludeExclude)
  },
  "deviceBuildPropertyRestriction": {
    object (IncludeExclude)
  },
  "mobileNetworkCarrierRestriction": {
    object (IncludeExclude)
  },
  "updateRequiredSetup": boolean,
  "minimalSpaceRequired": enum (SpaceNeed),
  "immediateRelease": boolean,
  "rolloutSteps": [
    {
      object (RolloutStep)
    }
  ],
  "securityUpdate": boolean,
  "details": {
    object (ConfigDetails)
  },
  "allowEncryptedScheduledInstall": boolean,
  "reminderDialogSettings": {
    object (ReminderDialogSettings)
  }
}
필드
name

string

출력 전용. 구성 이름입니다. 이 이름은 Config 객체의 고유 식별자로, 새 Config가 생성될 때 서버에서 생성됩니다.
title

string

선택사항입니다. 구성의 제목입니다.
description

string

선택사항입니다. 구성에 대한 설명입니다.
defaultUpdateDescription

object (UpdateDescription)

필수 항목입니다. 기기 언어가 localizedUpdateDescriptions에 지정된 언어와 일치하지 않을 때 사용되는 기본 UI 텍스트입니다.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

선택사항입니다. 현지화된 업데이트 설명 중 하나가 기기 언어와 일치하는 경우 defaultUpdateDescription보다 우선순위가 높은 설명 목록입니다.
urgencyMode

enum (UrgencyMode)

선택사항입니다. 업데이트 긴급성은 사용자에게 메시지를 표시하는 방식을 나타냅니다. 지정하지 않으면 기본값 MANDATORY이 사용됩니다.
scheduledInstallDelay

enum (ScheduledInstallDelay)

선택사항입니다. 업데이트가 야간 설치로 예약되는 시점을 결정하는 지연입니다. 지정하지 않으면 기본값은 NEVER입니다.
wifiOnlyTime

enum (WifiOnlyTime)

선택사항입니다. WIFI_ONLY_TIME_UNSPECIFIED로 두면 기본적으로 SEVEN_DAYS로 설정됩니다.

참고: urgencyMode가 RECOMMENDED이면 FOREVER로 설정됩니다.
updateMaintenanceWindow

object (TimeWindow)

선택사항입니다. OTA의 설치 기간.
packageSizeAwareBatteryThreshold

boolean

선택사항입니다. 업데이트 크기에 따라 설치 배터리 임계값이 달라야 하는지 여부입니다.
offPeakUpdate

object (OffPeakUpdate)

선택사항입니다. 사용량이 많지 않은 업데이트 객체.
countryRestriction

object (IncludeExclude)

선택사항입니다. 가능한 포함/제외 국가입니다.
mobileNetworkRestriction

object (IncludeExclude)

선택사항입니다. mcc/mnc 코드로 식별되는 포함/제외 가능한 모바일 네트워크입니다. mobileNetworkCarrierRestriction에서만 사용해야 합니다. 두 필드를 동시에 설정할 수 없습니다.
deviceBuildPropertyRestriction

object (IncludeExclude)

선택사항입니다. 포함/제외될 수 있는 기기 빌드 속성 제한입니다.
mobileNetworkCarrierRestriction

object (IncludeExclude)

선택사항입니다. 포함/제외될 수 있는 모바일 네트워크 이동통신사입니다. mobileNetworkRestriction에서만 사용해야 합니다. 두 필드를 동시에 설정할 수 없습니다.

매핑을 보려면 모바일 국가 코드 및 모바일 네트워크 코드를 참조하세요.
updateRequiredSetup

boolean

선택사항입니다. 설정 마법사에서 업데이트가 필요한지 여부를 나타냅니다. 기본값은 거짓입니다.
minimalSpaceRequired

enum (SpaceNeed)

선택사항입니다. 최소 공간 요구사항 값이 UNSPECIFIED이면 서버는 제한을 설정하지 않습니다. Google Play 서비스 6.1.11 이상이 필요합니다.
immediateRelease

boolean

선택사항입니다. immediateRelease 또는 rolloutSteps 중 하나가 필요합니다. 업데이트를 즉시 출시할지 여부입니다. true이면 rolloutSteps를 설정 해제해야 합니다.
rolloutSteps[]

object (RolloutStep)

선택사항입니다. rolloutSteps 또는 immediateRelease 중 하나가 필요합니다. RolloutSteps 순서가 일치해야 합니다. time_ms와 비율 모두 감소해서는 안 됩니다. 마지막 단계의 분수는 100이어야 합니다.
securityUpdate

boolean

선택사항입니다. 업데이트를 보안 업데이트로 표시합니다. 이는 올바른 업데이트 메시지의 표시를 조정하기 위해 기기에 전달됩니다. 즉, '시스템 업데이트 적용 중'이 아니라 '보안 업데이트 적용 중'이라는 텍스트를 표시합니다. API 수준 22 이상 및 Google Play 서비스 9.4 이상이 필요합니다.
details

object (ConfigDetails)

출력 전용. 구성에 대한 추가 세부정보입니다. 이는 구성을 반환할 때만 서버에서 반환해야 합니다.
allowEncryptedScheduledInstall

boolean

선택사항입니다. 암호화된 기기에 패키지 설치를 예약할 수 있는지 여부입니다.
reminderDialogSettings

object (ReminderDialogSettings)

선택사항입니다. 사용자에게 대기 중인 업데이트가 있음을 알리는 모달 대화상자 설정입니다.

UpdateDescription

기기로 전송된 업데이트 설명입니다.

JSON 표현 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
필드
description

string

업데이트 설명 텍스트입니다.
title

string

업데이트 설명 제목입니다.
dialogMessage

string

업데이트의 대화상자 메시지입니다.
postSuccessMessage

string

업데이트의 게시 성공 메시지입니다. API 수준 14 이상이 필요합니다.
postFailureMessage

string

업데이트의 사후 실패 메시지입니다. API 수준 14 이상이 필요합니다.

LocalizedUpdateDescription

언어에 따른 업데이트 설명입니다.

JSON 표현 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
필드
locales[]

string

기기의 언어와 일치하는 언어입니다.
updateDescription

object (UpdateDescription)

기기로 전송되는 업데이트 설명입니다.

UrgencyMode

업그레이드 긴급 모드입니다.

열거형
MODE_UNSPECIFIED 지정되지 않음
RECOMMENDED 업그레이드를 추천합니다. 업데이트를 다운로드하고 설치하라는 메시지가 표시됩니다.
MANDATORY 필수 업그레이드입니다. 업데이트는 자동으로 다운로드되지만 사용자에게 설치를 시작하라는 메시지가 표시됩니다.
AUTOMATIC 자동 업그레이드 업데이트가 자동으로 다운로드되고 설치됩니다.

ScheduledInstallDelay

업데이트를 사용할 수 있게 된 시점부터 설치가 자동으로 예약될 때까지의 지연 기간입니다.

열거형
SCHEDULED_INSTALL_DELAY_UNSPECIFIED 기본값 NEVER로 처리됩니다.
SCHEDULED_INSTALL_DELAY_NEVER 자동 설치로 에스컬레이션하지 마세요.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS 0일 기간 (즉시)
SCHEDULED_INSTALL_DELAY_ONE_DAY 1일 기간
SCHEDULED_INSTALL_DELAY_TWO_DAYS 2일 기간
SCHEDULED_INSTALL_DELAY_THREE_DAYS 3일 기간
SCHEDULED_INSTALL_DELAY_FOUR_DAYS 4일 기간
SCHEDULED_INSTALL_DELAY_FIVE_DAYS 5일 기간
SCHEDULED_INSTALL_DELAY_TEN_DAYS 10일 기간
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS 기간 15일
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS 기간 30일

WifiOnlyTime

업데이트가 제공된 후 이 기간 동안 모바일 네트워크를 사용하지 않습니다.

열거형
WIFI_ONLY_TIME_UNSPECIFIED 지정되지 않음
NONE 차단되지 않았습니다.
TWENTY_FOUR_HOURS 24시간짜리 타이머입니다.
THREE_DAYS 3일 기간
SEVEN_DAYS 7일 기간
FOURTEEN_DAYS 기간 14일
TWENTY_ONE_DAYS 21일 기간
FOREVER 영구 기간

TimeWindow

하루의 시작 시간과 중지 시간을 정의하는 기간입니다.

JSON 표현 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
필드
startTime

object (TimeOfDay)

기간의 시작 시간입니다.
stopTime

object (TimeOfDay)

구간 중지 시간입니다.

TimeOfDay

하루 중 특정 시간을 나타냅니다. 날짜와 시간대가 중요하지 않거나 아무 곳으로 지정됩니다. API는 윤초를 허용하도록 선택할 수 있습니다. 관련된 유형은 google.type.Date 및 google.protobuf.Timestamp입니다.

JSON 표현 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
필드
hours

integer

24시간 형식의 시간입니다. 0~23 사이의 값이어야 합니다. API는 비즈니스 종료 시간과 같은 시나리오에서 '24:00:00' 값을 허용하도록 선택할 수 있습니다.
minutes

integer

특정 시간의 분입니다. 0~59 사이의 값이어야 합니다.
seconds

integer

특정 분의 초입니다. 일반적으로 0~59 사이의 값이어야 합니다. API가 윤초를 허용하는 경우 값에 60을 사용할 수 있습니다.
nanos

integer

나노초 단위의 초수입니다. 0~999,999,999 사이의 값이어야 합니다.

OffPeakUpdate

사용량이 많지 않은 업데이트 제한.

JSON 표현 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
필드
updateOffPeakWindow

object (TimeWindow)

업데이트를 다운로드할 수 있는 사용량이 많지 않은 시간대를 선택합니다. Google Play 서비스 6.7.72 이상이 필요합니다.
updateOffPeakDays

enum (UpdateOffPeakDays)

선택사항입니다. 값이 OFF_PEAK_DAYS_UNSPECIFIED이면 서버는 기본값 OFF_PEAK_UPDATE_ONE_DAY을 사용합니다. Google Play 서비스 6.5 이상이 필요합니다.
updateOperatorRestriction

enum (CellularOperatorRestriction)

선택사항입니다. 값을 지정하지 않으면 서버는 기본값 ALL_NETWORK_ALLOWED을 사용합니다. Google Play 서비스 6.7.72 이상이 필요합니다.

UpdateOffPeakDays

사용량이 많지 않은 시간에 업데이트 다운로드를 시도할 수 있는 기간(일)

열거형
OFF_PEAK_DAYS_UNSPECIFIED 지정되지 않음
OFF_PEAK_UPDATE_ONE_DAY 1일
OFF_PEAK_UPDATE_THREE_DAYS 3일
OFF_PEAK_UPDATE_SEVEN_DAYS 7일.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14일
OFF_PEAK_UPDATE_THIRTY_DAYS 30일

CellularOperatorRestriction

사용량이 많지 않은 기간에 제한을 적용하여 OTA 다운로드가 처음 수신된 이동통신사로 제한되도록 하려면 CELLULAR_OPERATOR_RESTRICTED로 설정합니다. mobileNetworkRestriction와 함께 사용하여 사용량이 많지 않은 다운로드를 특정 통신사로 제한하는 멀티 SIM 기기에 사용하기 위한 용도입니다.

열거형
OPERATOR_RESTRICTED_UNSPECIFIED 지정되지 않음
CELLULAR_OPERATOR_RESTRICTED 사용량이 많지 않은 기간은 OTA가 처음 수신된 이동통신사에만 적용됩니다.
ALL_NETWORK_ALLOWED 사용량이 많지 않은 기간은 모든 네트워크에 적용됩니다.

IncludeExclude

쉼표로 구분된 특정 패턴을 포함하거나 제외합니다.

JSON 표현 
{

  // Union field include_exclude can be only one of the following:
  "include": string,
  "exclude": string
  // End of list of possible types for union field include_exclude.
}
필드
통합 필드 include_exclude. 포함 또는 제외 규칙입니다. include_exclude은 다음 중 하나여야 합니다.
include

string

포함된 패턴입니다. 여러 값이 허용되는 경우 쉼표를 사용하여 값을 구분합니다.
exclude

string

제외된 패턴입니다. 여러 값이 허용되는 경우 쉼표를 사용하여 값을 구분합니다.

SpaceNeed

바이트 단위의 공간 요구사항입니다.

열거형
SPACE_NEED_UNSPECIFIED 지정되지 않음
ONE_HUNDRED_MB 100MB
ONE_HUNDRED_AND_FIFTY_MB 150MB
TWO_HUNDRED_AND_FIFTY_MB 250MB
FIVE_HUNDRED_MB 500MB

RolloutStep

출시 단계 구성요소입니다.

JSON 표현 
{
  "rolloutTime": string,
  "fraction": number
}
필드
rolloutTime

string (Timestamp format)

출시 타임스탬프

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

number

0.00에서 100.00 사이의 백분율로 표시되는 비율입니다.

ConfigDetails

구성 세부정보입니다.

JSON 표현 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
필드
postConditions[]

object (Condition)

구성 설치 사후 조건
packages[]

object (PackageConfig)

이 구성에서 정의된 패키지입니다. 중요: 패키지 순서는 중요합니다. 기기가 여러 전제조건과 일치하면 마지막으로 일치하는 패키지가 우선 적용되고 기기에 적용됩니다.
groups[]

string

이 구성의 연결된 그룹입니다.
versionTag

object (VersionTag)

출력 전용. 구성 버전

ReminderDialogSettings

지정된 시간이 지나면 사용자에게 표시되는 모달 알림 대화상자를 제어하는 설정입니다.

JSON 표현 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
필드
start

enum (Start)

알림 표시를 시작할 시간입니다.
remindMeLaterDuration

enum (RemindLaterDuration)

기간 '나중에 알림' 버튼이 표시됩니다.
frequency

enum (Frequency)

닫기 후 빈도 알림이 표시됩니다.

시작

알림 대화상자를 표시하는 경우 예를 들어 START_TWO_DAYS로 설정하면 업데이트를 받은 지 2일 후에 사용자에게 알림이 표시됩니다. START_UNSPECIFIED를 그대로 두면 기본값 START_SEVEN_DAYS이 사용됩니다.

열거형
START_UNSPECIFIED 지정되지 않음
NEVER_START 알림을 시작하지 않습니다.
START_ZERO_DAYS 즉시 시작합니다.
START_TWO_DAYS 2일 후 시작됩니다.
START_SEVEN_DAYS 7일 후에 시작됩니다.
START_FOURTEEN_DAYS 14일 후에 시작됩니다. 다음 태그: 6

RemindLaterDuration

대화상자에 '나중에 알림' 버튼이 표시되는 시간 버튼을 항상 표시하려면 ALWAYS_SHOW을 선택하고 버튼을 표시하지 않으려면 NEVER_SHOW를 선택합니다. LATER_DURATION_UNSPECIFIED를 그대로 두면 기본값 LATER_FOURTEEN_DAYS이 사용됩니다.

열거형
LATER_DURATION_UNSPECIFIED 지정되지 않음
NEVER_SHOW 버튼을 표시하지 않습니다.
ALWAYS_SHOW 항상 버튼을 표시합니다.
LATER_SEVEN_DAYS 7일 후 버튼 삭제
LATER_FOURTEEN_DAYS 14일이 지나면 버튼이 삭제됩니다.
LATER_TWENTY_ONE_DAYS 21일 후 버튼 삭제

빈도

사용자가 리마인더 대화상자를 닫은 후 다시 표시될 때까지의 시간입니다. FREQUENCY_UNSPECIFIED를 그대로 두면 기본값 FREQUENCY_SEVEN_DAYS이 사용됩니다.

열거형
FREQUENCY_UNSPECIFIED 지정되지 않음
FREQUENCY_ONE_DAY 리마인더를 매일 표시합니다.
FREQUENCY_THREE_DAYS 3일마다 알림을 표시합니다.
FREQUENCY_SEVEN_DAYS 7일마다 알림을 표시합니다.

방법

create

 config를 만들고 새 Config를 반환합니다.

delete

 config를 삭제합니다.

disable

 지정된 구성이 있는 사용 설정된 모든 그룹을 사용 중지합니다.

get

 config 뷰를 가져옵니다.

list

 배포의 configs를 나열합니다.

update

 config을 업데이트합니다.

updatePackages

 구성 아래에서 패키지를 업데이트합니다.