Trang này được dịch bởi Cloud Translation API.

Authentication

Trình kết nối cộng đồng hỗ trợ các phương thức xác thực sau:

OAuth 2.0
Đường dẫn/Tên người dùng/Mật khẩu
Đường dẫn/Khoá
Tên người dùng/Mật khẩu
Tên người dùng/Mã thông báo
Khoá
Không có

Tuỳ thuộc vào phương thức bạn đang sử dụng, bạn phải cung cấp các hàm bổ sung trong trình kết nối.

Bảng sau đây cho biết những hàm mà bạn phải xác định tuỳ thuộc vào loại xác thực của trình kết nối.

	OAUTH2	PATH_USER_PASS PATH_KEY USER_PASS USER_TOKEN KEY	KHÔNG CÓ
`getAuthType()`	bắt buộc	bắt buộc	bắt buộc
`resetAuth()`	bắt buộc	bắt buộc
`isAuthValid()`	bắt buộc	bắt buộc
`authCallback()`	bắt buộc
`get3PAuthorizationUrls()`	bắt buộc
`setCredentials()`		bắt buộc

`getAuthType()`

Hàm này sẽ trả về loại xác thực cho trình kết nối.

OAUTH2

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns the Auth Type of this connector.
 * @return {object} The Auth type.
 */
function getAuthType() {
  var cc = DataStudioApp.createCommunityConnector();
  return cc.newAuthTypeResponse()
      .setAuthType(cc.AuthType.OAUTH2)
      .build();
}

PATH_USER_PASS

/**
 * Returns the Auth Type of this connector.
 * @return {object} The Auth type.
 */
function getAuthType() {
  var cc = DataStudioApp.createCommunityConnector();
  return cc.newAuthTypeResponse()
    .setAuthType(cc.AuthType.PATH_USER_PASS)
    .setHelpUrl('https://www.example.org/connector-auth-help')
    .build();
}

PATH_KEY

/**
 * Returns the Auth Type of this connector.
 * @return {object} The Auth type.
 */
function getAuthType() {
  var cc = DataStudioApp.createCommunityConnector();
  return cc.newAuthTypeResponse()
    .setAuthType(cc.AuthType.PATH_KEY)
    .setHelpUrl('https://www.example.org/connector-auth-help')
    .build();
}

USER_PASS

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns the Auth Type of this connector.
 * @return {object} The Auth type.
 */
function getAuthType() {
  var cc = DataStudioApp.createCommunityConnector();
  return cc.newAuthTypeResponse()
      .setAuthType(cc.AuthType.USER_PASS)
      .setHelpUrl('https://www.example.org/connector-auth-help')
      .build();
}

USER_TOKEN

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns the Auth Type of this connector.
 * @return {object} The Auth type.
 */
function getAuthType() {
  var cc = DataStudioApp.createCommunityConnector();
  return cc.newAuthTypeResponse()
      .setAuthType(cc.AuthType.USER_TOKEN)
      .setHelpUrl('https://www.example.org/connector-auth-help')
      .build();
}

PHÍM

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns the Auth Type of this connector.
 * @return {object} The Auth type.
 */
function getAuthType() {
  var cc = DataStudioApp.createCommunityConnector();
  return cc.newAuthTypeResponse()
      .setAuthType(cc.AuthType.KEY)
      .setHelpUrl('https://www.example.org/connector-auth-help')
      .build();
}

KHÔNG CÓ

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns the Auth Type of this connector.
 * @return {object} The Auth type.
 */
function getAuthType() {
  var cc = DataStudioApp.createCommunityConnector();
  return cc.newAuthTypeResponse()
      .setAuthType(cc.AuthType.NONE)
      .build();
}

`resetAuth()`

Hàm này sẽ xoá mọi thông tin đăng nhập được lưu trữ cho người dùng đối với dịch vụ của bên thứ ba.

OAUTH2

data-studio/auth.gs

Xem trên GitHub

/**
 * Resets the auth service.
 */
function resetAuth() {
  getOAuthService().reset();
}

PATH_USER_PASS

