Notificações sobre alterações de recursos

Este documento descreve como usar notificações push que informam seu aplicativo quando um recurso muda.

Visão geral

A API Google Drive oferece notificações push que permitem monitorar mudanças nos recursos. Você pode usar esse recurso para melhorar a performance do seu aplicativo. Ele permite eliminar os custos extras de rede e computação envolvidos na pesquisa de recursos para determinar se eles mudaram. Sempre que um recurso monitorado muda, a API Google Drive notifica seu aplicativo.

Para usar notificações push, faça duas coisas:

• Configure o URL de recebimento ou o receptor de callback do webhook.

  Esse é um servidor HTTPS que processa as mensagens de notificação da API acionadas quando um recurso muda.

• Configure um (canal de notificação) para cada endpoint de recurso que você quer monitorar.

  Um canal especifica informações de roteamento para mensagens de notificação mensagens. Como parte da configuração do canal, você precisa identificar o URL específico em que você quer receber notificações. Sempre que o recurso de um canal muda, a API Google Drive envia uma mensagem de notificação como uma POST solicitação para esse URL.

Observação: a palavra "canal" usada neste documento refere-se especificamente a um canal de notificação e não a outros tipos de canais usados nessa API ou serviço. Vários canais de notificação podem estar ativos ao mesmo tempo para o mesmo recurso.

No momento, a API Google Drive oferece suporte a notificações de mudanças para os 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 forem configurados, a API Google Drive vai informar seu aplicativo quando qualquer recurso monitorado mudar.

Fazer solicitações de monitoramento

Cada recurso da API Google Drive que pode ser monitorado tem um método watch associado a um URI do seguinte formato:

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 e a um recurso (ou conjunto de recursos) específico. Uma solicitação watch só será bem-sucedida se o usuário ou a conta de serviço atual for proprietário ou tiver permissão para acessar esse recurso.

Exemplos

O exemplo de código a seguir mostra como usar um channels recurso para começar a monitorar mudanças em um único files recurso 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",
  "type": "web_hook",
  "address": "https://mydomain.com/notifications",
  ...
  "token": "target=myApp-myFilesChannelDest",
  "expiration": 1426325213000
}

No corpo da solicitação, forneça o id do canal, o type como web_hook e o URL de recebimento em address. Você também pode fornecer opcionalmente:

• Um token para usar como token de canal.
• Um tempo de expiration em milissegundos para o tempo de expiração do canal solicitado.

O exemplo de código a seguir mostra como usar um channels recurso para começar a monitorar todas as 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",
  "type": "web_hook",
  "address": "https://mydomain.com/notifications",
  ...
  "token": "target=myApp-myChangesChannelDest",
  "expiration": 1426325213000
}

No corpo da solicitação, forneça o id do canal, o type como web_hook e o URL de recebimento em address. Você também pode fornecer opcionalmente:

• Um token para usar como token de canal.
• Um tempo de expiration em milissegundos para o tempo de expiração do canal solicitado.

Propriedades obrigatórias

Com cada solicitação watch, você precisa fornecer estes campos:

• Uma string de propriedade id que identifica exclusivamente esse novo canal de notificação no seu projeto. Recomendamos usar um identificador universal exclusivo (UUID) ou qualquer string exclusiva semelhante. Comprimento máximo: 64 caracteres.

  O valor do ID definido é repetido no X-Goog-Channel-Id cabeçalho HTTP de cada mensagem de notificação recebida para esse canal.

• Uma string de propriedade type definida como o valor web_hook.

• Uma string de propriedade address definida como o URL que escuta e responde a notificações para esse canal de notificação. Esse é o URL de callback do webhook, e ele precisa usar HTTPS.

  A API Google Drive só pode enviar notificações para esse endereço HTTPS se houver 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 que têm um assunto que não corresponde ao nome do host de destino.

Propriedades opcionais

Você também pode especificar estes campos opcionais com sua watch solicitação:

