Box
Mit dem Box-Connector können Sie eine Verbindung zu einem Box-Backend herstellen und SQL-Daten zum Abrufen und Aktualisieren von Box-Daten verwenden.
Unterstützte Versionen
Dieser Connector unterstützt die Box Content API Version 2.0.
Hinweis
Führen Sie vor der Verwendung des Box-Connectors die folgenden Aufgaben aus:
- In Ihrem Google Cloud-Projekt:
- Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkkonnektivität.
- Weisen Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin zu.
- Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.
- Aktivieren Sie die folgenden Dienste:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.
Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.
Connector konfigurieren
Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:
- Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.
- Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
- Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
Eine Liste aller unterstützten Regionen finden Sie unter Standorte.
- Tippen Sie auf Weiter.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
- Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
- Connector: Wählen Sie Box aus der Drop-down-Liste der verfügbaren Connectors aus.
- Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
- Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.
Verbindungsnamen müssen die folgenden Kriterien erfüllen:
- Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
- Buchstaben müssen Kleinbuchstaben sein.
- Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
- Verbindungsnamen dürfen maximal 49 Zeichen haben.
- Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
- Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf
Error
festgelegt. - Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
- Optional: Konfigurieren Sie die Verbindungsknoteneinstellungen:
- Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
- Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.
Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.
- Identitätswechsel des Nutzermodus: Geben Sie den Typ der Nutzeridentität an. Diese sollte Nutzer- oder Administratormodus sein.
- Proxy verwenden: Aktivieren Sie dieses Kästchen, um einen Proxyserver für die Verbindung zu konfigurieren. Konfigurieren Sie dann die folgenden Werte:
-
Proxy Auth Scheme (Proxy-Authentifizierungsschema): Wählen Sie den Authentifizierungstyp für die Authentifizierung beim Proxyserver aus. Die folgenden Authentifizierungstypen werden unterstützt:
- Standard: Basis-HTTP-Authentifizierung.
- Digest: Digest-HTTP-Authentifizierung.
- Proxy-Nutzer: Ein Nutzername, der für die Authentifizierung beim Proxyserver verwendet werden soll.
- Proxy-Passwort: Das Secret Manager-Secret des Nutzerpassworts.
-
Proxy-SSL-Typ: Der SSL-Typ, der beim Herstellen einer Verbindung zum Proxyserver verwendet werden soll. Die folgenden Authentifizierungstypen werden unterstützt:
- Automatisch: Standardeinstellung. Wenn es sich bei der URL um eine HTTPS-URL handelt, wird die Option „Tunnel“ verwendet. Wenn es sich bei der URL um eine HTTP-URL handelt, wird die Option „NEVER“ (NIE) verwendet.
- Immer: Für die Verbindung ist immer SSL aktiviert.
- Nie: Für die Verbindung ist SSL nicht aktiviert.
- Tunnel: Die Verbindung erfolgt über einen Tunneling-Proxy. Der Proxyserver öffnet eine Verbindung zum Remote-Host und der Traffic fließt über den Proxy hin und zurück.
- Geben Sie im Abschnitt Proxyserver die Details zum Proxyserver ein.
- Klicken Sie auf + Ziel hinzufügen.
- Wählen Sie einen Zieltyp aus.
- Hostadresse: Geben Sie den Hostnamen oder die IP-Adresse des Ziels an.
So stellen Sie eine private Verbindung zu Ihrem Backend-System her:
- Erstellen Sie einen PSC-Dienstanhang.
- Erstellen Sie einen Endpunktanhang und geben Sie dann die Details des Endpunktanhangs in das Feld Hostadresse ein.
- Hostadresse: Geben Sie den Hostnamen oder die IP-Adresse des Ziels an.
- Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Tippen Sie auf Weiter.
-
Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
Die folgenden Authentifizierungstypen werden von der Box-Verbindung unterstützt:
- JWT-Authentifizierung
- OAuth 2.0-Autorisierungscode
- Box JSON
- OAuth 2.0-Clientanmeldedaten
- Tippen Sie auf WEITER.
Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- Klicken Sie auf Erstellen.
Authentifizierung konfigurieren
Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.
-
JWT-Authentifizierung
- Client-ID: Die Client-ID, die von Box für die von Ihnen erstellte Anwendung bereitgestellt wird.
- Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die von Ihnen erstellte App.
- Secret-Version: Die Version des Clientschlüssels.
- Privater Schlüssel: Secret Manager-Secret mit dem Inhalt der privaten Schlüsseldatei. Der private Schlüssel sollte mit dem Public-Key-Zertifikat übereinstimmen, das für Connector bereitgestellt wird.
- Secret-Version: Die Version des Secrets für den privaten Schlüssel.
- Passwort für privaten Schlüssel: Das Secret Manager-Secret mit dem Passwort (Paraphrase) der privaten Schlüsseldatei.
- Secret-Version: Die Version des Passworts für den privaten Schlüssel.
- Zugriffsebene der Box-Anwendung: Die Zugriffsebene für die Box-Anwendung.
- Enterprise-ID/Nutzer-ID: Enterprise-ID, wenn die Anwendungsebene "Enterprise" ist, und Nutzer-ID, wenn die Anwendungsebene "Nutzer" ist
- ID des öffentlichen OAuth-JWT-Schlüssels: Die ID des öffentlichen Schlüssels für JWT.
- Auth-Schema: Auth-Schema für den Box-Connector.
- OAuth-Initiierung: OAuth-Parameter für den Box-Connector initiieren
- OAuth-JWT-Zertifikatstyp: Der OAuth-JWT-Zertifikatstyp für den Box-Connector.
- OAuth 2.0-Autorisierungscode
- Client-ID:Die Client-ID, die von Box für die von Ihnen erstellte Anwendung bereitgestellt wird.
- Bereiche:Berechtigungsbereiche. Beispiel:
root_readonly
. Informationen zur Funktionsweise der Bereiche und zum Aufrufen aller verfügbaren Bereiche für Box finden Sie unter Bereiche. - Client-Secret: Wählen Sie das Secret Manager-Secret aus. Bevor Sie diese Autorisierung konfigurieren, müssen Sie das Secret Manager-Secret erstellen.
- Secret-Version: Secret Manager-Secret-Version für den Clientschlüssel.
-
Box JSON
- Box JSON für JWT-Authentifizierung: Das Geheimnis, das den Inhalt der von Box bereitgestellten JSON-Datei enthält.
- Secret-Version: Die Version des JSON-Datei-Secrets.
-
OAuth 2.0 – Clientanmeldedaten
- OAuth-Client-ID: Die Client-ID, die von Box für die von Ihnen erstellte Anwendung bereitgestellt wird.
- Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die von Ihnen erstellte App.
- Secret-Version: Die Version des Clientschlüssels.
- Subject-ID: Der Nutzer, für den die Anwendung den delegierten Zugriff anfordert.
- Zugriffsebene der Box-Anwendung: Die Zugriffsebene für die Box-Anwendung.
Für den Authentifizierungstyp Authorization code
müssen Sie nach dem Erstellen der Verbindung einige zusätzliche Schritte zum Konfigurieren der Authentifizierung ausführen. Weitere Informationen finden Sie unter Zusätzliche Schritte nach dem Erstellen der Verbindung.
Beispiele für Verbindungskonfigurationen
In diesem Abschnitt finden Sie Beispielwerte für die verschiedenen Felder, die Sie beim Erstellen der Verbindung konfigurieren.
Verbindungstyp der OAuth-JWT-Tokenmethode
Feldname | Details |
---|---|
Standort | us-central1 |
Connector | Box |
Connector-Version | 1 |
Verbindungsname | box-conn |
Cloud Logging aktivieren | Ja |
Dienstkonto | XXXX@serviceaccount |
Identitätswechsel des Nutzermodus | Nutzer |
Mindestanzahl von Knoten | 2 |
Maximale Anzahl von Knoten | 2 |
Authentifizierung | JWT-Authentifizierung |
Client-ID | XXXX |
Clientschlüssel | XXXX |
Secret-Version | 1 |
Privater Schlüssel | XXXX |
Secret-Version | 1 |
Passwort für den privaten Schlüssel | XXXX |
Secret-Version | 1 |
Zugriffsebene der Box-Anwendung | Unternehmen |
Unternehmens-ID/Nutzer-ID | XXXX |
ID des öffentlichen OAuth-JWT-Schlüssels | XXXX |
Auth-Schema | OAuthJWT |
OAuth initiieren | GETANDREFRESH |
OAuth-JWT-Zertifikatstyp | PEMKEY_BLOB |
Sie können über das Box-Konto auf die Client-ID, den Clientschlüssel, die Zugriffsebene der Box-Anwendung und die Unternehmens-ID/Nutzer-ID zugreifen.
Sie können über die heruntergeladene Datei Private keypair.json
auf den privaten Schlüssel und das Passwort für den privaten Schlüssel zugreifen. Weitere Informationen finden Sie unter Informationen zu öffentlichen und privaten Schlüsselpaaren. Bevor Sie das Passwort für den privaten Schlüssel übergeben, ersetzen Sie das \n
in der Datei json
durch eine neue Zeile.
Verbindungstyp „OAuth-Autorisierungscode“
Feldname | Details |
---|---|
Standort | us-central1 |
Connector | Box |
Connector-Version | 1 |
Verbindungsname | box-conn |
Cloud Logging aktivieren | Ja |
Dienstkonto | XXXX@serviceaccount |
Identitätswechsel des Nutzermodus | Nutzer |
Autorisierung | OAuth 2.0-Autorisierungscode |
Mindestanzahl von Knoten | 2 |
Maximale Anzahl von Knoten | 2 |
Client-ID | XXXX |
Bereiche | root_readwrite |
Clientschlüssel | XXXX |
Secret-Version | 1 |
Informationen zur OAuth-Konfiguration von Box finden Sie unter OAuth-Anwendung erstellen.
Box-JSON für den Verbindungstyp der JWT-Authentifizierungsmethode
Feldname | Details |
---|---|
Standort | us-central1 |
Connector | Box |
Connector-Version | 1 |
Verbindungsname | gcp-box-conn-new |
Cloud Logging aktivieren | Ja |
Dienstkonto | XXXX@serviceaccount |
Identitätswechsel des Nutzermodus | Nutzer |
Als User-ID | XXXX |
Mindestanzahl von Knoten | 2 |
Maximale Anzahl von Knoten | 2 |
Authentifizierung | Box JSON |
Box JSON für JWT-Authentifizierung | XXXX |
Secret-Version | 1 |
Sie können das Box-Konto verwenden, um Box JSON für die JWT-Authentifizierung einzurichten. Informationen zum Einrichten von Box JSON für JWT finden Sie unter Schritte zum Erstellen eines JWT-Tokens .
Rufen Sie den Box-JSON-Wert für die JWT-Authentifizierung aus der heruntergeladenen Datei Private keypair.json
auf. Weitere Informationen finden Sie unter Informationen zu öffentlichen und privaten Schlüsselpaaren. Du musst den gesamten Inhalt der .json
-Datei in das Feld Box Json for JWT Auth einfügen.
Verbindungstyp „OAuth-Client-Anmeldedaten“
Feldname | Details |
---|---|
Standort | us-central1 |
Connector | Box |
Connector-Version | 1 |
Verbindungsname | oauth-clientcred-conn |
Cloud Logging aktivieren | Ja |
Dienstkonto | XXXX@serviceaccount |
Identitätswechsel des Nutzermodus | Nutzer |
Als User-ID | XXXX |
Mindestanzahl von Knoten | 2 |
Maximale Anzahl von Knoten | 2 |
Authentifizierung | OAuth-Client-Anmeldedaten |
OAuth-Client-ID | XXXX |
OAuth-Clientschlüssel | XXXX |
Secret-Version | 1 |
Themen-ID | XXXX |
Zugriffsebene der Box-Anwendung | Enterprise |
Sie können über das Box-Konto auf die Client-ID, den Clientschlüssel, die Zugriffsebene der Box-Anwendung und die Unternehmens-ID/Nutzer-ID zugreifen.
Erneute Autorisierung für Autorisierungscode
Wenn Sie den Authentifizierungstyp Authorization code
verwenden und Änderungen an der Konfiguration in Ihrer Box-Anwendung vorgenommen haben, müssen Sie Ihre Box-Verbindung noch einmal autorisieren. So autorisieren Sie eine Verbindung noch einmal:
- Klicken Sie auf der Seite Verbindungen auf die gewünschte Verbindung.
Dadurch wird die Seite mit den Verbindungsdetails geöffnet.
- Klicken Sie auf Bearbeiten, um die Verbindungsdetails zu bearbeiten.
- Überprüfen Sie die Details unter OAuth 2.0 – Autorisierungscode im Abschnitt Authentifizierung.
Nehmen Sie gegebenenfalls die erforderlichen Änderungen vor.
- Klicken Sie auf Speichern. Daraufhin gelangen Sie zur Seite mit den Verbindungsdetails.
- Klicken Sie im Abschnitt Authentifizierung auf Autorisierung bearbeiten. Daraufhin wird der Bereich Authorize (Autorisieren) angezeigt.
- Klicken Sie auf Autorisieren.
Wenn die Autorisierung erfolgreich war, wird der Verbindungsstatus auf der Seite „Verbindungen“ auf Aktiv gesetzt.
Zusätzliche Schritte nach dem Erstellen der Verbindung
Wenn Sie OAuth 2.0 - Authorization code
für die Authentifizierung ausgewählt haben, müssen Sie nach dem Erstellen der Verbindung die folgenden zusätzlichen Schritte ausführen:
- Suchen Sie auf der Seite Verbindungen nach der neu erstellten Verbindung.
Der Status des neuen Connectors lautet Autorisierung erforderlich.
- Klicken Sie auf Autorisierung erforderlich.
Daraufhin wird der Bereich Autorisierung bearbeiten angezeigt.
- Kopieren Sie den Wert Weiterleitungs-URI in Ihre externe Anwendung.
- Prüfen Sie die Autorisierungsdetails.
- Klicken Sie auf Autorisieren.
Wenn die Autorisierung erfolgreich war, wird der Verbindungsstatus auf der Seite Verbindungen auf Aktiv gesetzt.
Entitäten, Vorgänge und Aktionen
Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.
- Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.
Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste
Entities
leer. - Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keinen der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Liste
Operations
aufgeführt. - Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die
Actions
-Liste leer.
Aktionen
In diesem Abschnitt werden alle Aktionen aufgeführt, die von der Box-Verbindung unterstützt werden.
Aktion „DownloadFile“
Mit dieser Aktion können Sie eine Datei aus Ihrer Box-Instanz herunterladen.
Eingabeparameter der DownloadFile-Aktion
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
FileID | String | Ja | Die ID der Datei, die heruntergeladen werden soll. |
HasBytes | Boolesch | Ja | Gibt an, ob die Datei als String oder als Base64-codierter String heruntergeladen werden soll. |
Ausgabeparameter der Aktion „DownloadFile“
Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.
Parametername | Datentyp | Beschreibung |
---|---|---|
Erfolg | String | Gibt an, ob der Dateidownload erfolgreich war. |
ContentBytes | String | Der Dateiinhalt als Base64-codierter String. |
Ein Beispiel zum Konfigurieren der DownloadFile
-Aktion finden Sie unter Beispiele für Aktionen.
Aktion „UploadFile“
Mit dieser Aktion können Sie eine Datei in Ihre Box-Instanz hochladen.
Eingabeparameter der UploadFile-Aktion
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
ParentID | String | Ja | ID des Ordners, in den Sie die Datei hochladen möchten. Wenn dieser Parameter nicht angegeben ist, wird die Datei in das Stammverzeichnis des Box-Kontos hochgeladen. Der Standardwert ist 0. |
Inhalt | String | Ja | Der hochzuladende Dateiinhalt. |
Ausgabeparameter der UploadFile-Aktion
Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.
Parametername | Datentyp | Beschreibung |
---|---|---|
Erfolg | String | Gibt an, ob der Dateiupload erfolgreich war. |
ID | String | ID der neu erstellten Datei. |
VersionID | String | ID einer bestimmten Version der Datei. |
Hash | String | Der SHA1 -Hash der Datei. |
ETag | String | Etag-Wert der Datei oder des Ordners. Der Standardwert ist 0. |
Ein Beispiel zum Konfigurieren der UploadFile
-Aktion finden Sie unter Beispiele für Aktionen.
CopyFile-Aktion
Mit dieser Aktion können Sie eine Datei aus Ihrer Box-Instanz kopieren.
Eingabeparameter der CopyFile-Aktion
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
FileID | String | Ja | Die ID der Datei, die Sie kopieren möchten. |
DestinationFolderId | String | Nein | ID des Zielordners, in den Sie die Datei kopieren möchten. Wenn Sie keinen Wert angeben, wird die neueste Version der Datei kopiert. |
NewName | String | Ja | Neuer Dateiname für die kopierte Datei. |
Ausgabeparameter der CopyFile-Aktion
Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.
Parametername | Datentyp | Beschreibung |
---|---|---|
Erfolg | String | Gibt an, ob die Datei kopiert wurde. |
ID | String | ID der kopierten Datei. |
Ein Beispiel zum Konfigurieren der CopyFile
-Aktion finden Sie unter Beispiele für Aktionen.
Aktion „CopyFolder“
Mit dieser Aktion können Sie einen ganzen Ordner aus Ihrer Box-Instanz kopieren.
Eingabeparameter der Aktion „CopyFolder“
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
FolderID | String | Ja | ID des Ordners, den Sie kopieren möchten. |
DestinationFolderId | String | Ja | ID des Zielordners, in den Sie den Ordner kopieren möchten. |
NewName | String | Nein | Neuer Dateiname für den kopierten Ordner. |
Ausgabeparameter der Aktion „CopyFolder“
Diese Aktion gibt den Status 200 (OK) mit einem Antworttext zurück, der die Ergebnisse enthält.
Parametername | Datentyp | Beschreibung |
---|---|---|
Erfolg | String | Gibt an, ob die Ordnerkopie erfolgreich war. |
ID | String | ID des kopierten Ordners. |
Ein Beispiel zum Konfigurieren der CopyFolder
-Aktion finden Sie unter Beispiele für Aktionen.
Beispiele für Aktionen
In diesem Abschnitt wird beschrieben, wie Sie einige Aktionen in diesem Connector ausführen.
Beispiel: Datei herunterladen
- Klicken Sie im Dialogfeld
Configure connector task
aufActions
. - Wählen Sie die Aktion
DownloadFile
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "FileID": "1283194869422", "HasBytes": true }
In diesem Beispiel wird eine Datei als base64-codierter String heruntergeladen. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload
der Connector-Aufgabe einen Wert, der in etwa so aussieht:
[ { "Success": "True"}, {"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"} ]
Beispiel: Datei hochladen
- Klicken Sie im Dialogfeld
Configure connector task
aufActions
. - Wählen Sie die Aktion
UploadFile
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "ParentId": "0", "Content": "12345" }
In diesem Beispiel werden Stringinhalte als Datei hochgeladen. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload
der Connector-Aufgabe einen Wert, der in etwa so aussieht:
[{ "Success": "true", "ID": "1283902965389", "VersionID": "1403546001389", "Hash": "8cb2237d0679ca88db6464eac60da96345513964", "Etag": "0" }]
Beispiel: Datei kopieren
- Klicken Sie im Dialogfeld
Configure connector task
aufActions
. - Wählen Sie die Aktion
CopyFile
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "FileID": "1288751886061", "DestinationFolderId": "219105724517", "NewName": "NewCopiedFile" }
In diesem Beispiel wird die Datei mit der ID 1288751886061
in den Ordner mit der ID 219105724517
kopiert. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload
der Connector-Aufgabe einen Wert, der in etwa so aussieht:
[{ "Success": "true", "ID": "1308006018536" }]
Beispiel: Ordner kopieren
- Klicken Sie im Dialogfeld
Configure connector task
aufActions
. - Wählen Sie die Aktion
CopyFolder
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "FolderID": "218475301279", "DestinationFolderId": "0", "NewName": "NewCopiedFolder" }
In diesem Beispiel wird der Ordner mit der ID 218475301279
in den Ordner mit der ID 219105724517
kopiert. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload
der Connector-Aufgabe einen Wert, der in etwa so aussieht:
[{ "Success": "true", "ID": "226312444517" }]
Beispiele für Entitätsvorgänge
Beispiel: Alle Dateien auflisten
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Dateien“ aus. - Wählen Sie den Vorgang
LIST
aus und klicken Sie auf Fertig.
Sie können den LIST-Vorgang auf die folgenden Entitäten anwenden: Ordner, Papierkorbelemente, freigegebene Elemente, Gruppenarbeiten, Aufgabenzuweisungen und Aufgaben.
Beispiel: Dateien abrufen
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Dateien“ aus. - Wählen Sie den Vorgang
GET
aus und klicken Sie auf Fertig. - Legen Sie die Entitäts-ID auf 1262397830475 fest, der Schlüssel, der übergeben werden soll. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann
1262397830475
in das Feld Standardwert ein.
Der Wert für die Entitäts-ID muss direkt übergeben werden, z. B. 1262397830475. Dabei ist 1262397830475 der eindeutige Primärschlüsselwert.
Sie können den GET-Vorgang für die folgenden Entitäten ausführen: Ordner, freigegebene Elemente, Gruppenarbeiten, Aufgabenzuweisungen und Aufgaben.
Beispiel: Dateien löschen
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Dateien“ aus. - Wählen Sie den Vorgang
DELETE
aus und klicken Sie auf Fertig. - Legen Sie die Entitäts-ID auf 1258725940971 fest, der Schlüssel, der übergeben werden soll. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann
1258725940971
in das Feld Standardwert ein.Wenn die Entität zwei zusammengesetzte Geschäfts- oder Primärschlüssel hat, können Sie anstelle der entityId auch die filterClause auf
Id='1258725940971'
festlegen.
Sie können den Befehl „DELETE“ auf die folgenden Entitäten anwenden: Ordner, Aufgaben, Gruppenarbeiten, freigegebene Elemente und Aufgabenzuweisungen.
Beispiel: Ordner erstellen
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Ordner“ aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Name": "Google Cloud Platforms_created_folders", "ParentId": "0" }
Wenn die Integration erfolgreich war, hat der Antwortparameter
connectorOutputPayload
der AufgabeFolder
einen Wert, der in etwa so aussieht:{ "Id": "222269371053" }
Beispiel: Gruppenarbeiten erstellen
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Gruppenarbeiten“ aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "ItemId": "216592737829", "ItemType": "folder", "AccessibleById": "27370766275", "AccessibleByType": "user", "AccessibleByLogin": "baklavainthebalkans@gmail.com", "Role": "editor" }
Wenn die Integration erfolgreich war, hat der Antwortparameter
connectorOutputPayload
der AufgabeFolder
einen Wert, der in etwa so aussieht :{ "Success": false }
Beispiel: Aufgaben erstellen
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Aufgaben“ aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "ItemId": "1253997361112", "ItemType": "file", "Action": "review", "Message": "Creating a task from Google Cloud Platform", "DueAt": "2023-12-12 09:01:15.0", "CompletionRule": "all_assignees" }
Wenn die Integration erfolgreich war, hat der Antwortparameter
connectorOutputPayload
der AufgabeFolder
einen Wert, der in etwa so aussieht:{ "Id": "1253997361112" }
Beispiel: Aufgabenzuweisungen erstellen
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Aufgabenzuweisungen“ aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "TaskId": "21507516872", "AssignedToId": "27370766275" }
Wenn die Integration erfolgreich war, hat der Antwortparameter
connectorOutputPayload
der AufgabeFolder
einen Wert, der in etwa so aussieht:{ "Id": "50804351753" }
Beispiel: Dateien aktualisieren
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Dateien“ aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Name": "Get Started with Box Files.pdf" }
- Legen Sie die Entitäts-ID auf 1253997361112 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann
1253997361112
in das Feld Standardwert ein.Anstelle der entityId können Sie auch die filterClause auf
1253997361112
festlegen.Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariablen
connectorOutputPayload
des Connector-Tasks eine Antwort zurückgegeben, die der folgenden ähnelt:{ "Id": "1253997361112" }
Sie können den UPDATE-Vorgang auf die folgenden Entitäten anwenden: Ordner, Aufgaben, Gruppenarbeiten, freigegebene Elemente und Aufgabenzuweisungen.
Beispiel: Ordner aktualisieren
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Ordner“ aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Name": "Demo Update" }
- Legen Sie die Entitäts-ID auf 216457668125 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann
216457668125
in das Feld Standardwert ein.Anstelle der entityId können Sie auch die filterClause auf
216457668125
festlegen.Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariablen
connectorOutputPayload
des Connector-Tasks eine Antwort zurückgegeben, die der folgenden ähnelt:{ "Id": "216457668125" }
Beispiel: Gemeinschaftsprojekte aktualisieren
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Gruppenarbeiten“ aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Role": "Viewer" }
- Legen Sie die Entitäts-ID auf 46685648757 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann
46685648757
in das Feld Standardwert ein.Anstelle der entityId können Sie auch die filterClause auf
46685648757
festlegen.Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariablen
connectorOutputPayload
des Connector-Tasks eine Antwort zurückgegeben, die der folgenden ähnelt:{ }
Beispiel: Aufgaben aktualisieren
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Aufgaben“ aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Message": "This is a new task is updated and assigned to you by me" }
- Legen Sie die Entitäts-ID auf 21507516872 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann
21507516872
in das Feld Standardwert ein.Anstelle der entityId können Sie auch die filterClause auf
21507516872
festlegen.Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariablen
connectorOutputPayload
des Connector-Tasks eine Antwort zurückgegeben, die der folgenden ähnelt:{ "Id": "21507516872" }
Beispiel: Aufgabenzuweisungen aktualisieren
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Aufgabenzuweisungen“ aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Message": "Looks good to me", "ResolutionState": "completed" }
- Legen Sie die Entitäts-ID auf 49542929469 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann
49542929469
in das Feld Standardwert ein.Anstelle der entityId können Sie auch die filterClause auf
49542929469
festlegen.Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariablen
connectorOutputPayload
des Connector-Tasks eine Antwort zurückgegeben, die der folgenden ähnelt:{ "Id": "49542929469" }
Beispiel: Übergabeordner aktualisieren
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die Option „Ordner“ aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Name": "Demo Update" "ParentId": "216596059374" }
- Legen Sie die Entitäts-ID auf 216457668125 fest. Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann
216457668125
in das Feld Standardwert ein.Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariablen
connectorOutputPayload
des Connector-Tasks eine Antwort zurückgegeben, die der folgenden ähnelt:{ "Id": "216457668125" }
Verbindungen mit Terraform erstellen
Sie können die Terraform-Ressource verwenden, um eine neue Verbindung zu erstellen.Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.
Eine Beispiel-Terraform-Vorlage zum Erstellen einer Verbindung finden Sie unter Beispielvorlage.
Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
impersonate_user_mode | ENUM | Wahr | Geben Sie den Typ der Nutzeridentität an. Diese sollte Nutzer- oder Administratormodus sein. Unterstützte Werte: „Nutzer“, „Administrator“ |
proxy_enabled | BOOLEAN | Falsch | Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung zu konfigurieren. |
proxy_auth_scheme | ENUM | Falsch | Der Authentifizierungstyp, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. Unterstützte Werte: BASIC, DIGEST, NONE |
proxy_user | STRING | Falsch | Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. |
proxy_password | VERTRAULICH | Falsch | Ein Passwort, das für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. |
proxy_ssltype | ENUM | Falsch | Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll. Unterstützte Werte: AUTO, ALWAYS, NEVER, TUNNEL |
Box-Verbindung in einer Integration verwenden
Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung über die Connectors-Aufgabe in einer Integration verwenden.
- Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
- Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors-Aufgabe.
Hilfe von der Google Cloud-Community erhalten
Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.Nächste Schritte
- Informationen zum Anhalten und Fortsetzen einer Verbindung
- Informationen zum Überwachen der Connector-Nutzung
- Weitere Informationen zum Ansehen von Connector-Logs