Integration der Drive-Benutzeroberfläche konfigurieren

Damit Ihre App in Google Drive angezeigt wird, wenn ein Nutzer eine Datei erstellt oder öffnet, müssen Sie zuerst eine Integration der Drive-Benutzeroberfläche (UI) einrichten. Die Konfiguration ist auch erforderlich, um Ihre Anwendung im Google Workspace Marketplace aufzulisten.

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.

Um mit der Einbindung der Google Drive-Benutzeroberfläche zu beginnen, müssen Sie die Drive API aktivieren. Dadurch erhalten Sie Zugriff auf die API und die UI-Integrationsfunktionen.

• Aktivieren Sie in der Google Cloud Console die Google Drive API.

  API aktivieren

Drive-UI-Integration einrichten

1. Klicken Sie in der Google API Console auf das Dreistrich-Menü menu > APIs und Dienste > Aktivierte APIs und Dienste.

   Zur Seite „Aktivierte APIs und Dienste“

2. Klicken Sie unten im Dashboard „APIs und Dienste“ auf Google Drive API. Die Konfigurationsseite der Google Drive API wird angezeigt.
3. Wählen Sie den Tab Drive-UI-Integration aus.
4. Optional: Geben Sie in das Feld Name der Anwendung einen Namen ein. Der Name der Anwendung wird Nutzern auf dem Tab „Apps verwalten“ in den Drive-Einstellungen angezeigt.
5. (Optional) Geben Sie in das Feld Kurzbeschreibung eine kurze, einzeilige Beschreibung ein. Die Kurzbeschreibung wird Nutzern auf dem Tab „Apps verwalten“ in den Drive-Einstellungen angezeigt.
6. Optional: Geben Sie im Feld Lange Beschreibung eine vollständige Beschreibung ein.

7. Laden Sie ein oder mehrere Anwendungssymbole hoch, die in der Liste der verbundenen Drive-Apps eines Nutzers und im Kontextmenü „Öffnen mit“ angezeigt werden sollen. Symbole sollten im PNG-Format mit transparentem Hintergrund vorliegen. Es kann bis zu 24 Stunden dauern, bis die Symbole in Drive angezeigt werden.

8. Wenn Sie das Menüelement „Öffnen mit“ der Drive-UI verwenden möchten, geben Sie die URL zu Ihrer App im Feld URL öffnen ein. Diese URL wird vom Kontextmenü „Öffnen mit“ verwendet.

   • Diese URL muss einen voll qualifizierten Domainnamen enthalten. localhost funktioniert nicht.
   • Diese URL sollte für die beabsichtigten Nutzer Ihrer Anwendung zugänglich sein. Wenn Sie mehrere Anwendungsversionen haben, z. B. eine für den öffentlichen Release und eine für den eingeschränkten Release für ausgewählte Nutzer, sollte jede Version eine eindeutige URL verwenden. Sie können dann für jede Version unterschiedliche Anwendungskonfigurationen erstellen.
   • Sie müssen die Inhaberschaft dieser URL bestätigen, bevor Sie Ihre Anwendung im Google Workspace Marketplace auflisten können.
   • Standardmäßig wird an diese URL der Abfrageparameter state angehängt, um Daten von der Drive-UI an Ihre Anwendung zu übergeben. Informationen zum Inhalt des Parameters state finden Sie unter Parameter state.

9. Optional: Geben Sie Standard-MIME-Typen und -Dateierweiterungen in die Felder Standard-MIME-Typen und Standard-Dateierweiterungen ein. Standard-MIME-Typen und Dateiendungen stellen Dateien dar, die von Ihrer Anwendung speziell erstellt wurden. Ihre App könnte beispielsweise ein integriertes Format zum Überlagern und Bearbeiten von Bildern öffnen. Fügen Sie nur standardmäßige Medientypen hinzu und achten Sie darauf, dass diese keine Tipp- und Rechtschreibfehler enthalten. Wenn Ihre Anwendung nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie den MIME-Typ leer lassen.

10. Optional: Geben Sie sekundäre MIME-Typen und Dateierweiterungen in die Felder Sekundäre MIME-Typen und Sekundäre Dateierweiterungen ein. Sekundäre MIME-Typen und Dateiendungen stellen Dateien dar, die Ihre Anwendung öffnen kann, die jedoch nicht anwendungsspezifisch sind. Ihre Anwendung könnte beispielsweise eine Bildbearbeitungs-App sein, die PNG- und JPG-Bilder öffnet. Fügen Sie nur standardmäßige Medientypen hinzu und achten Sie darauf, dass diese keine Tipp- und Rechtschreibfehler enthalten. Wenn Ihre Anwendung nur Verknüpfungsdateien oder Verknüpfungsdateien von Drittanbietern öffnet, können Sie den MIME-Typ leer lassen.