• Uma propriedade token que especifica um valor de string arbitrário para usar como token de canal. Você pode usar tokens de canal de notificação para várias finalidades. Por exemplo, é possível usar o token para verificar se cada mensagem recebida é de um canal criado pelo seu aplicativo (para garantir que a notificação não seja falsificada) ou para encaminhar a mensagem para o destino certo no aplicativo com base na finalidade desse canal. Comprimento máximo: 256 caracteres.

  O token é incluído no X-Goog-Channel-Token cabeçalho HTTP em cada mensagem de notificação que seu aplicativo recebe para esse canal.

  Se você usar tokens de canal de notificação, recomendamos que:

  • 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.

  Observação: se você precisar enviar dados altamente sensíveis, criptografe-os antes de adicioná-los ao token.

• 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 tempo de expiração, ele será incluído como o valor do cabeçalho HTTP X-Goog-Channel-Expiration (em formato legível ) em cada mensagem de notificação que seu aplicativo recebe para esse canal.

Observação: Para a API Google Drive, o tempo máximo de expiração é de 86.400 segundos (1 dia) após o horário atual para o recurso files e de 604.800 segundos (1 semana) para changes. Se você não definir a expiration propriedade na solicitação, o tempo de expiração será de 3.600 segundos após o horário atual.

Para mais detalhes sobre a solicitação, consulte o método watch para os métodos files e changes na referência da API.

Resposta de monitoramento

Se a solicitação watch criar um canal de notificação, ela vai retornar um código de status HTTP 200 OK.

O corpo da mensagem da resposta de monitoramento 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",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://www.googleapis.com/drive/v3/files/o3hgv1538sdjfh",
  "token": "target=myApp-myFilesChannelDest",
  "expiration": 1426325213000
}

O corpo da resposta fornece detalhes do canal, como:

• kind: identifica isso como um recurso de canal da API.
• id: o ID especificado para esse canal.
• resourceId: o ID do recurso monitorado.
• resourceUri: o ID específico da versão do recurso monitorado.
• token: o token fornecido no corpo da solicitação.
• expiration: o tempo de expiração do canal como um carimbo de data/hora Unix em milissegundos.

Além das propriedades enviadas como parte da solicitação, as informações retornadas também incluem o resourceId e resourceUri para identificar o recurso que está sendo monitorado nesse canal de notificação.

Observação: A propriedade resourceId é um identificador estável e independente da versão do recurso. A propriedade resourceUri é o URI canônico do recurso monitorado no contexto da versão atual da API, portanto, é específica da versão.

Você pode transmitir as informações retornadas para outras operações de canal de notificação, como quando quiser parar de receber notificações.

Para mais detalhes sobre a resposta, consulte o watch método para os files e changes métodos na referência da API.

Mensagem de sincronização

Depois de criar um canal de notificação para monitorar um recurso, a API Google Drive envia uma sync mensagem para indicar que as notificações estão começando. O valor do cabeçalho HTTP para estas mensagens é sync.X-Goog-Resource-State Devido a problemas de tempo de rede, é possível receber a mensagem sync mesmo antes de receber a resposta do método watch.

É seguro ignorar a notificação sync, mas você também pode usá-la. Por exemplo, se você decidir que não quer manter o canal, poderá usar os valores X-Goog-Channel-ID e X-Goog-Resource-ID em uma chamada para parar de receber notificações. Você também pode usar a sync notificação para fazer alguma inicialização para se preparar para eventos posteriores.

O formato das mensagens sync que a API Google Drive envia para o URL de recebimento é mostrado abaixo.

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 de 1.X-Goog-Message-Number Cada notificação subsequente para esse canal tem um número de mensagem maior que o anterior, embora os números de mensagem não sejam sequenciais.

Renovar canais de notificação

Um canal de notificação pode ter um tempo de expiração, com um valor determinado pela sua solicitação ou por limites ou padrões internos da API Google Drive (o valor mais restritivo é usado). O tempo de expiração do canal, se houver, será incluído como um carimbo de data/hora Unix (em milissegundos) nas informações retornadas pelo watch método. Além disso, a data e a hora de expiração são incluídas (em formato legível por humanos) em cada mensagem de notificação que seu aplicativo recebe para esse canal no X-Goog-Channel-Expiration cabeçalho HTTP.

