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

Looker Studio के पास रिपोर्ट के लिए, अपना कैश सिस्टम होता है. अपनी कनेक्टर की मदद से, तेज़ी से रिपोर्ट करने के लिए कस्टम कैश मेमोरी लागू की जा सकती है और एपीआर की दर की सीमाओं से बचें.

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

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

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

सीमाएं

  • यह सलूशन, Looker Studio की बेहतर सेवाओं के साथ इस्तेमाल नहीं किया जा सकता. टास्क कब शुरू होगा Looker Studio की बेहतर सेवाओं का इस्तेमाल किया जा रहा है. यह ऐप्लिकेशन में मौजूद कनेक्टर कोड है स्क्रिप्ट के पास इस डेटा का ऐक्सेस नहीं है. इसलिए, आपके पास डेटा को कैश मेमोरी में सेव करने का विकल्प नहीं है Apps Script का इस्तेमाल करके.
  • रिपोर्ट एडिटर और व्यूअर इस कैश मेमोरी को रीसेट नहीं कर सकते.

समाधान

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

  1. अपने Google Cloud प्रोजेक्ट में सेवा खाता बनाएं.
  2. पक्का करें कि क्लाउड प्रोजेक्ट में, इस सेवा खाते के पास BigQuery का ऐक्सेस है.
    • पहचान और ऐक्सेस मैनेजमेंट (आईएएम) से जुड़ी ज़रूरी भूमिकाएं: Firebase Admin
  3. सेवा खातों की कुंजियां पाने के लिए JSON फ़ाइल डाउनलोड करें. फ़ाइल कॉन्टेंट को कनेक्ट करने के लिए किया जा सकता है. जोड़ने के बाद कुंजियां, Apps Script यूज़र इंटरफ़ेस (यूआई) में इससे मिलती-जुलती दिखनी चाहिए:
    स्क्रिप्ट प्रॉपर्टी में सेवा खाते की कुंजियां सेव की जा रही हैं
  4. अपने Apps Script प्रोजेक्ट में, Apps Script के लिए OAuth2 लाइब्रेरी को शामिल करें.
  5. सेवा खाते के लिए, ज़रूरी OAuth2 कोड लागू करें:
firestore-cache/src/firebase.js
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 डेटाबेस में बदलाव करने और उसे पढ़ने के लिए, Firebase डेटाबेस REST API का इस्तेमाल करें रीयलटाइम डेटाबेस. नीचे दिया गया कोड उन तरीकों को लागू करता है जो इस एपीआई को ऐक्सेस करके.

getData() लागू करना

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

firestore-cache/src/without-caching.js
/*
 * 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() कोड में कैश मेमोरी का इस्तेमाल करने के लिए, यह तरीका अपनाएं:

  1. 'खंड' ज्ञात करना या 'इकाई' जिसे कैश मेमोरी में सेव किया जाना चाहिए.

  2. कैश मेमोरी में डेटा की कम से कम इकाई स्टोर करने के लिए एक खास कुंजी बनाएं.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है लागू करने के उदाहरण के लिए, configparams के zipcode का इस्तेमाल किया जा रहा है का इस्तेमाल किया जा सकता है.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है ज़रूरी नहीं: हर उपयोगकर्ता की कैश मेमोरी के लिए, बेस कुंजी के साथ एक कंपोज़िट कुंजी बनाएं और उपयोगकर्ता की पहचान. लागू करने का उदाहरण:
    js var baseKey = getBaseKey(request); var userEmail = Session.getEffectiveUser().getEmail(); var hasheduserEmail = getHashedValue(userEmail); var compositeKey = baseKey + hasheduserEmail;

  3. अगर कैश मेमोरी में सेव किया गया डेटा मौजूद है, तो देखें कि कैश मेमोरी नया है या नहीं.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है उदाहरण में, किसी खास पिन कोड के लिए, कैश मेमोरी में सेव किए गए डेटा को मौजूदा तारीख. कैश मेमोरी से डेटा वापस मिलने पर कैश मेमोरी की तारीख मौजूदा तारीख से जांच की गई है.

    var cacheForZipcode = {
      data    : <data being cached>,
      ymd    : <current date in YYYYMMDD format>
    }

  4. अगर कैश मेमोरी में सेव किया गया डेटा मौजूद नहीं है या कैश मेमोरी में सेव किया गया डेटा नया नहीं है, तो डेटा फ़ेच करें सोर्स से कॉपी करता है और उसे कैश मेमोरी में सेव करता है.

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

कोड का उदाहरण

main.js

firestore-cache/src/main.js
// [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
// [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 रीयल टाइम डेटाबेस का इस्तेमाल करता है के साथ-साथ Apps Script कैश सेवा के साथ-साथ, दो लेयर वाली कैश मेमोरी में सेव करें. यहां जाएं: कोड सबमिट करें, ताकि लागू करने की जानकारी मिल सके.