Damit Ihre App in Google Drive angezeigt wird, wenn ein Nutzer eine Datei erstellt oder öffnet, müssen Sie zuerst eine Drive-Benutzeroberfläche einrichten. Außerdem ist eine Konfiguration erforderlich, damit Ihre App im Google Workspace Marketplace aufgeführt werden kann.
Drive API aktivieren
Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.
Wenn Sie die Google Drive-Benutzeroberfläche einbinden möchten, müssen Sie die Drive API aktivieren. Dadurch erhalten Sie Zugriff auf die API und die Funktionen zur UI-Integration.
Aktivieren Sie in der Google Cloud Console die Google Drive API.
Drive-UI-Integration einrichten
- Klicken Sie in der Google API Console auf das Dreistrich-Menü > APIs und Dienste > Aktivierte APIs und Dienste.
- Klicken Sie unten im Dashboard „APIs und Dienste“ auf Google Drive API. Die Konfigurationsseite der Google Drive API wird angezeigt.
- Wählen Sie den Tab Drive UI-Integration aus.
- Optional: Geben Sie im Feld Name der Anwendung einen Namen ein. Der Name der Anwendung wird Nutzern in den Drive-Einstellungen auf dem Tab „Apps verwalten“ angezeigt.
- Optional: Geben Sie im Feld Kurze Beschreibung eine kurze Beschreibung in einer Zeile ein. Die Kurzbeschreibung wird Nutzern auf dem Tab „Apps verwalten“ in den Drive-Einstellungen angezeigt.
- Optional: Geben Sie im Feld Lange Beschreibung eine vollständige Beschreibung ein.
Laden Sie ein oder mehrere App-Symbole hoch, die in der Liste der verbundenen Drive-Apps eines Nutzers und im Kontextmenü „Mit öffnen“ angezeigt werden sollen. Symbole sollten im PNG-Format mit transparentem Hintergrund vorliegen. Es kann bis zu 24 Stunden dauern, bis Symbole in Drive angezeigt werden.
Wenn Sie das Menüelement „Mit“ in der Drive-Benutzeroberfläche verwenden möchten, geben Sie die URL Ihrer App in das Feld URL öffnen ein. Diese URL wird vom Kontextmenü „Öffnen mit“ verwendet.
- Diese URL muss einen voll qualifizierten Domainnamen enthalten.
localhostfunktioniert nicht. - Diese URL sollte für die vorgesehenen Nutzer Ihrer Anwendung zugänglich sein. Wenn Sie mehrere Anwendungsversionen haben, z. B. eine für die öffentliche Version und eine für die eingeschränkte Version für ausgewählte Nutzer, sollte für jede Version eine eindeutige URL verwendet werden. Anschließend können Sie für jede Version unterschiedliche App-Konfigurationen erstellen.
- Sie müssen bestätigen, wer der Eigentümer dieser URL ist, bevor Sie Ihre App im Google Workspace Marketplace anbieten können.
- Standardmäßig wird dieser URL ein
state-Suchparameter angehängt, um Daten von der Drive-Benutzeroberfläche an Ihre App zu übergeben. Informationen zum Inhalt desstate-Parameters finden Sie unter Derstate-Parameter.
- Diese URL muss einen voll qualifizierten Domainnamen enthalten.
Optional: Geben Sie in den Feldern Standard-MIME-Typen und Standarddateiendung Standard-MIME-Typen und Standarddateiendungen ein. Standard-MIME-Typen und Dateierweiterungen stehen für Dateien, die Ihre App speziell zum Öffnen konzipiert wurde. Ihre App kann beispielsweise ein integriertes Format zum Hinzufügen von Ebenen und Bearbeiten von Bildern öffnen. Geben Sie nur standardmäßige Medientypen an und achten Sie darauf, dass sie keine Tippfehler enthalten. Wenn Ihre App nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie den MIME-Typ leer lassen.
Optional: Geben Sie in den Feldern Sekundäre MIME-Typen und Sekundäre Dateiendungen sekundäre MIME-Typen und Dateiendungen ein. Sekundäre MIME-Typen und Dateiendungen stehen für Dateien, die Ihre App öffnen kann, aber nicht für Ihre App spezifisch sind. Ihre App kann beispielsweise eine Bildbearbeitungs-App sein, die PNG- und JPG-Bilder öffnet. Geben Sie nur standardmäßige Medientypen an und achten Sie darauf, dass sie keine Tippfehler enthalten. Wenn Ihre App nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie den MIME-Typ leer lassen.
Wenn Sie die Schaltfläche „Neu“ in der Drive-Benutzeroberfläche verwenden und Nutzer Dateien mit Ihrer App erstellen lassen möchten, setzen Sie ein Häkchen in das Kästchen Dateien erstellen. Die Felder Neue URL und optional Name des Dokuments werden angezeigt.
- Diese URL muss einen voll qualifizierten Domainnamen enthalten.
localhostfunktioniert nicht. - Sie müssen bestätigen, wer der Eigentümer dieser URL ist, bevor Sie Ihre App im Google Workspace Marketplace anbieten können.
- Standardmäßig wird dieser URL ein
state-Suchparameter angehängt, um Daten von der Drive-Benutzeroberfläche an Ihre App zu übergeben. Informationen zum Inhalt desstate-Parameters finden Sie unter Derstate-Parameter.
- Diese URL muss einen voll qualifizierten Domainnamen enthalten.
Geben Sie im Feld Neue URL eine URL ein. Über diese URL wird der Nutzer über die Schaltfläche „Neu“ zu Ihrer Anwendung weitergeleitet.
Optional: Wenn Ihre App von Google Workspace unterstützte Dateien öffnen soll, klicken Sie das Kästchen Importieren an.
Optional: Wenn Ihre App Dateien in geteilten Ablagen verwalten muss, klicken Sie auf das Kästchen Unterstützung für geteilte Ablagen. Weitere Informationen zur Unterstützung von geteilten Ablagen in Ihrer App finden Sie unter Unterstützung für geteilte Ablagen implementieren.
Klicken Sie auf Senden.
Umfang drive.install anfordern
Wenn Sie möchten, dass Apps im Menü „Öffnen mit“ oder „Neu“ angezeigt werden, beantragen Sie den Umfang https://www.googleapis.com/auth/drive.install, um die App in die Drive-Benutzeroberfläche einzubinden. Wenn Nutzer diesen Umfang anfordern, wird ihnen ein Dialogfeld ähnlich dem folgenden angezeigt:
Weitere Informationen zu Bereichen, die Sie für Drive-Apps anfordern können, und dazu, wie Sie sie anfordern, finden Sie unter API-spezifische Autorisierungs- und Authentifizierungsinformationen.
Der Parameter state
Standardmäßig wird sowohl der URL zum Öffnen als auch der URL für die neue Datei ein state-Parameter angehängt, um Daten von der Drive-Benutzeroberfläche an Ihre App zu übergeben. Dieser Parameter enthält einen JSON-codierten String mit Vorlagenvariablen und Daten zur Anfrage an Ihre App. Die enthaltenen Variablen hängen von der verwendeten URL-Art ab (URL zum Öffnen oder URL für die neue Datei):
| Vorlagenvariable | Beschreibung | URL-Anwendung |
|---|---|---|
{ids} |
Eine durch Kommas getrennte Liste der Datei-IDs, die geöffnet werden. | URL öffnen |
{exportIds} |
Eine durch Kommas getrennte Liste der zu exportierenden Datei-IDs (wird nur beim Öffnen von integrierten Google-Dokumenten verwendet). | URL öffnen |
{resourceKeys} |
Ein JSON-Wörterbuch mit Datei-IDs, die ihren jeweiligen Ressourcenschlüsseln zugeordnet sind. | URL öffnen |
{folderId} |
Die ID des übergeordneten Ordners. | Neue URL |
{folderResourceKey} |
Der Ressourcenschlüssel des übergeordneten Ordners. | Neue URL |
{userId} |
Die Profil-ID, die den Nutzer identifiziert. | „URL öffnen“ und „Neue URL“ |
{action} |
Die ausgeführte Aktion. Der Wert ist open, wenn eine „Öffnen-URL“ verwendet wird, und create, wenn eine „Neue URL“ verwendet wird.
|
„URL öffnen“ und „Neue URL“ |
Der Parameter state ist URL-codiert. Ihre App muss die Escape-Zeichen verarbeiten und als JSON parsen. Apps können den Wert create im Parameter state erkennen, um eine Anfrage zum Erstellen einer Datei zu überprüfen.
Beispiel für Statusinformationen in JSON für eine neue URL
Die state-Informationen für eine neue URL sind:
{
"action":"create",
"folderId":"FOLDER_ID",
"folderResourceKey":"FOLDER_RESOURCE_KEY",
"userId":"USER_ID"
}
Beispiel für Statusinformationen in JSON für eine geöffnete URL
Die state-Informationen für eine geöffnete URL sind:
{
"ids": ["ID"],
"resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
"action":"open",
"userId":"USER_ID"
}
Die IDs und Ressourcenschlüssel werden verwendet, um Dateimetadaten abzurufen und Dateiinhalte herunterzuladen. Sobald deine App die Datei-ID und ein Zugriffstoken hat, kann sie Berechtigungen prüfen, die Dateimetadaten abrufen und den Dateiinhalt wie in der Methode files.get beschrieben herunterladen.
Weitere Informationen
Eine installierte App muss Aktionen erstellen, verwalten und öffnen können, die über die Drive-Benutzeroberfläche gestartet werden. Weitere Informationen finden Sie unter Schaltfläche „Neu“ in der Drive-Benutzeroberfläche einbinden oder „Mit“-Kontextmenü in der Drive-Benutzeroberfläche einbinden.