Skip to content

Commit 8059a2c

Browse files
Update the Data Studio auth documentation.
1 parent 0d5a9c1 commit 8059a2c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

data-studio/auth.gs

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
// [START apps_script_data_studio_get_auth_type_oauth2]
1818
/**
19-
* Gets the OAuth2 Auth type.
19+
* Returns the Auth Type of this connector.
2020
* @return {object} The Auth type.
2121
*/
2222
function getAuthType() {
@@ -29,7 +29,7 @@ function getAuthType() {
2929

3030
// [START apps_script_data_studio_get_auth_type_user_pass]
3131
/**
32-
* Gets the OAuth2 Auth type.
32+
* Returns the Auth Type of this connector.
3333
* @return {object} The Auth type.
3434
*/
3535
function getAuthType() {
@@ -43,7 +43,7 @@ function getAuthType() {
4343

4444
// [START apps_script_data_studio_get_auth_type_user_token]
4545
/**
46-
* Gets the OAuth2 Auth type.
46+
* Returns the Auth Type of this connector.
4747
* @return {object} The Auth type.
4848
*/
4949
function getAuthType() {
@@ -57,7 +57,7 @@ function getAuthType() {
5757

5858
// [START apps_script_data_studio_get_auth_type_key]
5959
/**
60-
* Gets the OAuth2 Auth type.
60+
* Returns the Auth Type of this connector.
6161
* @return {object} The Auth type.
6262
*/
6363
function getAuthType() {
@@ -71,7 +71,7 @@ function getAuthType() {
7171

7272
// [START apps_script_data_studio_get_auth_type_none]
7373
/**
74-
* Gets the OAuth2 Auth type.
74+
* Returns the Auth Type of this connector.
7575
* @return {object} The Auth type.
7676
*/
7777
function getAuthType() {
@@ -179,7 +179,7 @@ function isAuthValid() {
179179

180180
// [START apps_script_data_studio_auth_library]
181181
/**
182-
* Returns the OAuth Service
182+
* Returns the configured OAuth Service.
183183
* @return {Service} The OAuth Service
184184
*/
185185
function getOAuthService() {
@@ -197,8 +197,8 @@ function getOAuthService() {
197197
// [START apps_script_data_studio_auth_callback]
198198
/**
199199
* The OAuth callback.
200-
* @param {function} request The OAuth service callback handler.
201-
* @return {HtmlOutput} The HTML output.
200+
* @param {object} request The request data received from the OAuth flow.
201+
* @return {HtmlOutput} The HTML output to show to the user.
202202
*/
203203
function authCallback(request) {
204204
var authorized = getOAuthService().handleCallback(request);

0 commit comments

Comments
 (0)