/**
 * Resets the auth service.
 */
function resetAuth() {
  var userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty('dscc.path');
  userProperties.deleteProperty('dscc.username');
  userProperties.deleteProperty('dscc.password');
}

PATH_KEY

/**
 * Resets the auth service.
 */
function resetAuth() {
  var userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty('dscc.path');
  userProperties.deleteProperty('dscc.key');
}

USER_PASS

data-studio/auth.gs

Xem trên GitHub

/**
 * Resets the auth service.
 */
function resetAuth() {
  var userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty('dscc.username');
  userProperties.deleteProperty('dscc.password');
}

USER_TOKEN

data-studio/auth.gs

Xem trên GitHub

/**
 * Resets the auth service.
 */
function resetAuth() {
  var userTokenProperties = PropertiesService.getUserProperties();
  userTokenProperties.deleteProperty('dscc.username');
  userTokenProperties.deleteProperty('dscc.password');
}

PHÍM

data-studio/auth.gs

Xem trên GitHub

/**
 * Resets the auth service.
 */
function resetAuth() {
  var userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty('dscc.key');
}

isAuthValid()

Hàm này được gọi để xác định xem quá trình xác thực cho dịch vụ bên thứ ba có hợp lệ hay không. Nếu quá trình xác thực hợp lệ, thì các lệnh gọi đến getData() và getSchema() sẽ không thất bại do truy cập trái phép. Nếu quá trình xác thực không hợp lệ, thì người dùng có thể nhận được thông báo để bắt đầu quy trình uỷ quyền.

OAUTH2

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns true if the auth service has access.
 * @return {boolean} True if the auth service has access.
 */
function isAuthValid() {
  return getOAuthService().hasAccess();
}

PATH_USER_PASS

/**
 * Returns true if the auth service has access.
 * @return {boolean} True if the auth service has access.
 */
function isAuthValid() {
  var userProperties = PropertiesService.getUserProperties();
  var path = userProperties.getProperty('dscc.path');
  var userName = userProperties.getProperty('dscc.username');
  var password = userProperties.getProperty('dscc.password');
  // This assumes you have a validateCredentials function that
  // can validate if the path, userName and password are correct.
  return validateCredentials(path, userName, password);
}

PATH_KEY

/**
 * Returns true if the auth service has access.
 * @return {boolean} True if the auth service has access.
 */
function isAuthValid() {
  var userProperties = PropertiesService.getUserProperties();
  var path = userProperties.getProperty('dscc.path');
  var key = userProperties.getProperty('dscc.key');
  // This assumes you have a validateCredentials function that
  // can validate if the path and key are correct.
  return validateCredentials(path, key);
}

USER_PASS

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns true if the auth service has access.
 * @return {boolean} True if the auth service has access.
 */
function isAuthValid() {
  var userProperties = PropertiesService.getUserProperties();
  var userName = userProperties.getProperty('dscc.username');
  var password = userProperties.getProperty('dscc.password');
  // This assumes you have a validateCredentials function that
  // can validate if the userName and password are correct.
  return validateCredentials(userName, password);
}

USER_TOKEN

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns true if the auth service has access.
 * @return {boolean} True if the auth service has access.
 */
function isAuthValid() {
  var userProperties = PropertiesService.getUserProperties();
  var userName = userProperties.getProperty('dscc.username');
  var token = userProperties.getProperty('dscc.token');
  // This assumes you have a validateCredentials function that
  // can validate if the userName and token are correct.
  return validateCredentials(userName, token);
}

PHÍM

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns true if the auth service has access.
 * @return {boolean} True if the auth service has access.
 */
function isAuthValid() {
  var userProperties = PropertiesService.getUserProperties();
  var key = userProperties.getProperty('dscc.key');
  // This assumes you have a validateKey function that can validate
  // if the key is valid.
  return validateKey(key);
}

`OAUTH2`

Thêm và thiết lập OAuth2 cho Thư viện Apps Script

