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é au compte Google propriétaire de cette session dans son navigateur Web.

Pour des raisons de sécurité, l'pickerUri ne peut pas être ouvert dans un iframe.

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 des éléments multimédias n'ont pas encore été sélectionnés pour cette session (c'est-à-dire, mediaItemsSet est faux).

expireTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 pendant cette session.

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

mediaItemsSet

boolean

Uniquement en sortie. Si la valeur est 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. Intervalle recommandé entre les requêtes 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 l'interrogation.

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'articles que l'utilisateur peut sélectionner au cours de cette session. Si ce nombre n'est pas spécifié, la valeur par défaut est 2 000.

Si cette valeur n'est pas spécifiée ou est définie sur 0, vous ne pouvez sélectionner que 2 000 éléments maximum. Les valeurs supérieures à 2 000 sont réduites à 2 000. Les valeurs négatives génèrent une erreur INVALID_ARGUMENT.

Méthodes

create

Génère une nouvelle session au cours de 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.