Notifiche per le modifiche alle risorse

Questo documento descrive come utilizzare le notifiche push che informano la tua applicazione quando una risorsa cambia.

Panoramica

L'API Google Drive fornisce notifiche push che ti consentono di monitorare le modifiche alle risorse. Puoi utilizzare questa funzionalità per migliorare le prestazioni della tua applicazione. Consente di eliminare i costi aggiuntivi di rete e di calcolo associati al polling delle risorse per determinare se sono cambiate. Ogni volta che una risorsa monitorata cambia, l'API Google Drive invia una notifica alla tua applicazione.

Per utilizzare le notifiche push, devi fare due cose:

  • Configura l'URL di ricezione o il ricevitore di callback "webhook".

    Si tratta di un server HTTPS che gestisce i messaggi di notifica API attivati quando una risorsa cambia.

  • Configura un (canale di notifica) per ogni endpoint risorsa che vuoi monitorare.

    Un canale specifica le informazioni di routing per i messaggi di notifica. Nell'ambito della configurazione del canale, devi identificare l'URL specifico in cui vuoi ricevere le notifiche. Ogni volta che la risorsa di un canale cambia, l'API Google Drive invia un messaggio di notifica come richiesta POST a quell'URL.

Al momento, l'API Google Drive supporta le notifiche per le modifiche ai metodi files e changes.

Creare canali di notifica

Per richiedere le notifiche push, devi configurare un canale di notifica per ogni risorsa che vuoi monitorare. Una volta configurati i canali di notifica, l'API Google Drive informa la tua applicazione quando una risorsa monitorata cambia.

Effettuare richieste per lo smartwatch

Ogni risorsa API Google Drive visualizzabile ha un metodo watch associato a un URI nel seguente formato:

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

Per configurare un canale di notifica per i messaggi relativi alle modifiche a una determinata risorsa, invia una richiesta POST al metodo watch per la risorsa.

Ogni canale di notifica è associato sia a un utente specifico sia a una risorsa (o a un insieme di risorse) specifica. Una richiesta watch non andrà a buon fine a meno che l'utente attuale o l'account di servizio non possieda o non disponga dell'autorizzazione per accedere a questa risorsa.

Esempi

Il seguente esempio di codice mostra come utilizzare una risorsa channels per iniziare a monitorare le modifiche a una singola risorsa files utilizzando il metodo 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.
}

Il seguente esempio di codice mostra come utilizzare una risorsa channels per iniziare a monitorare tutte le changes utilizzando il metodo 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.
}

Proprietà obbligatorie

Per ogni richiesta watch, devi fornire questi campi:

  • Una stringa di proprietà id che identifica in modo univoco questo nuovo canale di notifica all'interno del tuo progetto. Ti consigliamo di utilizzare un identificatore univoco universale (UUID) o qualsiasi stringa univoca simile. Lunghezza massima: 64 caratteri.

    Il valore dell'ID che hai impostato viene restituito nell'intestazione HTTP X-Goog-Channel-Id di ogni messaggio di notifica che ricevi per questo canale.

  • Una stringa di proprietà type impostata sul valore web_hook.

  • Una stringa della proprietà address impostata sull'URL che ascolta e risponde alle notifiche per questo canale di notifica. Questo è l'URL di callback del webhook e deve utilizzare HTTPS.

    Tieni presente che l'API Google Drive è in grado di inviare notifiche a questo indirizzo HTTPS solo se sul tuo server web è installato un certificato SSL valido. I certificati non validi includono:

    • Certificati autofirmati.
    • Certificati firmati da una fonte non attendibile.
    • Certificati revocati.
    • Certificati con un soggetto che non corrisponde al nome host di destinazione.

Proprietà facoltative

Puoi anche specificare questi campi facoltativi con la tua richiesta watch:

  • Una proprietà token che specifica un valore stringa arbitrario da utilizzare come token del canale. Puoi utilizzare i token del canale di notifica per vari scopi. Ad esempio, puoi utilizzare il token per verificare che ogni messaggio in arrivo sia destinato a un canale creato dalla tua applicazione, per assicurarti che la notifica non sia falsificata o per indirizzare il messaggio alla destinazione corretta all'interno della tua applicazione in base allo scopo di questo canale. Lunghezza massima: 256 caratteri.

    Il token è incluso nell'intestazione HTTP X-Goog-Channel-Token di ogni messaggio di notifica che la tua applicazione riceve per questo canale.

    Se utilizzi i token dei canali di notifica, ti consigliamo di:

    • Utilizza un formato di codifica estensibile, ad esempio i parametri di query URL. Esempio: forwardTo=hr&createdBy=mobile

    • Non includere dati sensibili come i token OAuth.

  • Una stringa di proprietà expiration impostata su un timestamp Unix (in millisecondi) della data e dell'ora in cui vuoi che l'API Google Drive interrompa l'invio di messaggi per questo canale di notifica.

    Se un canale ha un tempo di scadenza, questo viene incluso come valore dell'intestazione HTTP X-Goog-Channel-Expiration (in formato leggibile) in ogni messaggio di notifica che la tua applicazione riceve per questo canale.