Làm theo hướng dẫn thiết lập cho thư viện OAuth2 cho Apps Script để thêm thư viện này vào dự án trình kết nối của bạn. Sau đó, hãy làm theo bước đầu tiên trong hướng dẫn sử dụng để tạo dịch vụ OAuth2 trong dự án trình kết nối. Dịch vụ OAuth2 của bạn có thể có bất kỳ tên hàm hợp lệ nào, nhưng hãy nhớ sử dụng cùng một tên khi tham chiếu đến dịch vụ OAuth2 trong mã của bạn.

Ví dụ: một dịch vụ OAuth2 có tên là exampleService:

data-studio/auth.gs

Xem trên GitHub

/**
 * Returns the configured OAuth Service.
 * @return {Service} The OAuth Service
 */
function getOAuthService() {
  return OAuth2.createService('exampleService')
      .setAuthorizationBaseUrl('...')
      .setTokenUrl('...')
      .setClientId('...')
      .setClientSecret('...')
      .setPropertyStore(PropertiesService.getUserProperties())
      .setCallbackFunction('authCallback')
      .setScope('...');
};

`authCallback()`

Hàm này được gọi để hoàn tất quy trình OAuth 2.0. Phản hồi gọi lại từ dịch vụ xác thực bên thứ ba được cung cấp dưới dạng một đối số và phải được hàm này xử lý.

Ví dụ về cách xử lý lệnh gọi lại OAuth 2.0 bằng thư viện OAuth2 cho Apps Script:

data-studio/auth.gs

Xem trên GitHub

/**
 * The OAuth callback.
 * @param {object} request The request data received from the OAuth flow.
 * @return {HtmlOutput} The HTML output to show to the user.
 */
function authCallback(request) {
  var authorized = getOAuthService().handleCallback(request);
  if (authorized) {
    return HtmlService.createHtmlOutput('Success! You can close this tab.');
  } else {
    return HtmlService.createHtmlOutput('Denied. You can close this tab');
  };
};

`get3PAuthorizationUrls()`

Hàm này được gọi để lấy URL cần thiết để bắt đầu quy trình uỷ quyền cho dịch vụ bên thứ ba. Nếu isAuthValid trả về false thì URL được trả về sẽ hiển thị cho người dùng dưới dạng nút hoặc đường liên kết để họ có thể uỷ quyền truy cập vào dịch vụ bên thứ ba. Xem tài liệu tham khảo về get3PAuthorizationUrls().

Ví dụ về cách trả về URL uỷ quyền bằng thư viện OAuth2 cho Apps Script:

data-studio/auth.gs

Xem trên GitHub

/**
 * Gets the 3P authorization URL.
 * @return {string} The authorization URL.
 * @see https://developers.google.com/apps-script/reference/script/authorization-info
 */
function get3PAuthorizationUrls() {
  return getOAuthService().getAuthorizationUrl();
}

`USER_PASS`, `USER_TOKEN`, `KEY`, `PATH_USER_PASS` và `PATH_KEY`

Bạn chỉ cần thực hiện các bước sau cho quy trình xác thực USER_PASS, USER_TOKEN, KEY, PATH_USER_PASS và PATH_KEY.

`setCredentials()`

setCredentials được gọi sau khi người dùng nhập thông tin về thông tin đăng nhập trên trang cấu hình trình kết nối cộng đồng. Bạn nên sử dụng Dịch vụ thuộc tính để lưu thông tin đăng nhập theo từng người dùng bằng cách sử dụng UserProperties.

PATH_USER_PASS

/**
 * Sets the credentials.
 * @param {Request} request The set credentials request.
 * @return {object} An object with an errorCode.
 */
function setCredentials(request) {
  var creds = request.pathUserPass;
  var path = creds.path;
  var username = creds.username;
  var password = creds.password;

  // Optional
  // Check if the provided path, username and password are valid through
  // a call to your service. You would have to have a `checkForValidCreds`
  // function defined for this to work.
  var validCreds = checkForValidCreds(path, username, password);
  if (!validCreds) {
    return {
      errorCode: 'INVALID_CREDENTIALS'
    };
  }
  var userProperties = PropertiesService.getUserProperties();
  userProperties.setProperty('dscc.path', path);
  userProperties.setProperty('dscc.username', username);
  userProperties.setProperty('dscc.password', password);
  return {
    errorCode: 'NONE'
  };
}

