REST Resource: deployments.configs

Ressource: Config

La configuration d'un déploiement.

Représentation 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)
  }
}
Champs
name

string

Uniquement en sortie. Nom de la configuration. Notez qu'il s'agit de l'identifiant unique des objets Config. Il est généré par le serveur lorsqu'un élément Config est créé.
title

string

Facultatif. Titre de la configuration.
description

string

Facultatif. Description de la configuration.
defaultUpdateDescription

object (UpdateDescription)

Obligatoire. Texte d'interface utilisateur par défaut utilisé lorsque les paramètres régionaux de l'appareil ne correspondent à aucun des paramètres régionaux spécifiés dans localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Facultatif. Liste de descriptions de mises à jour localisées, prioritaires sur defaultUpdateDescription si l'une d'entre elles correspond aux paramètres régionaux de l'appareil.
urgencyMode

enum (UrgencyMode)

Facultatif. Urgence de la mise à jour qui détermine la manière dont l'utilisateur sera invité à effectuer une mise à jour. Si aucune valeur n'est spécifiée, la valeur par défaut MANDATORY sera utilisée.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Facultatif. Délai déterminant le moment auquel l'installation de la mise à jour aura lieu pendant la nuit. Si aucune valeur n'est spécifiée, la valeur par défaut est NEVER.
wifiOnlyTime

enum (WifiOnlyTime)

Facultatif. La valeur par défaut est SEVEN_DAYS si la valeur est WIFI_ONLY_TIME_UNSPECIFIED.

Remarque: La valeur est FOREVER si urgencyMode est RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

Facultatif. Période d'installation de l'OTA.
packageSizeAwareBatteryThreshold

boolean

Facultatif. Indique si les seuils de batterie d'installation doivent être différents en fonction de sa taille pour la mise à jour.
offPeakUpdate

object (OffPeakUpdate)

Facultatif. Objet de mise à jour durant les périodes de pointe.
countryRestriction

object (IncludeExclude)

Facultatif. Pays inclus/exclus possibles.
mobileNetworkRestriction

object (IncludeExclude)

Facultatif. Réseaux mobiles inclus/exclus identifiés par les codes mcc/mnc. Notez que cela doit être utilisé exclusivement avec mobileNetworkCarrierRestriction. Vous ne pouvez pas définir ces deux champs en même temps.
deviceBuildPropertyRestriction

object (IncludeExclude)

Facultatif. Les éventuelles restrictions de propriété de construction d'appareils incluses/exclues.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Facultatif. Les opérateurs de réseau mobile inclus/exclus possibles. Notez que cela doit être utilisé exclusivement avec mobileNetworkRestriction. Vous ne pouvez pas définir ces deux champs en même temps.

Pour afficher les mises en correspondance, consultez la section Mobile Country Code et Mobile Network Code.
updateRequiredSetup

boolean

Facultatif. Indique si la mise à jour est requise dans l'assistant de configuration. Valeur par défaut : "false".
minimalSpaceRequired

enum (SpaceNeed)

Facultatif. Espace minimal requis. Lorsque cette valeur est UNSPECIFIED, le serveur ne définit aucune restriction. Nécessite les services Google Play 6.1.11 ou version ultérieure.
immediateRelease

boolean

Facultatif. Vous devez indiquer l'une des valeurs suivantes : immediateRelease ou rolloutSteps. Indique si la mise à jour doit être publiée immédiatement. Si c'est le cas, rolloutSteps ne doit pas être défini.
rolloutSteps[]

object (RolloutStep)

Facultatif. Vous devez indiquer l'une des valeurs suivantes : rolloutSteps ou immediateRelease. Les étapes de déploiement doivent être dans l'ordre: time_ms et fraction ne doivent pas diminuer. La dernière étape doit avoir une fraction == 100.
securityUpdate

boolean

Facultatif. Marque la mise à jour comme mise à jour de sécurité. Il est transmis à l'appareil pour coordonner l'affichage du message de mise à jour correct. Autrement dit, pour afficher le texte "Application de la mise à jour de sécurité" plutôt que "Application de la mise à jour du système". Nécessite le niveau d'API 22 ou version ultérieure, ainsi que les services Google Play 9.4 ou version ultérieure.
details

object (ConfigDetails)

Uniquement en sortie. Plus de détails sur une configuration. Cette valeur ne doit être renvoyée par le serveur que lors du renvoi de la configuration.
allowEncryptedScheduledInstall

boolean

Facultatif. Indique si l'installation d'un package sur des appareils chiffrés est autorisée ou non.
reminderDialogSettings

object (ReminderDialogSettings)

Facultatif. Paramètres de la boîte de dialogue modale pour rappeler aux utilisateurs qu'une mise à jour est en attente.

UpdateDescription

Description de la mise à jour envoyée à l'appareil.

Représentation JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Champs
description

string

Texte de la description de la mise à jour.
title

string

Titre de la description de la mise à jour.
dialogMessage

string

Message de la boîte de dialogue de mise à jour.
postSuccessMessage

string