Per maggiori dettagli sulla richiesta, consulta il metodo watch per i metodi files e changes nel Riferimento API.

Risposta dello smartwatch

Se la richiesta watch crea correttamente un canale di notifica, restituisce un codice di stato HTTP 200 OK.

Il corpo del messaggio della risposta dello smartwatch fornisce informazioni sul canale di notifica che hai appena creato, come mostrato nell'esempio seguente.

{
  "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.
}

Oltre alle proprietà inviate nell'ambito della richiesta, le informazioni restituite includono anche resourceId e resourceUri per identificare la risorsa visualizzata su questo canale di notifica.

Puoi passare le informazioni restituite ad altre operazioni del canale di notifica, ad esempio quando vuoi interrompere la ricezione delle notifiche.

Per ulteriori dettagli sulla risposta, consulta il metodo watch per i metodi files e changes nel Riferimento API.

Sincronizza messaggio

Dopo aver creato un canale di notifica per monitorare una risorsa, l'API Google Drive invia un messaggio sync per indicare che le notifiche stanno per iniziare. Il valore dell'intestazione HTTP X-Goog-Resource-State per questi messaggi è sync. A causa di problemi di sincronizzazione della rete, è possibile ricevere il messaggio sync anche prima di ricevere la risposta del metodo watch.

Puoi ignorare la notifica sync, ma puoi anche utilizzarla. Ad esempio, se decidi di non voler mantenere il canale, puoi utilizzare i valori X-Goog-Channel-ID e X-Goog-Resource-ID in una chiamata per interrompere la ricezione delle notifiche. Puoi anche utilizzare la notifica sync per eseguire alcune operazioni di inizializzazione in preparazione a eventi successivi.

Di seguito è riportato il formato dei messaggi sync che l'API Google Drive invia all'URL di ricezione.

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

I messaggi di sincronizzazione hanno sempre un valore dell'intestazione HTTP X-Goog-Message-Number pari a 1. Ogni notifica successiva per questo canale ha un numero di messaggio maggiore di quello precedente, anche se i numeri di messaggio non saranno sequenziali.

Rinnovo dei canali di notifica

Un canale di notifica può avere un tempo di scadenza, con un valore determinato dalla tua richiesta o da eventuali limiti o valori predefiniti interni dell'API Google Drive (viene utilizzato il valore più restrittivo). L'eventuale scadenza del canale è inclusa come timestamp Unix (in millisecondi) nelle informazioni restituite dal metodo watch. Inoltre, la data e l'ora di scadenza (in formato leggibile) sono incluse in ogni messaggio di notifica che la tua applicazione riceve per questo canale nell'intestazione HTTP X-Goog-Channel-Expiration.

Al momento non esiste un modo automatico per rinnovare un canale di notifica. Quando un canale è vicino alla scadenza, devi sostituirlo con uno nuovo chiamando il metodo watch. Come sempre, devi utilizzare un valore univoco per la proprietà id del nuovo canale. Tieni presente che è probabile che si verifichi un periodo di "sovrapposizione" di tempo in cui i due canali di notifica per la stessa risorsa sono attivi.

Ricevere notifiche

Ogni volta che una risorsa monitorata cambia, la tua applicazione riceve un messaggio di notifica che descrive la modifica. L'API Google Drive invia questi messaggi come richieste HTTPS POST all'URL specificato come proprietà address per questo canale di notifica.

Interpretare il formato del messaggio di notifica

Tutti i messaggi di notifica includono un insieme di intestazioni HTTP con prefissi X-Goog-. Alcuni tipi di notifiche possono includere anche un corpo del messaggio.

Intestazioni

I messaggi di notifica pubblicati dall'API Google Drive nell'URL di ricezione includono le seguenti intestazioni HTTP:

Intestazione Descrizione
Sempre presente
X-Goog-Channel-ID UUID o altra stringa univoca fornita per identificare questo canale di notifica.
X-Goog-Message-Number Numero intero che identifica questo messaggio per questo canale di notifica. Il valore è sempre 1 per i messaggi sync. I numeri dei messaggi aumentano per ogni messaggio successivo sul canale, ma non sono sequenziali.
X-Goog-Resource-ID Un valore opaco che identifica la risorsa osservata. Questo ID è stabile nelle varie versioni dell'API.
X-Goog-Resource-State Il nuovo stato della risorsa che ha attivato la notifica. Valori possibili: sync, add, remove, update, trash, untrash o change .
X-Goog-Resource-URI Un identificatore specifico della versione API per la risorsa visualizzata.
A volte presente
X-Goog-Changed Ulteriori dettagli sulle modifiche. Valori possibili: content, parents, children o permissions . Non fornito con i messaggi sync.
X-Goog-Channel-Expiration Data e ora di scadenza del canale di notifica, espresse in formato leggibile. Presente solo se definito.
X-Goog-Channel-Token Token del canale di notifica impostato dalla tua applicazione e che puoi utilizzare per verificare l'origine della notifica. Presente solo se definito.

I messaggi di notifica per files e changes sono vuoti.

Esempi

Modifica del messaggio di notifica per le risorse files, che non include un corpo della richiesta:

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

Messaggio di notifica di modifica per le risorse changes, che include un corpo della richiesta:

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"
}

Risposta alle notifiche

Per indicare l'operazione riuscita, puoi restituire uno dei seguenti codici di stato: 200, 201, 202, 204 o 102.

Se il tuo servizio utilizza la libreria client delle API di Google e restituisce 500,502, 503 o 504, l'API Google Drive ritenta con il backoff esponenziale. Tutti gli altri codici di stato del reso vengono considerati un errore del messaggio.

Informazioni sugli eventi di notifica dell'API Google Drive

Questa sezione fornisce dettagli sui messaggi di notifica che puoi ricevere quando utilizzi le notifiche push con l'API Google Drive.

X-Goog-Resource-State Si applica a Consegnato quando
sync files, changes Un canale è stato creato. Dovresti iniziare a ricevere notifiche.
add files È stata creata o condivisa una risorsa.
remove files Una risorsa esistente è stata eliminata o la condivisione è stata annullata.
update files Una o più proprietà (metadati) di una risorsa sono state aggiornate.
trash files Una risorsa è stata spostata nel cestino.
untrash files Una risorsa è stata rimossa dal cestino.
change changes Uno o più elementi del log delle modifiche sono stati aggiunti.

Per gli eventi update, potrebbe essere fornita l'intestazione HTTP X-Goog-Changed. L'intestazione contiene un elenco separato da virgole che descrive i tipi di modifiche apportate.

Tipo di modifica Indica
content I contenuti della risorsa sono stati aggiornati.
properties Una o più proprietà delle risorse sono state aggiornate.
parents Uno o più genitori della risorsa sono stati aggiunti o rimossi.
children Uno o più figli della risorsa sono stati aggiunti o rimossi.
permissions Le autorizzazioni della risorsa sono state aggiornate.

Esempio con intestazione X-Goog-Changed:

X-Goog-Resource-State: update
X-Goog-Changed: content, permissions

Interrompi la ricezione di notifiche

La proprietà expiration controlla quando le notifiche si interrompono automaticamente. Puoi scegliere di interrompere la ricezione delle notifiche per un canale specifico prima della scadenza chiamando il metodo stop all'indirizzo URI seguente:

https://www.googleapis.com/drive/v3/channels/stop

Questo metodo richiede di fornire almeno le proprietà id e resourceId del canale, come mostrato nell'esempio di seguito. Tieni presente che se l'API Google Drive ha diversi tipi di risorse con metodi watch, esiste un solo metodo stop.

Solo gli utenti con l'autorizzazione corretta possono interrompere un canale. In particolare:

  • Se il canale è stato creato da un account utente normale, solo lo stesso utente dello stesso client (identificato dagli ID client OAuth 2.0 dei token di autenticazione) che ha creato il canale può interromperlo.
  • Se il canale è stato creato da un service account, qualsiasi utente dello stesso client può interrompere il canale.

Il seguente esempio di codice mostra come interrompere la ricezione delle notifiche:

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"
}