Builder zum Erstellen einer getAuthType()-Antwort für Ihr Skriptprojekt.
function getAuthType() { const cc = DataStudioApp.createCommunityConnector(); return cc.newAuthTypeResponse() .setAuthType(cc.AuthType.USER_PASS) .setHelpUrl('https://www.example.org/connector-auth-help') .build(); }
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
build() | Object | Validiert dieses Objekt und gibt es im von Data Studio benötigten Format zurück. |
print | String | Gibt die JSON-Darstellung dieses Objekts aus. |
set | Get | Legt den Auth des Builders fest. |
set | Get | Legt die Hilfe-URL des Builders fest. |
Detaillierte Dokumentation
build()
Validiert dieses Objekt und gibt es im von Data Studio benötigten Format zurück.
Rückgabe
Object – Das validierte GetAuthTypeResponse-Objekt.
printJson()
Gibt die JSON-Darstellung dieses Objekts aus. Dies dient nur zu Debugging-Zwecken.
Rückgabe
String
setAuthType(authType)
Legt den AuthType des Builders fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
auth | Auth | Der festzulegende Authentifizierungstyp. |
Rückgabe
GetAuthTypeResponse – Dieser Builder zur Verkettung.
setHelpUrl(helpUrl)
Legt die Hilfe-URL des Builders fest.
Die Hilfe-URL ist eine optionale URL, die der Nutzer aufrufen kann, um Hilfe beim Einrichten der Authentifizierung zu erhalten. Sie wird nur für die Authentifizierungstypen USER_PASS, KEY und USER_TOKEN unterstützt.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
help | String | Die festzulegende Hilfe-URL. |
Rückgabe
GetAuthTypeResponse – Dieser Builder zur Verkettung.