REST Resource: sessions

Ressource: PickingSession

Darstellung einer Nutzersitzung, in der der Nutzer Fotos und Videos über 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, der verwendet wird, um den Nutzer zu Google Fotos (im Web) weiterzuleiten, damit er Fotos und Videos für die aktuelle Sitzung auswählen kann.

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

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

Bei webbasierten Anwendungen können Sie /autoclose an diesen URI anhängen. Das Google Fotos-Fenster oder der Google Fotos-Tab wird dann automatisch geschlossen, nachdem der Nutzer die Auswahl abgeschlossen hat. Es wird kein „Fertig“-Bildschirm mehr angezeigt.
pollingConfig

object (PollingConfig)

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

Dieses Feld wird nur ausgefüllt, wenn für diese Sitzung noch keine Media-Elemente ausgewählt wurden. mediaItemsSet ist „false“).
expireTime

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. 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 für die Auswahl von Fotos für den Nutzer während dieser Sitzung.

Dieser Wert wird von der Clientanwendung beim Aufrufen von sessions.create angegeben und kann danach nicht mehr geändert werden (ohne eine neue Sitzung zu erstellen).
mediaItemsSet

boolean

Nur Ausgabe. Wenn der Wert auf true gesetzt ist, wurden Media-Elemente für diese Sitzung ausgewählt und Ihre Anwendung kann die Liste der ausgewählten Media-Elemente über mediaItems.list anfordern.

PollingConfig

Konfiguration für das Abrufen 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 sollte.

Der Wert 0 gibt an, dass der Client das Polling beenden soll, falls er es noch nicht getan hat.

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

PickingConfig

Client-spezifische 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 implizit auf 2.000 umgewandelt. Negative Werte führen zu einem INVALID_ARGUMENT-Fehler.

Methoden

create

 Erstellt eine neue Sitzung, in der der Nutzer Fotos und Videos für den Zugriff durch Drittanbieter auswählen kann.

delete

 Löscht die angegebene Sitzung.

get

 Ruft Informationen zur angegebenen Sitzung ab.