REST Resource: sessions

Zasób: PickingSession

Prezentacja sesji użytkownika, podczas której może on wybierać zdjęcia i filmy za pomocą Zdjęć Google.

Zapis JSON
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Pola
id

string

Tylko dane wyjściowe. Wygenerowany przez Google identyfikator tej sesji.

pickerUri

string

Tylko dane wyjściowe. Identyfikator URI używany do przekierowania użytkownika do Zdjęć Google (w internecie), aby mógł wybrać zdjęcia i filmy na potrzeby bieżącej sesji.

Aby wyświetlić tę stronę, użytkownik musi zalogować się w przeglądarce na konto Google, które jest właścicielem tej sesji.

Ze względów bezpieczeństwa nie można otworzyć pickerUri w ramce iframe.

W przypadku aplikacji internetowych możesz dodać do tego URI znak /autoclose. Okno lub karta Zdjęć Google zamknie się automatycznie po zakończeniu wyboru przez użytkownika, zamiast wyświetlać ekran „Gotowe”.

pollingConfig

object (PollingConfig)

Tylko dane wyjściowe. Zalecana konfiguracja, której aplikacje powinny używać podczas odpytywania sessions.get.

To pole jest wypełniane tylko wtedy, gdy w tej sesji nie wybrano jeszcze elementów multimedialnych (tzn. mediaItemsSet ma wartość fałsz).

expireTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym wygaśnie dostęp do tej sesji (i wybranych w niej multimediów).

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

pickingConfig

object (PickingConfig)

Opcjonalnie: Konfiguracja wyboru zdjęć dla użytkownika podczas tej sesji.

Jest on określany przez aplikację kliencką podczas wywoływania funkcji sessions.create i nie można go później zmienić (bez tworzenia nowej sesji).

mediaItemsSet

boolean

Tylko dane wyjściowe. Jeśli wartość tego parametru to true, oznacza to, że elementy multimedialne zostały wybrane na potrzeby tej sesji, a aplikacja może poprosić o listę wybranych elementów multimedialnych za pomocą parametru mediaItems.list.

PollingConfig

Konfiguracja sondowania interfejsu API.

Zapis JSON
{
  "pollInterval": string,
  "timeoutIn": string
}
Pola
pollInterval

string (Duration format)

Tylko dane wyjściowe. Zalecany czas między żądaniami sondy.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

timeoutIn

string (Duration format)

Tylko dane wyjściowe. Czas, po którym klient powinien przestać wysyłać zapytania.

Wartość 0 oznacza, że klient powinien przestać wysyłać zapytania, jeśli jeszcze tego nie zrobił.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

PickingConfig

Konfiguracja określona przez klienta dotycząca wyboru użytkownika podczas tej sesji.

Zapis JSON
{
  "maxItemCount": string
}
Pola
maxItemCount

string (int64 format)

Opcjonalnie: Maksymalna liczba produktów, które użytkownik może wybrać podczas tej sesji. Jeśli nie zostanie podana, domyślnie przyjmuje wartość 2000.

Jeśli nie zostanie określona lub będzie mieć wartość 0, można wybrać maksymalnie 2000 produktów. Wartości powyżej 2000 zostaną zmienione na 2000. Wartości ujemne spowodują błąd INVALID_ARGUMENT.

Metody

create

Generuje nową sesję, podczas której użytkownik może wybrać zdjęcia i filmy, do których dostęp będą miały aplikacje innych firm.

delete

Usuwa określoną sesję.

get

Pobiera informacje o określonej sesji.