Neste documento, descrevemos como usar notificações push que informam seu aplicativo quando um recurso é modificado.
Visão geral
A API Google Drive oferece notificações push que permitem monitorar alterações nos recursos. Use esse recurso para melhorar o desempenho do aplicativo. Isso permite eliminar a rede extra e os custos de computação envolvidos na pesquisa de recursos para determinar se eles mudaram. Sempre que um recurso monitorado é alterado, a API Google Drive notifica o aplicativo.
Para usar as notificações push, você precisa fazer duas coisas:
Configure o URL de recebimento ou o receptor de callback "webhook".
É um servidor HTTPS que processa as mensagens de notificação de API acionadas quando um recurso é modificado.
Configure um canal de notificação para cada endpoint de recurso que você quer assistir.
Um canal especifica informações de roteamento para mensagens de notificação. Como parte da configuração do canal, você precisa identificar o URL específico em que quer receber as notificações. Sempre que um recurso de um canal muda, a API Google Drive envia uma mensagem de notificação como uma solicitação
POST
para esse URL.
Atualmente, a API Google Drive é compatível com notificações de mudanças nos métodos files
e changes
.
Criar canais de notificação
Para solicitar notificações push, configure um canal de notificação para cada recurso que você quer monitorar. Depois que os canais de notificação são configurados, a API Google Drive informa ao seu aplicativo quando qualquer recurso monitorado muda.
Fazer solicitações para assistir
Cada recurso da API Google Drive visualizável tem um método
watch
associado em um URI com o formato a seguir:
https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch
Para configurar um canal de notificação para mensagens sobre mudanças em um recurso específico, envie uma solicitação POST
para o método watch
do recurso.
Cada canal de notificação está associado a um usuário específico e a um recurso (ou conjunto de recursos) específico. Uma solicitação watch
não terá êxito, a menos que o usuário atual ou a conta de serviço seja proprietário ou tenha permissão para acessar esse recurso.
Exemplos
O exemplo de código a seguir mostra como usar um recurso channels
para começar a monitorar alterações em um único recurso files
usando o método files.watch
:
POST https://www.googleapis.com/drive/v3/files/fileId/watch Authorization: Bearer CURRENT_USER_AUTH_TOKEN Content-Type: application/json { "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID. "type": "web_hook", "address": "https://mydomain.com/notifications", // Your receiving URL. ... "token": "target=myApp-myFilesChannelDest", // (Optional) Your files channel token. "expiration": 1426325213000 // (Optional) Your requested channel expiration date and time. }
O exemplo de código a seguir mostra como usar um recurso channels
para começar a monitorar todos os changes
usando o método changes.watch
:
POST https://www.googleapis.com/drive/v3/changes/watch Authorization: Bearer CURRENT_USER_AUTH_TOKEN Content-Type: application/json { "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a77", // Your channel ID. "type": "web_hook", "address": "https://mydomain.com/notifications", // Your receiving URL. ... "token": "target=myApp-myChangesChannelDest", // (Optional) Your changes channel token. "expiration": 1426325213000 // (Optional) Your requested channel expiration date and time. }
Propriedades obrigatórias
Em cada solicitação watch
, é necessário preencher estes campos:
-
Uma string de propriedade
id
que identifica exclusivamente esse novo canal de notificação no projeto. Recomendamos o uso de um identificador universal exclusivo (UUID) ou qualquer string exclusiva semelhante. Tamanho máximo: 64 caracteres.O valor do ID definido é retornado no cabeçalho HTTP
X-Goog-Channel-Id
de todas as mensagens de notificação recebidas para esse canal. -
Uma string de propriedade
type
definida como o valorweb_hook
. -
Uma string de propriedade
address
definida como o URL que detecta e responde às notificações desse canal. Esse é o URL do callback do webhook, que precisa usar HTTPS.Observe que a API Google Drive só consegue enviar notificações para esse endereço HTTPS quando há um certificado SSL válido instalado no seu servidor da Web. Certificados inválidos incluem:
- Certificados autoassinados.
- Certificados assinados por uma fonte não confiável.
- Certificados que foram revogados
- Certificados com um assunto que não corresponde ao nome do host de destino.
Propriedades opcionais
Também é possível especificar esses campos opcionais com sua solicitação watch
:
-
Uma propriedade
token
que especifica um valor de string arbitrário para ser usado como um token de canal. É possível usar tokens de canal de notificação para várias finalidades. Por exemplo, você pode usar o token para verificar se cada mensagem recebida é de um canal criado pelo aplicativo, para garantir que a notificação não esteja sendo falsificada, ou para rotear a mensagem para o destino correto no seu aplicativo com base na finalidade desse canal. Comprimento máximo: 256 caracteres.O token é incluído no cabeçalho HTTP
X-Goog-Channel-Token
em todas as mensagens de notificação que seu aplicativo recebe para esse canal.Se você usar tokens de canal de notificação, recomendamos que faça o seguinte:
Use um formato de codificação extensível, como parâmetros de consulta de URL. Exemplo:
forwardTo=hr&createdBy=mobile
Não inclua dados sensíveis, como tokens OAuth.
-
Uma string de propriedade
expiration
definida como um carimbo de data/hora Unix (em milissegundos) da data e hora em que você quer que a API Google Drive pare de enviar mensagens para esse canal de notificação.Se um canal tiver um prazo de validade, ele será incluído como o valor do cabeçalho HTTP
X-Goog-Channel-Expiration
(em formato legível) em todas as mensagens de notificação que seu aplicativo recebe para esse canal.
Para mais detalhes sobre a solicitação, consulte o método watch
para os métodos files
e changes
na Referência da API.
Assistir resposta
Se a solicitação watch
criar um canal de notificação, ela retornará um código de status HTTP 200 OK
.
O corpo da mensagem da resposta do relógio fornece informações sobre o canal de notificação que você acabou de criar, conforme mostrado no exemplo abaixo.
{ "kind": "api#channel", "id": "01234567-89ab-cdef-0123456789ab"", // ID you specified for this channel. "resourceId": "o3hgv1538sdjfh", // ID of the watched resource. "resourceUri": "https://www.googleapis.com/drive/v3/files/o3hgv1538sdjfh", // Version-specific ID of the watched resource. "token": "target=myApp-myFilesChannelDest", // Present only if one was provided. "expiration": 1426325213000, // Actual expiration date and time as UNIX timestamp (in milliseconds), if applicable. }
Além das propriedades enviadas como parte da solicitação, as informações retornadas também incluem resourceId
e resourceUri
para identificar o recurso que está sendo monitorado nesse canal de notificação.
É possível transmitir as informações retornadas para outras operações de canal de notificação, como quando você quer parar de receber notificações.
Para mais detalhes sobre a resposta, consulte o método watch
para os métodos files
e changes
na Referência da API.
Sincronizar mensagem
Depois de criar um canal de notificação para monitorar um recurso, a
API Google Drive envia uma mensagem sync
para indicar que
as notificações estão sendo iniciadas. O valor do cabeçalho HTTP
X-Goog-Resource-State
para essas mensagens é sync
. Devido a problemas
de tempo de rede, é possível receber a mensagem sync
mesmo antes de receber a resposta do método watch
.
Você pode ignorar a notificação sync
, mas ela também pode ser usada. Por exemplo, se você decidir que não quer manter
o canal, é possível usar os valores X-Goog-Channel-ID
e
X-Goog-Resource-ID
em uma chamada para
parar de receber notificações. Também é possível usar a
notificação sync
para fazer algumas inicializações e se preparar para
eventos futuros.
Veja abaixo o formato das mensagens sync
que a API Google Drive envia para o URL de recebimento.
POST https://mydomain.com/notifications // Your receiving URL. X-Goog-Channel-ID: channel-ID-value X-Goog-Channel-Token: channel-token-value X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires. X-Goog-Resource-ID: identifier-for-the-watched-resource X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource X-Goog-Resource-State: sync X-Goog-Message-Number: 1
As mensagens de sincronização sempre têm um valor de cabeçalho HTTP
X-Goog-Message-Number
de 1
. Cada notificação subsequente para esse canal tem um número de mensagem maior que o anterior, embora os números de mensagens não sejam sequenciais.
Renovar canais de notificação
Um canal de notificação pode ter um prazo de validade, com um valor determinado pela sua solicitação ou por quaisquer limites internos ou padrões da API Google Drive (o valor mais restritivo é usado). O prazo de validade do canal, se houver, é incluído como um carimbo de data/hora Unix (em milissegundos) nas informações retornadas pelo método watch
. Além disso, a data e a hora de validade são incluídas (em formato legível) em todas as mensagens de notificação que o aplicativo recebe para esse canal no cabeçalho HTTP X-Goog-Channel-Expiration
.
No momento, não há como renovar um canal de notificação de forma automática. Quando
um canal estiver perto de expirar, será necessário substituí-lo por um novo chamando
o método watch
. Como sempre, você precisa usar um valor exclusivo para a propriedade id
do novo canal. É provável
que haja um período de "sobreposição" quando os dois canais de notificação do
mesmo recurso estiverem ativos.
Receber notificações
Sempre que um recurso monitorado muda, o aplicativo recebe uma
mensagem de notificação descrevendo a mudança. A API Google Drive envia essas mensagens como solicitações POST
HTTPS para o URL especificado como a propriedade address
do canal de notificação.
Interpretar o formato da mensagem de notificação
Todas as mensagens de notificação incluem um conjunto de cabeçalhos HTTP com prefixos
X-Goog-
.
Alguns tipos de notificação também podem incluir o
corpo de uma mensagem.
Cabeçalhos
As mensagens de notificação postadas pela API Google Drive no URL de recebimento incluem os seguintes cabeçalhos HTTP:
Cabeçalho | Descrição |
---|---|
Sempre presente | |
|
UUID ou outra string exclusiva fornecida para identificar esse canal de notificação. |
|
Número inteiro que identifica a mensagem do canal de
notificação. O valor é sempre 1 para mensagens sync . Os números de mensagens aumentam a cada mensagem subsequente no canal, mas não são sequenciais. |
|
Um valor opaco que identifica o recurso monitorado. Esse ID é estável em todas as versões da API. |
|
O novo estado do recurso que acionou a notificação.
Valores possíveis:
sync , add , remove , update ,
trash , untrash ou change
.
|
|
Um identificador específico da versão da API para o recurso monitorado. |
Às vezes presente | |
|
Mais detalhes sobre as mudanças.
Valores possíveis:
content ,
parents ,
children ou
permissions
.
Não fornecido com mensagens de sync . |
|
Data e hora da expiração do canal de notificação, expressas em formato legível. Presente apenas se definido. |
|
Token do canal de notificação que foi definido pelo seu aplicativo e que você pode usar para verificar a origem da notificação. Presente apenas se definido. |
As mensagens de notificação para files
e changes
estão vazias.
Exemplos
Mudar a mensagem de notificação de files
recursos, que não inclui o corpo da solicitação:
POST https://mydomain.com/notifications // Your receiving URL. Content-Type: application/json; utf-8 Content-Length: 0 X-Goog-Channel-ID: 4ba78bf0-6a47-11e2-bcfd-0800200c9a66 X-Goog-Channel-Token: 398348u3tu83ut8uu38 X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT X-Goog-Resource-ID: ret08u3rv24htgh289g X-Goog-Resource-URI: https://www.googleapis.com/drive/v3/files/ret08u3rv24htgh289g X-Goog-Resource-State: update X-Goog-Changed: content,properties X-Goog-Message-Number: 10
Alterar mensagem de notificação para recursos changes
, que inclui o corpo da solicitação:
POST https://mydomain.com/notifications // Your receiving URL. Content-Type: application/json; utf-8 Content-Length: 118 X-Goog-Channel-ID: 8bd90be9-3a58-3122-ab43-9823188a5b43 X-Goog-Channel-Token: 245t1234tt83trrt333 X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT X-Goog-Resource-ID: ret987df98743md8g X-Goog-Resource-URI: https://www.googleapis.com/drive/v3/changes X-Goog-Resource-State: changed X-Goog-Message-Number: 23 { "kind": "drive#changes" }
Responder a notificações
Para indicar o sucesso, retorne qualquer um destes códigos de status:
200
, 201
, 202
, 204
ou
102
.
Se o serviço usar a biblioteca de cliente da API do Google e retornar 500
, 502
, 503
ou 504
, a API Google Drive tentará novamente com espera exponencial.
Todos os outros códigos de status de retorno são considerados falhas de mensagem.
Entender os eventos de notificação da API Google Drive
Esta seção fornece detalhes sobre as mensagens de notificação que você pode receber ao usar as notificações push com a API Google Drive.
Entregue quando | ||
---|---|---|
sync |
files , changes |
Um canal foi criado. Você vai começar a receber notificações sobre ele. |
add |
files |
Um recurso foi criado ou compartilhado. |
|
files |
Um recurso existente foi excluído ou não está mais compartilhado. |
|
files |
Uma ou mais propriedades (metadados) de um recurso foram atualizadas. |
|
files |
Um recurso foi movido para a lixeira. |
|
files |
Um recurso foi removido da lixeira. |
|
changes |
Um ou mais itens do log de mudanças foram adicionados. |
Para eventos update
, o cabeçalho HTTP X-Goog-Changed
pode ser fornecido. Esse cabeçalho contém uma lista separada por vírgulas que descreve os tipos de alterações ocorridas.
Tipo de mudança | Indica |
---|---|
content |
O conteúdo do recurso foi atualizado. |
properties |
Uma ou mais propriedades do recurso foram atualizadas. |
parents |
Um ou mais recursos pais foram adicionados ou removidos. |
children |
Um ou mais filhos de recursos foram adicionados ou removidos. |
permissions |
As permissões do recurso foram atualizadas. |
Exemplo com cabeçalho X-Goog-Changed
:
X-Goog-Resource-State: update X-Goog-Changed: content, permissions
Parar notificações
A propriedade expiration
controla quando as notificações são interrompidas automaticamente. Você pode optar por parar de receber notificações para um canal específico antes que ele expire chamando o método stop
no seguinte URI:
https://www.googleapis.com/drive/v3/channels/stop
Esse método requer que você forneça pelo menos as propriedades
id
e resourceId
do canal, conforme mostrado no
exemplo abaixo. Se a API Google Drive tiver vários tipos de
recursos com métodos watch
, haverá apenas um
método stop
.
Somente usuários com a permissão correta podem interromper um canal. Especificamente, faça o seguinte:
- Se o canal foi criado por uma conta de usuário normal, apenas o mesmo usuário do mesmo cliente (conforme identificado pelos IDs do cliente OAuth 2.0 nos tokens de autenticação) que criou o canal poderá interromper o canal.
- Se o canal foi criado por uma conta de serviço, qualquer usuário do mesmo cliente pode interrompê-lo.
O exemplo de código a seguir mostra como parar de receber notificações:
POST https://www.googleapis.com/drive/v3/channels/stop Authorization: Bearer CURRENT_USER_AUTH_TOKEN Content-Type: application/json { "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66", "resourceId": "ret08u3rv24htgh289g" }