PATH_KEY

/**
 * Sets the credentials.
 * @param {Request} request The set credentials request.
 * @return {object} An object with an errorCode.
 */
function setCredentials(request) {
  var creds = request.pathKey;
  var path = creds.path;
  var key = creds.key;

  // Optional
  // Check if the provided path and key are valid through
  // a call to your service. You would have to have a `checkForValidCreds`
  // function defined for this to work.
  var validCreds = checkForValidCreds(path, key);
  if (!validCreds) {
    return {
      errorCode: 'INVALID_CREDENTIALS'
    };
  }
  var userProperties = PropertiesService.getUserProperties();
  userProperties.setProperty('dscc.path', path);
  userProperties.setProperty('dscc.key', key);
  return {
    errorCode: 'NONE'
  };
}

USER_PASS

data-studio/auth.gs

Xem trên GitHub

/**
 * Sets the credentials.
 * @param {Request} request The set credentials request.
 * @return {object} An object with an errorCode.
 */
function setCredentials(request) {
  var creds = request.userPass;
  var username = creds.username;
  var password = creds.password;

  // Optional
  // Check if the provided username and password are valid through a
  // call to your service. You would have to have a `checkForValidCreds`
  // function defined for this to work.
  var validCreds = checkForValidCreds(username, password);
  if (!validCreds) {
    return {
      errorCode: 'INVALID_CREDENTIALS'
    };
  }
  var userProperties = PropertiesService.getUserProperties();
  userProperties.setProperty('dscc.username', username);
  userProperties.setProperty('dscc.password', password);
  return {
    errorCode: 'NONE'
  };
}

USER_TOKEN

data-studio/auth.gs

Xem trên GitHub

/**
 * Sets the credentials.
 * @param {Request} request The set credentials request.
 * @return {object} An object with an errorCode.
 */
function setCredentials(request) {
  var creds = request.userToken;
  var username = creds.username;
  var token = creds.token;

  // Optional
  // Check if the provided username and token are valid through a
  // call to your service. You would have to have a `checkForValidCreds`
  // function defined for this to work.
  var validCreds = checkForValidCreds(username, token);
  if (!validCreds) {
    return {
      errorCode: 'INVALID_CREDENTIALS'
    };
  }
  var userProperties = PropertiesService.getUserProperties();
  userProperties.setProperty('dscc.username', username);
  userProperties.setProperty('dscc.token', token);
  return {
    errorCode: 'NONE'
  };
}

PHÍM

data-studio/auth.gs

Xem trên GitHub

/**
 * Sets the credentials.
 * @param {Request} request The set credentials request.
 * @return {object} An object with an errorCode.
 */
function setCredentials(request) {
  var key = request.key;

  // Optional
  // Check if the provided key is valid through a call to your service.
  // You would have to have a `checkForValidKey` function defined for
  // this to work.
  var validKey = checkForValidKey(key);
  if (!validKey) {
    return {
      errorCode: 'INVALID_CREDENTIALS'
    };
  }
  var userProperties = PropertiesService.getUserProperties();
  userProperties.setProperty('dscc.key', key);
  return {
    errorCode: 'NONE'
  };
}

Authentication Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

getAuthType()

OAUTH2

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

PHÍM

KHÔNG CÓ

resetAuth()

OAUTH2

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

PHÍM

isAuthValid()

OAUTH2

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

PHÍM

OAUTH2

Thêm và thiết lập OAuth2 cho Thư viện Apps Script

authCallback()

get3PAuthorizationUrls()

USER_PASS, USER_TOKEN, KEY, PATH_USER_PASS và PATH_KEY

setCredentials()

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

PHÍM

Authentication

`getAuthType()`

`resetAuth()`

`OAUTH2`

`authCallback()`

`get3PAuthorizationUrls()`

`USER_PASS`, `USER_TOKEN`, `KEY`, `PATH_USER_PASS` và `PATH_KEY`

`setCredentials()`