REST Resource: sessions

Recurso: PickingSession

Representação de uma sessão do usuário em que ele pode escolher fotos e vídeos usando o Google Fotos.

Representação JSON
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Campos
id

string

Apenas saída. O identificador gerado pelo Google para esta sessão.

pickerUri

string

Apenas saída. O URI usado para redirecionar o usuário ao Google Fotos (na Web) para que ele possa escolher fotos e vídeos para a sessão atual.

Para acessar essa página, o usuário precisa fazer login na Conta do Google proprietária da sessão no navegador da Web.

O pickerUri não pode ser aberto em um iframe por motivos de segurança.

Para aplicativos baseados na Web, você pode anexar /autoclose a esse URI. A janela ou guia do Google Fotos será fechada automaticamente depois que o usuário terminar de escolher, em vez de mostrar uma tela "Concluído".

pollingConfig

object (PollingConfig)

Apenas saída. A configuração recomendada que os aplicativos devem usar ao fazer polling de sessions.get.

Esse campo só é preenchido se os itens de mídia ainda não tiverem sido escolhidos para esta sessão (ou seja, mediaItemsSet é false).

expireTime

string (Timestamp format)

Apenas saída. O horário em que o acesso a esta sessão (e aos itens de mídia escolhidos) vai expirar.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

pickingConfig

object (PickingConfig)

Opcional. Configuração de seleção de fotos para a experiência do usuário durante esta sessão.

Ele é especificado pelo aplicativo cliente ao chamar sessions.create e não pode ser modificado depois (sem criar uma nova sessão).

mediaItemsSet

boolean

Apenas saída. Se definido como true, os itens de mídia foram escolhidos para esta sessão, e seu aplicativo pode solicitar a lista de itens escolhidos usando mediaItems.list.

PollingConfig

Configuração para pesquisar a API.

Representação JSON
{
  "pollInterval": string,
  "timeoutIn": string
}
Campos
pollInterval

string (Duration format)

Apenas saída. Tempo recomendado entre solicitações de pesquisa.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

timeoutIn

string (Duration format)

Apenas saída. O período de tempo após o qual o cliente deve parar de fazer pesquisas.

Um valor de 0 indica que o cliente precisa parar de fazer pesquisas, caso ainda não tenha feito isso.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

PickingConfig

Configuração especificada pelo cliente para a experiência de seleção do usuário durante esta sessão.

Representação JSON
{
  "maxItemCount": string
}
Campos
maxItemCount

string (int64 format)

Opcional. O número máximo de itens que o usuário pode escolher durante esta sessão. O padrão é 2.000 se não for especificado.

Se não for especificado ou definido como 0, no máximo 2.000 itens poderão ser escolhidos. Valores acima de 2.000 serão convertidos para 2.000. Valores negativos resultam em um erro INVALID_ARGUMENT.

Métodos

create

Gera uma nova sessão em que o usuário pode escolher fotos e vídeos para acesso de terceiros.

delete

Exclui a sessão especificada.

get

Recupera informações sobre a sessão especificada.