Message de confirmation du post de la mise à jour. Nécessite le niveau d'API 14 ou supérieur.
postFailureMessage

string

Message d'échec de l'intégration de la mise à jour. Nécessite le niveau d'API 14 ou supérieur.

LocalizedUpdateDescription

Description de la mise à jour en fonction des paramètres régionaux.

Représentation JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Champs
locales[]

string

Paramètres régionaux correspondant à ceux de l'appareil.
updateDescription

object (UpdateDescription)

Description de la mise à jour envoyée à l'appareil.

UrgencyMode

Mode d'urgence pour la migration

Enums
MODE_UNSPECIFIED Non spécifié.
RECOMMENDED Recommandez une mise à niveau. L'utilisateur est invité à télécharger et à installer la mise à jour.
MANDATORY Mise à niveau obligatoire. La mise à jour sera téléchargée automatiquement, mais l'utilisateur sera invité à lancer l'installation.
AUTOMATIC Migration automatique. La mise à jour sera téléchargée et installée automatiquement.

ScheduledInstallDelay

Délai entre la disponibilité de la mise à jour et la programmation automatique de l'installation.

Enums
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Valeur par défaut. Sera traité comme NJAMAIS.
SCHEDULED_INSTALL_DELAY_NEVER Ne jamais escalader à l'installation automatique.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Période de zéro jour (immédiatement)
SCHEDULED_INSTALL_DELAY_ONE_DAY Période d'un jour.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Période de deux jours.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Période de trois jours.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Période de quatre jours.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Période de cinq jours.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Période de 10 jours.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Période de 15 jours.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Période de 30 jours.

WifiOnlyTime

Le réseau mobile sera exclu pendant cette période une fois la mise à jour disponible.

Enums
WIFI_ONLY_TIME_UNSPECIFIED Non spécifié.
NONE Non bloquée.
TWENTY_FOUR_HOURS Période de 24 heures.
THREE_DAYS Période de trois jours.
SEVEN_DAYS Période de sept jours.
FOURTEEN_DAYS Période de 14 jours.
TWENTY_ONE_DAYS Période de 20 jours.
FOREVER Fenêtre indéfinie.

TimeWindow

Période qui définit l'heure de début d'une journée et l'heure de fin dans une journée.

Représentation JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Champs
startTime

object (TimeOfDay)

Heure de début de la fenêtre.
stopTime

object (TimeOfDay)

Heure d'arrêt de la fenêtre.

TimeOfDay

Représente une heure de la journée. La date et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. Une API peut choisir d'autoriser des secondes intercalaires. Les types associés sont google.type.Date et google.protobuf.Timestamp.

Représentation JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Champs
hours

integer

Heure de la journée au format 24 heures. Elle doit être comprise entre 0 à 23. Une API peut choisir d'autoriser la valeur "24:00:00" pour des cas tels que l'heure de fermeture des bureaux.
minutes

integer

Minutes de l'heure de la journée. Elles doivent être comprises entre 0 à 59.
seconds

integer

Secondes de l'heure de la journée. Elles doivent normalement être comprises entre 0 et 59. Une API peut autoriser la valeur 60 si elle autorise les secondes intercalaires.
nanos

integer

Fractions de secondes en nanosecondes. La valeur doit être comprise entre 0 et 999 999 999.

OffPeakUpdate

Limite de mises à jour pendant les heures creuses.

Représentation JSON 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
Champs
updateOffPeakWindow

object (TimeWindow)

Période creuses pour télécharger la mise à jour. Nécessite les services Google Play 6.7.72 ou version ultérieure.
updateOffPeakDays

enum (UpdateOffPeakDays)

Facultatif. Lorsque la valeur est OFF_PEAK_DAYS_UNSPECIFIED, le serveur utilise la valeur par défaut OFF_PEAK_UPDATE_ONE_DAY. Nécessite les services Google Play 6.5 ou version ultérieure.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Facultatif. Si aucune valeur n'est spécifiée, le serveur utilise la valeur par défaut ALL_NETWORK_ALLOWED. Nécessite les services Google Play 6.7.72 ou version ultérieure.

UpdateOffPeakDays

Nombre de jours pendant lesquels vous essayez de télécharger la mise à jour pendant les heures creuses.

Enums
OFF_PEAK_DAYS_UNSPECIFIED Non spécifié.
OFF_PEAK_UPDATE_ONE_DAY 1 jour.
OFF_PEAK_UPDATE_THREE_DAYS 3 jours.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 jours.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 jours.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 jours.

CellularOperatorRestriction

Définissez la valeur sur CELLULAR_OPERATOR_RESTRICTED pour imposer une restriction sur la fenêtre hors heures de pointe afin que le téléchargement OTA soit limité à l'opérateur mobile auquel il a été reçu en premier. Destiné aux appareils avec plusieurs cartes SIM lorsqu'il est utilisé avec mobileNetworkRestriction pour limiter les téléchargements hors heures de pointe à un opérateur spécifique.

