Firebase की मदद से कैश मेमोरी

Data Studio में, रिपोर्ट के लिए अपना कैश मेमोरी सिस्टम होता है. कनेक्टर बनाते समय, कस्टम कैश मेमोरी लागू की जा सकती है. इससे रिपोर्ट तेज़ी से जनरेट होती हैं और एपीआई कॉल की संख्या पर लगी सीमा से बचा जा सकता है.

उदाहरण के लिए, आपको एक ऐसा कनेक्टर बनाना है जो किसी ज़िप कोड के लिए, पिछले सात दिनों का मौसम का डेटा उपलब्ध कराता हो. आपका कनेक्टर काफ़ी लोकप्रिय हो रहा है, लेकिन जिस बाहरी एपीआई से डेटा फ़ेच किया जा रहा है उस पर दर की सीमाएं लागू हैं. यह एपीआई, डेटा को सिर्फ़ हर दिन अपडेट करता है. इसलिए, किसी पिन कोड के लिए एक दिन में एक ही डेटा को कई बार फ़ेच करने की ज़रूरत नहीं होती. इस समाधान गाइड का इस्तेमाल करके, हर पिन कोड के लिए रोज़ाना कैश मेमोरी लागू की जा सकती है.

ज़रूरी शर्तें

Firebase रीयलटाइम डेटाबेस. अगर आपके पास ऐसा कोई प्रोजेक्ट नहीं है, तो Google Cloud Platform (GCP) प्रोजेक्ट बनाएं. इसके बाद, शुरू करें गाइड में दिए गए निर्देशों का पालन करके, अपना Firebase Realtime Database इंस्टेंस बनाएं.
Firebase रीयलटाइम डेटाबेस से डेटा पढ़ने और लिखने के लिए, GCP सेवा खाता.
ऐसा कम्यूनिटी कनेक्टर जो किसी सोर्स से डेटा फ़ेच करता है.

सीमाएं

इस समाधान का इस्तेमाल [Data Studio की ऐडवांस सेवाएं] के साथ नहीं किया जा सकता. Data Studio की ऐडवांस सेवाओं का इस्तेमाल करने पर, Apps Script में मौजूद आपके कनेक्टर कोड के पास डेटा का ऐक्सेस नहीं होता. इसलिए, Apps Script का इस्तेमाल करके डेटा को कैश नहीं किया जा सकता.
रिपोर्ट एडिटर और दर्शक, इस कैश मेमोरी को रीसेट नहीं कर सकते.

समाधान

सेवा खाता लागू करना

अपने Google Cloud प्रोजेक्ट में, एक सेवा खाता बनाएं.
पक्का करें कि इस सेवा खाते के पास, Cloud प्रोजेक्ट में BigQuery का ऐक्सेस हो.
- पहचान और ऐक्सेस मैनेजमेंट (आईएएम) की ज़रूरी भूमिकाएं: Firebase Admin
सेवा खातों की कुंजियां पाने के लिए, JSON फ़ाइल डाउनलोड करें. फ़ाइल के कॉन्टेंट को अपने कनेक्टर प्रोजेक्ट की स्क्रिप्ट प्रॉपर्टी में सेव करें. कुंजियां जोड़ने के बाद, Apps Script के यूज़र इंटरफ़ेस (यूआई) में यह इस तरह दिखनी चाहिए:
अपने Apps Script प्रोजेक्ट में, Apps Script के लिए OAuth2 लाइब्रेरी को शामिल करें.
सेवा खाते के लिए ज़रूरी OAuth2 कोड लागू करें:

firestore-cache/src/firebase.js

GitHub पर देखें

var SERVICE_ACCOUNT_CREDS = 'SERVICE_ACCOUNT_CREDS';
var SERVICE_ACCOUNT_KEY = 'private_key';
var SERVICE_ACCOUNT_EMAIL = 'client_email';
var BILLING_PROJECT_ID = 'project_id';

var scriptProperties = PropertiesService.getScriptProperties();

/**
 * Copy the entire credentials JSON file from creating a service account in GCP.
 * Service account should have `Firebase Admin` IAM role.
 */
function getServiceAccountCreds() {
  return JSON.parse(scriptProperties.getProperty(SERVICE_ACCOUNT_CREDS));
}

