تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

المصادقة

تتوافق موصِّلات المنتديات مع طرق المصادقة التالية:

OAuth 2.0
المسار/اسم المستخدم/كلمة المرور
المسار/المفتاح
اسم المستخدم/كلمة المرور
اسم المستخدم/الرمز المميز
المفتاح
لا ينطبق

بناءً على الطريقة التي تستخدمها، يجب عليك تقديم دوال إضافية في الموصِّل.

يشير الجدول التالي إلى الدوال التي يجب أن تحددها بناءً على نوع المصادقة للموصل.

	OAUTH2	PATH_USER_PASS PATH_KEY USER_PASS USER_TOKEN KEY	NONE
`getAuthType()`	مطلوب تحديد خيار	مطلوب تحديد خيار	مطلوب تحديد خيار
`resetAuth()`	مطلوب تحديد خيار	مطلوب تحديد خيار
`isAuthValid()`	مطلوب تحديد خيار	مطلوب تحديد خيار
`authCallback()`	مطلوب تحديد خيار
`get3PAuthorizationUrls()`	مطلوب تحديد خيار
`setCredentials()`		مطلوب تحديد خيار

`getAuthType()`

من المفترض أن تعرض هذه الدالة نوع المصادقة للموصل.

OAUTH2

data-studio/auth.gs

العرض على 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

العرض على 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

العرض على 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();
}

KEY

data-studio/auth.gs

العرض على 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();
}

NONE

data-studio/auth.gs

العرض على 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()`

ستؤدي هذه الدالة إلى محو أي بيانات اعتماد تم تخزينها للمستخدم من أجل خدمة الجهة الخارجية.

OAUTH2

data-studio/auth.gs

العرض على 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

العرض على 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

العرض على GitHub

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

KEY

data-studio/auth.gs

العرض على GitHub

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

isAuthValid()

يتم استدعاء هذه الدالة لتحديد ما إذا كانت المصادقة لخدمة الجهة الخارجية صالحة أم لا. إذا كانت المصادقة صالحة، من المتوقّع ألا يتعذّر الوصول إلى getData() وgetSchema() بسبب الدخول غير المصرّح به. إذا كانت المصادقة غير صالحة، قد يتلقّى المستخدم إشعارًا لبدء عملية التفويض.

OAUTH2

data-studio/auth.gs

العرض على 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

العرض على 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

العرض على 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);
}

KEY

data-studio/auth.gs

العرض على 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`

إضافة OAuth2 وإعداده لمكتبة برمجة التطبيقات

اتّبِع تعليمات الإعداد لمكتبة OAuth2 لمكتبة "برمجة تطبيقات Google" لإضافتها إلى مشروع الموصِّل. بعد ذلك، اتّبِع الخطوة الأولى في دليل الاستخدام لإنشاء خدمة OAuth2 في مشروع الموصِّل. يمكن أن يكون لخدمة OAuth2 أي اسم وظيفة صالح، ولكن تأكَّد من استخدام الاسم نفسه عند الإشارة إلى خدمة OAuth2 في الرمز.

على سبيل المثال، خدمة OAuth2 باسم exampleService:

data-studio/auth.gs

العرض على 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()`

يتم استدعاء هذه الدالة لإكمال مسار OAuth 2.0. يتم توفير استجابة معاودة الاتصال من خدمة المصادقة التابعة لجهة خارجية كوسيطة ويجب التعامل معها من خلال هذه الدالة.

مثال على التعامل مع معاودة الاتصال بـ OAuth 2.0 باستخدام مكتبة OAuth2 لمكتبة برمجة تطبيقات:

data-studio/auth.gs

العرض على 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()`

يتم استدعاء هذه الدالة للحصول على عنوان URL المطلوب لبدء تدفق المصادقة للخدمة التابعة لجهة خارجية. إذا عرَضَ isAuthValid الخطأ false، سيتم عرض عنوان URL المعروض للمستخدم كزر أو رابط حتى يتمكّن من السماح بالوصول إلى خدمة الجهة الخارجية. راجِع مرجع get3PتفويضUrls().

مثال لعرض عنوان URL للتفويض باستخدام OAuth2 لمكتبة برمجة التطبيقات:

data-studio/auth.gs

العرض على 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` و`PATH_KEY`

يجب استخدام ما يلي فقط لعمليات المصادقة USER_PASS وUSER_TOKEN وKEY وPATH_USER_PASS وPATH_KEY.

`setCredentials()`

يتم استدعاء setCredentials بعد إدخال المستخدم إما معلومات بيانات الاعتماد في صفحة ضبط موصل المنتدى. عليك استخدام خدمة الخصائص لحفظ بيانات الاعتماد على أساس كل مستخدم باستخدام 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

العرض على 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

العرض على 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'
  };
}

KEY

data-studio/auth.gs

العرض على 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'
  };
}

المصادقة

getAuthType()

OAUTH2

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

KEY

NONE

resetAuth()

OAUTH2

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

KEY

isAuthValid()

OAUTH2

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

KEY

OAUTH2

إضافة OAuth2 وإعداده لمكتبة برمجة التطبيقات

authCallback()

get3PAuthorizationUrls()

USER_PASS وUSER_TOKEN وKEY وPATH_USER_PASS وPATH_KEY

setCredentials()

PATH_USER_PASS

PATH_KEY

USER_PASS

USER_TOKEN

KEY

`getAuthType()`

`resetAuth()`

`OAUTH2`

`authCallback()`

`get3PAuthorizationUrls()`

`USER_PASS` و`USER_TOKEN` و`KEY` و`PATH_USER_PASS` و`PATH_KEY`

`setCredentials()`