Enums
OPERATOR_RESTRICTED_UNSPECIFIED Non spécifié.
CELLULAR_OPERATOR_RESTRICTED La période creuses ne s'applique qu'à l'opérateur de téléphonie mobile sur lequel la mise à jour OTA a été reçue pour la première fois.
ALL_NETWORK_ALLOWED La période creuses s'applique à tous les réseaux.

IncludeExclude

Inclut ou exclut certains formats d'éléments séparés par une virgule.

Représentation 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.
}
Champs
Champ d'union include_exclude. Règle d'inclusion ou d'exclusion. include_exclude ne peut être qu'un des éléments suivants :
include

string

Modèle inclus. Si plusieurs valeurs sont autorisées, séparez-les par une virgule.
exclude

string

Format exclu. Si plusieurs valeurs sont autorisées, séparez-les par une virgule.

SpaceNeed

Exigences d'espace en octets.

Enums
SPACE_NEED_UNSPECIFIED Non spécifié.
ONE_HUNDRED_MB 100 Mo.
ONE_HUNDRED_AND_FIFTY_MB 150 Mo.
TWO_HUNDRED_AND_FIFTY_MB 250 Mo.
FIVE_HUNDRED_MB 500 Mo.

RolloutStep

Composant de l'étape de déploiement.

Représentation JSON 
{
  "rolloutTime": string,
  "fraction": number
}
Champs
rolloutTime

string (Timestamp format)

Horodatage de déploiement.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
fraction

number

Fraction exprimée par un pourcentage compris entre 0,00 et 100,00.

ConfigDetails

Détails d'une configuration.

Représentation JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Champs
postConditions[]

object (Condition)

Conditions post-installation de la configuration
packages[]

object (PackageConfig)

Packages définis de cette configuration. Important: L'ordre des colis est important. Si un appareil correspond à plusieurs ensembles de conditions préalables, le dernier package correspondant l'emporte et lui est appliqué.
groups[]

string

Groupes associés à cette configuration.
versionTag

object (VersionTag)

Uniquement en sortie. Version de la configuration.

ReminderDialogSettings

Paramètres contrôlant une boîte de dialogue de rappel modale qui s'affiche après le délai spécifié.

Représentation JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Champs
start

enum (Start)

Quand l'affichage du rappel doit-il commencer ?
remindMeLaterDuration

enum (RemindLaterDuration)

Durée d'affichage du bouton "Me le rappeler plus tard"
frequency

enum (Frequency)

Le rappel de fréquence s'affiche après la désactivation.

Commencer

Quand afficher une boîte de dialogue de rappel ? Par exemple, si elle est définie sur START_TWO_DAYS, un rappel s'affiche deux jours après la réception de la mise à jour. Si vous conservez la valeur START_UNSPECIFIED, la valeur par défaut START_SEVEN_DAYS sera utilisée.

Enums
START_UNSPECIFIED Non spécifié.
NEVER_START Ne lancez jamais le rappel.
START_ZERO_DAYS Démarrez immédiatement.
START_TWO_DAYS Commencer au bout de deux jours
START_SEVEN_DAYS Commencer au bout de sept jours
START_FOURTEEN_DAYS Commencer au bout de 14 jours. BALISE SUIVANTE: 6

RemindLaterDuration

Durée d'affichage du bouton "Me le rappeler plus tard" dans la boîte de dialogue. Sélectionnez ALWAYS_SHOW pour afficher le bouton en permanence et NEVER_SHOW pour ne jamais l'afficher. Si vous conservez la valeur LATER_DURATION_UNSPECIFIED, la valeur par défaut LATER_FOURTEEN_DAYS sera utilisée.

Enums
LATER_DURATION_UNSPECIFIED Non spécifié.
NEVER_SHOW Ne jamais afficher le bouton
ALWAYS_SHOW Toujours afficher le bouton
LATER_SEVEN_DAYS Supprimer le bouton au bout de sept jours.
LATER_FOURTEEN_DAYS Supprimer le bouton au bout de 14 jours.
LATER_TWENTY_ONE_DAYS Supprimer le bouton au bout de 21 jours.

Fréquence

Une fois que l'utilisateur a fermé la boîte de dialogue de rappel, combien de temps avant qu'elle ne s'affiche à nouveau. Si vous conservez la valeur FREQUENCY_UNSPECIFIED, la valeur par défaut FREQUENCY_SEVEN_DAYS sera utilisée.

Enums
FREQUENCY_UNSPECIFIED Non spécifié.
FREQUENCY_ONE_DAY Afficher le rappel tous les jours.
FREQUENCY_THREE_DAYS Affichez le rappel tous les trois jours.
FREQUENCY_SEVEN_DAYS Affichez le rappel tous les sept jours.

Méthodes

create

 Crée un config et renvoie le nouveau Config.

delete

 Supprime un config.

disable

 Désactive tous les groupes activés pour lesquels la configuration est spécifiée.

get

 Récupère une vue config.

list

 Répertorie les configs d'un déploiement.

update

 Met à jour une config.

updatePackages

 Mettez à jour les packages dans la configuration.