REST Resource: deployments.configs

リソース: Config

Deployment の構成。

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

（省略可）設定ウィザードで更新が必要かどうかを示します。デフォルトは false です。
minimalSpaceRequired

enum (SpaceNeed)

（省略可）最小スペース要件。値が UNSPECIFIED の場合、サーバーは制限を設定しません。Google Play 開発者サービス 6.1.11 以降が必要です。
immediateRelease

boolean

（省略可）immediateRelease または rolloutSteps のいずれかが必要です。アップデートをすぐにリリースするかどうか。true の場合、rolloutSteps の設定を解除する必要があります。
rolloutSteps[]

object (RolloutStep)

（省略可）rolloutSteps または immediateRelease のいずれかが必要です。RolloutSteps は順番に指定する必要があります。time_ms と fraction はどちらも減らさないようにする必要があります。最後のステップでは割合が 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 ゼロデイ期間（即時）
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

1 日の開始時間と終了時間を定義する時間枠。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
フィールド
startTime

object (TimeOfDay)

ウィンドウの開始時間。
stopTime

object (TimeOfDay)

ウィンドウの終了時間。

TimeOfDay

1 日のうちの時刻を表します。日付とタイムゾーンは意味を持たないか、他の場所で指定されています。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

CELLULAR_OPERATOR_RESTRICTED に設定すると、オフピーク ウィンドウに制限が設定され、OTA ダウンロードが最初に受信した携帯通信会社に限定されます。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 100 MB。
ONE_HUNDRED_AND_FIFTY_MB 150 MB。
TWO_HUNDRED_AND_FIFTY_MB 250 MB。
FIVE_HUNDRED_MB 500 MB。

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 日ごとに表示します。

Methods

create

 config を作成し、新しい Config を返します。

delete

 config を削除します。

disable

 指定された構成を持つ、有効なすべてのグループを無効にします。

get

 config ビューを取得します。

list

 Deployment の configs を一覧表示します。

update

 config を更新します。

updatePackages

 config の下のパッケージを更新します。