REST Resource: sessions

Ressource : PickingSession

Représentation d'une session utilisateur au cours de laquelle l'utilisateur peut sélectionner des photos et des vidéos à l'aide de Google Photos.

Représentation JSON 
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Champs
id

string

Uniquement en sortie. Identifiant généré par Google pour cette session.
pickerUri

string

Uniquement en sortie. URI utilisé pour rediriger l'utilisateur vers Google Photos (sur le Web) afin qu'il puisse sélectionner des photos et des vidéos pour la session en cours.

Pour afficher cette page, l'utilisateur doit être connecté dans son navigateur Web au compte Google propriétaire de cette session.

Le pickerUri ne peut pas être ouvert dans un iFrame pour des raisons de sécurité.

Pour les applications Web, vous pouvez ajouter /autoclose à cet URI. La fenêtre ou l'onglet Google Photos se fermeront automatiquement une fois que l'utilisateur aura terminé sa sélection, au lieu d'afficher un écran "OK".
pollingConfig

object (PollingConfig)

Uniquement en sortie. Configuration recommandée que les applications doivent utiliser lors de l'interrogation de sessions.get.

Ce champ n'est renseigné que si aucun élément multimédia n'a encore été sélectionné pour cette session (c'est-à-dire mediaItemsSet est défini sur "false").
expireTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle l'accès à cette session (et à ses éléments multimédias sélectionnés) expirera.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
pickingConfig

object (PickingConfig)

Facultatif. Configuration de la sélection de photos pour l'expérience de sélection de l'utilisateur au cours de cette session.

Cette valeur est spécifiée par l'application cliente lors de l'appel de sessions.create et ne peut pas être modifiée par la suite (sans créer de session).
mediaItemsSet

boolean

Uniquement en sortie. Si la valeur est définie sur true, des éléments multimédias ont été sélectionnés pour cette session et votre application peut demander la liste des éléments multimédias sélectionnés via mediaItems.list.

PollingConfig

Configuration pour l'interrogation de l'API.

Représentation JSON 
{
  "pollInterval": string,
  "timeoutIn": string
}
Champs
pollInterval

string (Duration format)

Uniquement en sortie. Temps recommandé entre les demandes d'interrogation.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
timeoutIn

string (Duration format)

Uniquement en sortie. Durée au terme de laquelle le client doit arrêter d'interroger le serveur.

La valeur 0 indique que le client doit arrêter l'interrogation s'il ne l'a pas déjà fait.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

PickingConfig

Configuration spécifiée par le client pour l'expérience de sélection de l'utilisateur au cours de cette session.

Représentation JSON 
{
  "maxItemCount": string
}
Champs
maxItemCount

string (int64 format)

Facultatif. Nombre maximal d'éléments que l'utilisateur peut sélectionner au cours de cette session. En l'absence de spécification, la valeur par défaut est 2 000.

Si cette valeur n'est pas spécifiée ou est définie sur 0, 2 000 éléments au maximum peuvent être sélectionnés. Les valeurs supérieures à 2 000 seront ramenées à 2 000. Les valeurs négatives génèrent une erreur INVALID_ARGUMENT.

Méthodes

create

 Génère une session pendant laquelle l'utilisateur peut sélectionner des photos et des vidéos pour un accès tiers.

delete

 Supprime la session spécifiée.

get

 Récupère des informations sur la session spécifiée.