REST Resource: sessions

Ressource: PickingSession

Darstellung einer Nutzersitzung, in der der Nutzer Fotos und Videos mit Google Fotos auswählen kann.

JSON-Darstellung 
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Felder
id

string

Nur Ausgabe. Die von Google generierte Kennung für diese Sitzung.
pickerUri

string

Nur Ausgabe. Der URI, über den der Nutzer zu Google Fotos (im Web) weitergeleitet wird, damit er Fotos und Videos für die aktuelle Sitzung auswählen kann.

Damit diese Seite angezeigt werden kann, muss der Nutzer in seinem Webbrowser in dem Google-Konto angemeldet sein, zu dem diese Sitzung gehört.

Die pickerUri kann aus Sicherheitsgründen nicht in einem Iframe geöffnet werden.
pollingConfig

object (PollingConfig)

Nur Ausgabe. Die empfohlene Konfiguration, die Anwendungen beim Abfragen von sessions.get verwenden sollten.

Dieses Feld wird nur ausgefüllt, wenn für diese Sitzung noch keine Medienelemente ausgewählt wurden (d.h. mediaItemsSet ist falsch).
expireTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem der Zugriff auf diese Sitzung (und die ausgewählten Medienelemente) abläuft.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
pickingConfig

object (PickingConfig)

Optional. Konfiguration der Bildauswahl für die Auswahl des Nutzers während dieser Sitzung.

Dieser wird von der Clientanwendung beim Aufrufen von sessions.create angegeben und kann nicht nachträglich geändert werden, ohne eine neue Sitzung zu erstellen.
mediaItemsSet

boolean

Nur Ausgabe. Wenn true festgelegt ist, wurden für diese Sitzung Medienelemente ausgewählt und deine Anwendung kann die Liste der ausgewählten Medienelemente über mediaItems.list anfordern.

PollingConfig

Konfiguration für das Abfragen der API.

JSON-Darstellung 
{
  "pollInterval": string,
  "timeoutIn": string
}
Felder
pollInterval

string (Duration format)

Nur Ausgabe. Empfohlene Zeit zwischen Abfrageanfragen.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
timeoutIn

string (Duration format)

Nur Ausgabe. Die Zeitspanne, nach der der Client das Polling beenden soll.

Der Wert 0 gibt an, dass der Client die Abfrage beenden soll, falls er dies noch nicht getan hat.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

PickingConfig

Vom Kunden angegebene Konfiguration für die Auswahl des Nutzers während dieser Sitzung.

JSON-Darstellung 
{
  "maxItemCount": string
}
Felder
maxItemCount

string (int64 format)

Optional. Die maximale Anzahl von Artikeln, die der Nutzer während dieser Sitzung auswählen kann. Wenn keine Angabe gemacht wird, ist der Standardwert 2.000.

Wenn nicht angegeben oder auf 0 festgelegt, können maximal 2.000 Artikel ausgewählt werden. Werte über 2.000 werden auf 2.000 festgelegt. Negative Werte führen zu einem INVALID_ARGUMENT-Fehler.

Methoden

create

 Erzeugt eine neue Sitzung, in der der Nutzer Fotos und Videos für den Zugriff von Drittanbietern auswählen kann.

delete

 Löscht die angegebene Sitzung.

get

 Ruft Informationen zur angegebenen Sitzung ab.