No momento, não há uma maneira automática de renovar um canal de notificação. Quando um canal estiver perto da expiração, você precisará 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" em que os dois canais de notificação para o mesmo recurso estejam ativos.

Receber notificações

Sempre que um recurso monitorado muda, seu aplicativo recebe uma mensagem de notificação descrevendo a mudança. A API Google Drive envia essas mensagens como solicitações HTTPS POST para o URL especificado como a address propriedade desse canal de notificação.

Observação:as solicitações HTTPS de entrega de notificação especificam um user agent de APIs-Google e respeitam as diretivas robots.txt, conforme descrito em User agent das APIs Google.

Interpretar o formato da mensagem de notificação

Todas as mensagens de notificação incluem um conjunto de cabeçalhos HTTP que têm X-Goog- prefixos. Alguns tipos de notificações também podem incluir um corpo da 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
X-Goog-Channel-ID	UUID ou outra string exclusiva fornecida para identificar esse canal de notificação.
X-Goog-Message-Number	Número inteiro que identifica essa mensagem para esse canal de notificação. O valor é sempre 1 para mensagens sync. Os números de mensagem aumentam para cada mensagem subsequente no canal, mas não são sequenciais.
X-Goog-Resource-ID	Um valor opaco que identifica o recurso monitorado. Esse ID é estável em todas as versões da API.
X-Goog-Resource-State	O novo estado do recurso que acionou a notificação. Valores possíveis: sync, add, remove, update, trash, untrash, ou change .
X-Goog-Resource-URI	Um identificador específico da versão da API para o recurso monitorado.
Às vezes presente
X-Goog-Changed	Mais detalhes sobre as mudanças. Valores possíveis: content, parents, children, ou permissions . Não fornecido com mensagens sync.
X-Goog-Channel-Expiration	Data e hora de expiração do canal de notificação, expressas em formato legível. Presente apenas se definido.
X-Goog-Channel-Token	Token de canal de notificação definido pelo seu aplicativo e que pode ser usado para verificar a origem da notificação. Presente apenas se definido.

As mensagens de notificação para files e changes estão vazias.

Exemplos

Mensagem de notificação de mudança para recursos files, que não inclui um corpo de solicitação:

POST https://mydomain.com/notifications
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

Mensagem de notificação de mudança para recursos changes, que inclui um corpo de solicitação:

POST https://mydomain.com/notifications
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 sucesso, você pode retornar qualquer um dos seguintes 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 vai tentar novamente com espera exponencial. Qualquer outro código de status de retorno é considerado uma falha 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 notificações push com a API Google Drive.

X-Goog-Resource-State	Aplicável a	Entregue quando
sync	files, changes	Um canal foi criado. Você pode começar a receber notificações para ele.
add	files	Um recurso foi criado ou compartilhado.
remove	files	Um recurso existente foi excluído ou não compartilhado.
update	files	Uma ou mais propriedades (metadados) de um recurso foram atualizadas.
trash	files	Um recurso foi movido para a lixeira.
untrash	files	Um recurso foi removido da lixeira.
change	changes	Um ou mais itens de registro de mudanças foram adicionados.

Outros eventos de estado de recursos podem ser adicionados a essa lista ao longo do tempo. Você pode receber tipos de eventos inesperados. Seus gerenciadores de eventos precisam ignorá-los.

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 mudanças que ocorreram.

Tipo de alteração	Indica
content	O conteúdo do recurso foi atualizado.
properties	Uma ou mais propriedades de recursos foram atualizadas.
parents	Um ou mais familiares responsáveis foram adicionados ou removidos.
children	Um ou mais recursos filhos foram adicionados ou removidos.
permissions	As permissões de recursos 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 param automaticamente. Você pode 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 exige 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 certa podem parar um canal. Especificamente:

• Se o canal foi criado por uma conta de usuário normal, somente o mesmo usuário do mesmo cliente (conforme identificado pelos IDs de cliente OAuth 2.0 dos tokens de autenticação) que criou o canal poderá interrompê-lo.
• Se o canal foi criado por uma conta de serviço, qualquer usuário do mesmo cliente poderá 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"
}