function getOauthService() {
  var serviceAccountCreds = getServiceAccountCreds();
  var serviceAccountKey = serviceAccountCreds[SERVICE_ACCOUNT_KEY];
  var serviceAccountEmail = serviceAccountCreds[SERVICE_ACCOUNT_EMAIL];

  return OAuth2.createService('FirebaseCache')
    .setAuthorizationBaseUrl('https://accounts.google.com/o/oauth2/auth')
    .setTokenUrl('https://accounts.google.com/o/oauth2/token')
    .setPrivateKey(serviceAccountKey)
    .setIssuer(serviceAccountEmail)
    .setPropertyStore(scriptProperties)
    .setCache(CacheService.getScriptCache())
    .setScope([
      'https://www.googleapis.com/auth/userinfo.email',
      'https://www.googleapis.com/auth/firebase.database'
    ]);
}

Firebase से डेटा पढ़ने और लिखने के लिए कोड लागू करना

आपको Firebase Realtime Database में डेटा पढ़ने और लिखने के लिए, Firebase Database REST API का इस्तेमाल करना होगा. नीचे दिए गए कोड में, इस एपीआई को ऐक्सेस करने के लिए ज़रूरी तरीके लागू किए गए हैं.

getData() लागू करना

कैशिंग के बिना, आपके मौजूदा getData() कोड का स्ट्रक्चर ऐसा दिखना चाहिए:

firestore-cache/src/without-caching.js

GitHub पर देखें

/*
 * This file is only to demonstrate how the `getData()` fucntion would look
 * like without the Firebase Realtime Database caching. It is not a part of
 * the connector code and should not be included in Apps Script / Clasp.
 */

function getData(request) {
  var requestedFields = getFields().forIds(
    request.fields.map(function(field) {
      return field.name;
    })
  );

  var fetchedData = fetchAndParseData(request);
  var data = getFormattedData(fetchedData, requestedFields);

  return {
    schema: requestedFields.build(),
    rows: data
  };
}

अपने getData() कोड में कैश मेमोरी का इस्तेमाल करने के लिए, यह तरीका अपनाएं:

डेटा के उस 'चंक' या 'यूनिट' का पता लगाएं जिसे कैश मेमोरी में सेव किया जाना चाहिए.
कैश मेमोरी में डेटा की सबसे छोटी यूनिट को सेव करने के लिए, एक यूनीक कुंजी बनाएं.
लागू करने के उदाहरण के लिए, configparams से zipcode का इस्तेमाल कुंजी के तौर पर किया जा रहा है.
ज़रूरी नहीं: हर उपयोगकर्ता के लिए कैश मेमोरी बनाने के लिए, बेस की और उपयोगकर्ता की पहचान की मदद से कंपोज़िट की बनाएं. लागू करने का उदाहरण:
js var baseKey = getBaseKey(request); var userEmail = Session.getEffectiveUser().getEmail(); var hasheduserEmail = getHashedValue(userEmail); var compositeKey = baseKey + hasheduserEmail;
अगर कैश मेमोरी में सेव किया गया डेटा मौजूद है, तो देखें कि कैश मेमोरी में सेव किया गया डेटा नया है या नहीं.
उदाहरण में, किसी खास पिन कोड के लिए कैश मेमोरी में सेव किए गए डेटा को मौजूदा तारीख के साथ सेव किया गया है. जब कैश मेमोरी से डेटा वापस लाया जाता है, तब कैश मेमोरी की तारीख की तुलना मौजूदा तारीख से की जाती है.
```
var cacheForZipcode = {
  data: <data being cached>,
  ymd: <current date in YYYYMMDD format>
}
```
अगर कैश मेमोरी में सेव किया गया डेटा मौजूद नहीं है या वह पुराना है, तो सोर्स से डेटा फ़ेच करें और उसे कैश मेमोरी में सेव करें.

यहां दिए गए उदाहरण में, main.js में getData() कोड शामिल है. इसमें कैश मेमोरी की सुविधा लागू की गई है.

कोड का उदाहरण

यहां FireBase का इस्तेमाल करके, कैश मेमोरी में सेव करने वाले कनेक्टर का पूरा उदाहरण दिया गया है:

main.js

firestore-cache/src/main.js

GitHub पर देखें

// [start common_connector_code]
var cc = DataStudioApp.createCommunityConnector();

function getAuthType() {
  return cc
    .newAuthTypeResponse()
    .setAuthType(cc.AuthType.NONE)
    .build();
}

