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

Lưu vào bộ nhớ đệm bằng Firebase

Looker Studio có hệ thống bộ nhớ đệm riêng cho báo cáo. Khi tạo trình kết nối, bạn có thể triển khai bộ nhớ đệm tuỳ chỉnh để tạo báo cáo nhanh hơn và tránh bị hạn chế lãi suất hằng năm.

Ví dụ: bạn đang tạo một trình kết nối cung cấp dữ liệu thời tiết trong quá khứ trong 7 ngày qua cho một mã bưu chính cụ thể. Trình kết nối của bạn đang trở nên khá phổ biến nhưng API bên ngoài mà bạn đang tìm nạp dữ liệu có tỷ lệ nghiêm ngặt của Google. API chỉ cập nhật dữ liệu hằng ngày, nên đối với một mã bưu chính cụ thể, bạn không cần phải tìm nạp cùng một dữ liệu nhiều lần trong một ngày. Đang dùng hướng dẫn giải pháp, bạn có thể triển khai bộ nhớ đệm hằng ngày cho mỗi mã bưu chính.

Yêu cầu

Cơ sở dữ liệu theo thời gian thực của Firebase. Nếu bạn không có quyền truy cập, hãy tạo một Google Cloud Platform (GCP) và tuân thủ Hướng dẫn Bắt đầu để tạo Firebase của riêng bạn Phiên bản Cơ sở dữ liệu theo thời gian thực.
Tài khoản dịch vụ GCP để đọc và ghi dữ liệu từ Firebase Realtime Cơ sở dữ liệu.
Trình kết nối cộng đồng tìm nạp dữ liệu từ một nguồn.

Các điểm hạn chế

Không thể dùng giải pháp này với Các dịch vụ nâng cao của Looker Studio. Thời gian bạn sử dụng Dịch vụ nâng cao của Looker Studio, mã trình kết nối của bạn trong Ứng dụng Tập lệnh không có quyền truy cập vào dữ liệu. Do đó bạn không thể lưu dữ liệu vào bộ nhớ đệm bằng Apps Script.
Người chỉnh sửa và người xem báo cáo không thể đặt lại bộ nhớ đệm này.

Giải pháp

Triển khai tài khoản dịch vụ

Tạo một tài khoản dịch vụ trong dự án trên Google Cloud.
Đảm bảo tài khoản dịch vụ này có quyền truy cập vào BigQuery trong dự án trên đám mây.
- Các vai trò bắt buộc về quản lý danh tính và quyền truy cập (IAM): Firebase Admin
Tải tệp JSON xuống để lấy khoá tài khoản dịch vụ. Lưu trữ nội dung trong thuộc tính tập lệnh của dự án trình kết nối. Sau khi thêm thuộc tính khoá, sẽ có dạng như trong giao diện người dùng Apps Script:
Đưa thư viện OAuth2 cho Apps Script vào dự án Apps Script.
Triển khai mã OAuth2 bắt buộc cho tài khoản dịch vụ:

firestore-cache/src/firebase.js

Xem trên 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'
    ]);
}

Triển khai mã để đọc và ghi từ Firebase

Bạn sẽ dùng API REST của cơ sở dữ liệu Firebase để đọc và ghi vào Firebase Cơ sở dữ liệu theo thời gian thực. Mã sau đây triển khai các phương thức cần thiết để truy cập API này.

Triển khai phương thức getData()

Cấu trúc cho mã getData() hiện tại của bạn mà không cần lưu vào bộ nhớ đệm sẽ phải giống như sau:

firestore-cache/src/without-caching.js

Xem trên 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
  };
}

Để sử dụng tính năng lưu vào bộ nhớ đệm trong mã getData(), hãy làm theo các bước sau:

Xác định "đoạn" hoặc "unit" dữ liệu cần được lưu vào bộ nhớ đệm.
Tạo một khoá duy nhất để lưu đơn vị dữ liệu tối thiểu trong bộ nhớ đệm.
Trong ví dụ này về cách triển khai, zipcode trong configparams đang được sử dụng làm khoá.
Không bắt buộc: Đối với bộ nhớ đệm cho mỗi người dùng, hãy tạo một khoá kết hợp có khoá cơ sở và danh tính người dùng. Ví dụ về cách triển khai:
js var baseKey = getBaseKey(request); var userEmail = Session.getEffectiveUser().getEmail(); var hasheduserEmail = getHashedValue(userEmail); var compositeKey = baseKey + hasheduserEmail;
Nếu có dữ liệu được lưu vào bộ nhớ đệm, hãy kiểm tra xem bộ nhớ đệm có được làm mới hay không.
Trong ví dụ này, dữ liệu được lưu vào bộ nhớ đệm cho một mã bưu chính cụ thể được lưu bằng thuộc tính ngày hiện tại. Khi dữ liệu được truy xuất từ bộ nhớ đệm, ngày của bộ nhớ đệm sẽ là được kiểm tra so với ngày hiện tại.
```
var cacheForZipcode = {
  data: <data being cached>,
  ymd: <current date in YYYYMMDD format>
}
```
Nếu dữ liệu được lưu vào bộ nhớ đệm không tồn tại hoặc dữ liệu được lưu vào bộ nhớ đệm không mới, hãy tìm nạp dữ liệu khỏi nguồn và lưu trữ trong bộ nhớ đệm.

Trong ví dụ sau, main.js chứa mã getData() có chức năng lưu vào bộ nhớ đệm triển khai.

Mã mẫu

Sau đây là ví dụ hoàn chỉnh về một trình kết nối sử dụng FireBase để lưu vào bộ nhớ đệm:

main.js

firestore-cache/src/main.js

Xem trên 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

Xem trên 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'
    ]);
}

Tài nguyên khác

Trình kết nối trải nghiệm người dùng của Chrome hỗ trợ trang tổng quan dựa trên BigQuery khoảng 20 GB bảng tới hàng nghìn người dùng. Trình kết nối này sử dụng Cơ sở dữ liệu theo thời gian thực của Firebase cùng với Dịch vụ bộ nhớ đệm của Apps Script để sử dụng phương pháp lưu vào bộ nhớ đệm hai lớp. Xem mã để biết chi tiết triển khai.