11. Wenn Sie die Schaltfläche „Neu“ in der Drive-UI verwenden und Nutzer eine Datei mit Ihrer Anwendung erstellen lassen möchten, klicken Sie das Kästchen Dateien erstellen an. Die Felder Neue URL und optional die Felder Dokumentname werden angezeigt.

    • Diese URL muss einen voll qualifizierten Domainnamen enthalten. localhost funktioniert nicht.
    • Sie müssen die Inhaberschaft dieser URL bestätigen, bevor Sie Ihre Anwendung im Google Workspace Marketplace auflisten können.
    • Standardmäßig wird an diese URL der Abfrageparameter state angehängt, um Daten von der Drive-UI an Ihre Anwendung zu übergeben. Informationen zum Inhalt des Parameters state finden Sie unter Parameter state.

12. Geben Sie in das Feld Neue URL eine URL ein. Diese URL wird von der Schaltfläche „Neu“ verwendet, um den Nutzer zu Ihrer Anwendung weiterzuleiten.

13. Optional: Wenn Ihre Anwendung von Google Workspace unterstützte Dateien öffnen soll, klicken Sie das Kästchen Importieren an.

14. Optional: Wenn Ihre Anwendung Dateien in geteilten Ablagen verwalten muss, klicken Sie das Kästchen Unterstützung für geteilte Ablagen an. Weitere Informationen zur Unterstützung geteilter Ablagen in Ihrer App finden Sie unter Unterstützung für geteilte Ablagen implementieren.

15. Klicken Sie auf Senden.

Bereich drive.install anfordern

Damit Apps als Optionen im Menü „Öffnen mit“ oder „Neu“ angezeigt werden, müssen Sie den Bereich https://www.googleapis.com/auth/drive.install für die Einbindung in die Drive-UI anfordern. Wenn Nutzer diesen Bereich anfordern, wird ein Dialogfeld wie dieses angezeigt:

Weitere Informationen zu Bereichen, die Sie für Drive-Anwendungen anfordern können, und dazu, wie Sie diese anfordern können, finden Sie unter API-spezifische Informationen zur Autorisierung und Authentifizierung.

Der Parameter state

Standardmäßig wird der Parameter state sowohl an die Open-URL als auch an die neue URL angehängt, um Daten von der Drive-UI an Ihre Anwendung zu übergeben. Dieser Parameter enthält einen JSON-codierten String mit Vorlagenvariablen und Daten über die Anfrage an Ihre Anwendung. Die enthaltenen Variablen hängen vom Typ der verwendeten URL ab (Offene URL oder neue URL):

Vorlagenvariable	Beschreibung	URL-Anwendung
{ids}	Eine durch Kommas getrennte Liste von Datei-IDs, die geöffnet werden.	URL öffnen
{exportIds}	Eine durch Kommas getrennte Liste der zu exportierenden Datei-IDs (wird nur beim Öffnen integrierter Google-Dokumente 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 bei Verwendung einer offenen URL oder create für eine neue URL.	„URL öffnen“ und „Neue URL“

Der Parameter state ist URL-codiert. Daher muss Ihre Anwendung die Escape-Zeichen verarbeiten und als JSON parsen. Anwendungen können den Wert create im Parameter state erkennen, um eine Anfrage zum Erstellen einer Datei zu verifizieren.

Beispielstatusinformationen in JSON für eine neue URL

Die state-Informationen für eine neue URL lauten:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Beispiel für Statusinformationen in JSON für eine offene URL

Die state-Informationen für eine Open-URL lauten wie folgt:

{
  "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 Ihre Anwendung die Datei-ID und ein Zugriffstoken hat, kann sie wie in der Methode files.get beschrieben Berechtigungen prüfen, die Dateimetadaten abrufen und den Dateiinhalt herunterladen.

Weitere Informationen

Eine installierte App muss Aktionen erstellen, verwalten und öffnen können, die über die Drive-UI gestartet werden. Weitere Informationen finden Sie unter Schaltfläche „Neu“ in der Drive-UI einbinden oder In das Kontextmenü der Drive-UI einbinden.