Stay organized with collections
Save and categorize content based on your preferences.
SetCredentialsResponse
Builder to create a setCredentials() response for your script project.
constcommunityConnector=DataStudioApp.createCommunityConnector();functionsetCredentials(request){constisValid=validateCredentials(request);if(isValid){// store the credentials somewhere.}returncommunityConnector.newSetCredentialsResponse().setIsValid(isValid).build();}functionvalidateCredentials(request){// ...}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eSetCredentialsResponse\u003c/code\u003e helps you create a response for your script project's \u003ccode\u003esetCredentials()\u003c/code\u003e function, indicating whether the provided credentials are valid.\u003c/p\u003e\n"],["\u003cp\u003eYou can use the \u003ccode\u003esetIsValid()\u003c/code\u003e method to set the validation status (true/false) and \u003ccode\u003ebuild()\u003c/code\u003e to finalize and return the response object in the required format for Data Studio.\u003c/p\u003e\n"],["\u003cp\u003eFor debugging, \u003ccode\u003eprintJson()\u003c/code\u003e prints the JSON representation of the \u003ccode\u003eSetCredentialsResponse\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,["# Class SetCredentialsResponse\n\nSetCredentialsResponse\n\nBuilder to create a `set``Credentials()` response for your script project.\n\n```javascript\nconst communityConnector = DataStudioApp.createCommunityConnector();\n\nfunction setCredentials(request) {\n const isValid = validateCredentials(request);\n\n if (isValid) {\n // store the credentials somewhere.\n }\n\n return communityConnector.newSetCredentialsResponse().setIsValid(isValid).build();\n}\n\nfunction validateCredentials(request) {\n // ...\n}\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------|-----------------------------|---------------------------------------------------------------------------|\n| [build()](#build()) | `Object` | Validates this object and returns it in the format needed by Data Studio. |\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setIsValid(isValid)](#setIsValid(Boolean)) | [SetCredentialsResponse](#) | Sets the valid status of this [SetCredentialsResponse](#). |\n\nDetailed documentation\n----------------------\n\n### `build()`\n\nValidates this object and returns it in the format needed by Data Studio.\n\n#### Return\n\n\n`Object` --- The validated [SetCredentialsResponse](#) object.\n\n*** ** * ** ***\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `set``Is``Valid(isValid)`\n\nSets the valid status of this [SetCredentialsResponse](#). Set to `true` if the\ncredentials provided in the request were valid, `false`, otherwise.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|-----------|--------------------------|\n| `is``Valid` | `Boolean` | The valid status to set. |\n\n#### Return\n\n\n[SetCredentialsResponse](#) --- This builder, for chaining."]]