function getConfig(request) {
  var config = cc.getConfig();

  config
    .newTextInput()
    .setId('zipcode')
    .setName('Enter Zip Code')
    .setPlaceholder('eg. 95054');

  return config.build();
}

function getFields() {
  var fields = cc.getFields();
  var types = cc.FieldType;
  var aggregations = cc.AggregationType;

  fields
    .newDimension()
    .setId('zipcode')
    .setName('Zip code')
    .setType(types.TEXT);

  fields
    .newDimension()
    .setId('date')
    .setName('Date')
    .setType(types.YEAR_MONTH_DAY);

  fields
    .newMetric()
    .setId('temperature')
    .setName('Temperature (F)')
    .setType(types.NUMBER)
    .setIsReaggregatable(false);

  return fields;
}

function getSchema(request) {
  return {
    schema: getFields().build()
  };
}
// [end common_connector_code]

// [start caching_implementation]
function getData(request) {
  var requestedFields = getFields().forIds(
    request.fields.map(function(field) {
      return field.name;
    })
  );

  var cacheUpdateNeeded = true;
  var url = buildFirebaseUrl(request.configParams.zipcode);
  var cache = firebaseCache('get', url);

  if (cache) {
    var currentYmd = getCurrentYmd();
    cacheUpdateNeeded = currentYmd > cache.ymd;
  }

  if (cacheUpdateNeeded) {
    var fetchedData = fetchAndParseData(request);
    cache = {};
    cache.data = fetchedData;
    cache.ymd = currentYmd;
    firebaseCache('delete', url);
    firebaseCache('post', url, cache);
  }

  var data = getFormattedData(cache.data, requestedFields);

  var requestedFields = getFields().forIds(
    request.fields.map(function(field) {
      return field.name;
    })
  );

  var cache = getCachedData(request);
  var data = getFormattedData(cache, requestedFields);

  return {
    schema: requestedFields.build(),
    rows: data
  };
}

function getCachedData(request) {
  var cacheUpdateNeeded = true;
  var url = buildFirebaseUrl(request.configParams.zipcode);
  var cachedData = getFromCache(url);
  var currentYmd = getCurrentYmd();

  if (cachedData) {
    cacheUpdateNeeded = currentYmd > cachedData.ymd;
  }

  if (cacheUpdateNeeded) {
    var fetchedData = fetchAndParseData(request);
    freshData = {};
    freshData.data = fetchedData;
    freshData.ymd = currentYmd;
    deleteFromCache(url);
    putInCache(url, freshData);
    cachedData = freshData;
  }

  return cachedData.data;
}

function getCurrentYmd() {
  var currentDate = new Date();
  var year = currentDate.getFullYear();
  var month = ('0' + (currentDate.getMonth() + 1)).slice(-2);
  var date = ('0' + currentDate.getDate()).slice(-2);
  var currentYmd = year + month + date;
  return currentYmd;
}

// [end caching_implementation]

// [start common_getdata_implementation]
function fetchAndParseData(request) {
  // TODO: Connect to your own API endpoint and parse the fetched data.
  // To keep this example simple, we are returning dummy data instead of
  // connecting to an enpoint. This does not affect the caching.
  var parsedData = sampleData;
  return parsedData;
}

function getFormattedData(fetchedData, requestedFields) {
  var data = fetchedData.map(function(rowData) {
    return formatData(rowData, requestedFields);
  });
  return data;
}

function formatData(rowData, requestedFields) {
  var row = requestedFields.asArray().map(function(requestedField) {
    switch (requestedField.getId()) {
      case 'date':
        return rowData.date;
      case 'zipcode':
        return rowData.zipcode;
      case 'temperature':
        return rowData.temperature;
      default:
        return '';
    }
  });
  return {values: row};
}
// [end common_getdata_implementation]

var sampleData = [
  {
    date: '20190601',
    zipcode: '95054',
    temperature: 80
  },
  {
    date: '20190602',
    zipcode: '95054',
    temperature: 82
  },
  {
    date: '20190603',
    zipcode: '95054',
    temperature: 82
  },
  {
    date: '20190604',
    zipcode: '95054',
    temperature: 85
  },
  {
    date: '20190605',
    zipcode: '95054',
    temperature: 84
  },
  {
    date: '20190606',
    zipcode: '95054',
    temperature: 83
  },
  {
    date: '20190607',
    zipcode: '95054',
    temperature: 81
  }
];

firebase.js

firestore-cache/src/firebase.js

GitHub पर देखें

// [start firebase_access_implementation]

var FIREBASE_REALTIME_DB_BASE_URL = '.firebaseio.com';
var FIREBASE_REALTIME_DB_COLLECTION = '/cache';

/**
 * Returns the URL for a file in a firebase database.
 *
 * @param {string} fileName The filename in the database
 * @returns {string} The url for the file in the database
 */
function buildFirebaseUrl(fileName) {
  var serviceAccountCreds = getServiceAccountCreds();
  var projectId = serviceAccountCreds[BILLING_PROJECT_ID];

  if (fileName) {
    fileName = '/' + fileName;
  }
  var urlElements = [
    'https://',
    projectId,
    FIREBASE_REALTIME_DB_BASE_URL,
    FIREBASE_REALTIME_DB_COLLECTION,
    fileName,
    '.json'
  ];
  var url = urlElements.join('');
  return url;
}

/**
 * Generic method for handling the Firebase Realtime Database REST API.
 * For `get`: returns the data at the given url.
 * For `post`: posts the data in in firestore db at the given url and returns `undefined`.
 * For `delete`: deletes the data at the given url and returns `undefined`.
 *
 * @param {string} method Method for the REST API: `get`, `post`, or `delete`
 * @param {string} url REST endpoint
 * @param {string} [data] Data to be stored for `post` method
 * @returns {undefined|object} Returns data from the REST endpoint for `get`
 *          method. For other methods, returns `undefined`.
 */
function firebaseCache(method, url, data) {
  var oAuthToken = getOauthService().getAccessToken();

  var responseOptions = {
    headers: {
      Authorization: 'Bearer ' + oAuthToken
    },
    method: method,
    contentType: 'application/json'
  };

  // Add payload for post method
  if (method === 'post') {
    responseOptions['payload'] = JSON.stringify(data);
  }

  var response = UrlFetchApp.fetch(url, responseOptions);

  // Return value only for `get`.
  if (method === 'get') {
    var responseObject = JSON.parse(response);
    if (responseObject === null) {
      return null;
    } else {
      var autoKey = Object.keys(responseObject)[0];
      var returnValue = responseObject[autoKey];
    }
    return returnValue;
  }
}

function getFromCache(url) {
  return firebaseCache('get', url);
}

function deleteFromCache(url) {
  return firebaseCache('delete', url);
}

function putInCache(url, data) {
  return firebaseCache('put', url, data);
}

// [end firebase_access_implementation]

var SERVICE_ACCOUNT_CREDS = 'SERVICE_ACCOUNT_CREDS';
var SERVICE_ACCOUNT_KEY = 'private_key';
var SERVICE_ACCOUNT_EMAIL = 'client_email';
var BILLING_PROJECT_ID = 'project_id';

var scriptProperties = PropertiesService.getScriptProperties();

/**
 * Copy the entire credentials JSON file from creating a service account in GCP.
 * Service account should have `Firebase Admin` IAM role.
 */
function getServiceAccountCreds() {
  return JSON.parse(scriptProperties.getProperty(SERVICE_ACCOUNT_CREDS));
}

function getOauthService() {
  var serviceAccountCreds = getServiceAccountCreds();
  var serviceAccountKey = serviceAccountCreds[SERVICE_ACCOUNT_KEY];
  var serviceAccountEmail = serviceAccountCreds[SERVICE_ACCOUNT_EMAIL];

  return OAuth2.createService('FirebaseCache')
    .setAuthorizationBaseUrl('https://accounts.google.com/o/oauth2/auth')
    .setTokenUrl('https://accounts.google.com/o/oauth2/token')
    .setPrivateKey(serviceAccountKey)
    .setIssuer(serviceAccountEmail)
    .setPropertyStore(scriptProperties)
    .setCache(CacheService.getScriptCache())
    .setScope([
      'https://www.googleapis.com/auth/userinfo.email',
      'https://www.googleapis.com/auth/firebase.database'
    ]);
}

अन्य संसाधन

Chrome UX कनेक्टर, हज़ारों उपयोगकर्ताओं को ~20 जीबी की BigQuery टेबल पर आधारित डैशबोर्ड उपलब्ध कराता है. यह कनेक्टर, दो लेयर वाली कैश मेमोरी की सुविधा के लिए, Firebase Realtime Database के साथ-साथ Apps Script Cache Service का इस्तेमाल करता है. लागू करने से जुड़ी जानकारी के लिए, कोड देखें.