แม่แบบการกำหนดค่าระยะไกลและการกำหนดเวอร์ชัน

เทมเพลต Remote Config คือชุดพารามิเตอร์และเงื่อนไขรูปแบบ JSON ฝั่งเซิร์ฟเวอร์ที่คุณสร้างขึ้นสำหรับโปรเจ็กต์ Firebase คุณสามารถแก้ไขและจัดการเทมเพลตโดยใช้คอนโซล Firebase ซึ่งแสดงเนื้อหาของเทมเพลตในรูปแบบกราฟิกในแท็บ พารามิเตอร์ และ เงื่อนไข คุณยังสามารถใช้ API แบ็กเอนด์การกำหนดค่าระยะไกล หรือ Firebase CLI เพื่อแก้ไขและจัดการการกำหนดค่าของคุณได้

นี่คือตัวอย่างไฟล์เทมเพลต:

  {
    "conditions": [
      {
        "name": "ios",
        "expression": "device.os == 'ios'"
      }
    ],
    "parameters": {
      "welcome_message": {
        "defaultValue": {
          "value": "Welcome to this sample app"
        },
        "conditionalValues": {
          "ios": {
            "value": "Welcome to this sample iOS app"
          }
        }
      },
      "welcome_message_caps": {
        "defaultValue": {
          "value": "false"
        }
      },
      "header_text": {
        "defaultValue": {
          "useInAppDefault": true
        }
      }
    },
    "version": {
      "versionNumber": "28",
      "updateTime": "2020-05-14T18:39:38.994Z",
      "updateUser": {
        "email": "user@google.com"
      },
      "updateOrigin": "CONSOLE",
      "updateType": "INCREMENTAL_UPDATE"
    }
  }

ทุกครั้งที่คุณอัปเดตพารามิเตอร์ Remote Config จะสร้างเทมเพลต Remote Config เวอร์ชันใหม่และเก็บเทมเพลตก่อนหน้าเป็นเวอร์ชันที่คุณสามารถดึงข้อมูลหรือย้อนกลับได้ตามต้องการ หมายเลขเวอร์ชันจะเพิ่มขึ้นตามลำดับจากค่าเริ่มต้นที่เก็บไว้โดยการกำหนดค่าระยะไกล เทมเพลตทั้งหมดมีฟิลด์ version ตามที่แสดง ซึ่งมีข้อมูลเมตาเกี่ยวกับเวอร์ชันเฉพาะนั้น

ด้วยคอนโซล Firebase, Firebase CLI หรือ API แบ็กเอนด์การกำหนดค่าระยะไกล คุณสามารถดำเนินการจัดการเวอร์ชันเหล่านี้ได้:

  • แสดงรายการเวอร์ชันเทมเพลตที่เก็บไว้ทั้งหมด
  • ดึงข้อมูลเฉพาะรุ่น
  • ย้อนกลับไปยังเวอร์ชันเฉพาะ

เมื่อคุณจัดการเทมเพลต Remote Config โปรดคำนึงถึงเกณฑ์การหมดอายุ: เทมเพลต Remote Config ที่ใช้งานอยู่ในปัจจุบันที่แอปของคุณใช้ ไม่มี วันหมดอายุ อย่างไรก็ตาม หากมีการแทนที่ด้วยการอัปเดต เวอร์ชันก่อนหน้าจะถูกเก็บไว้เป็นเวลา 90 วัน หลังจากนั้นจะหมดอายุและไม่สามารถเรียกคืนได้ นอกจากนี้ยังมีการจำกัดเวอร์ชันที่จัดเก็บไว้ทั้งหมด 300 เวอร์ชัน หากคุณต้องการจัดเก็บหรือย้อนกลับไปยังเทมเพลตที่เกินขีดจำกัด ให้บันทึกและจัดเก็บด้วยตนเอง

จัดการเวอร์ชันเทมเพลตการกำหนดค่าระยะไกล

ส่วนนี้อธิบายวิธีจัดการเวอร์ชันของเทมเพลต Remote Config ของคุณ สำหรับรายละเอียดเพิ่มเติมเกี่ยวกับวิธีการสร้าง แก้ไข และบันทึกเทมเพลตโดยทางโปรแกรม โปรดดูที่ แก้ไขการกำหนดค่าระยะไกลโดยทางโปรแกรม

แสดงรายการเทมเพลต Remote Config เวอร์ชันที่เก็บไว้ทั้งหมด

คุณสามารถดึงรายการของเทมเพลต Remote Config เวอร์ชันที่เก็บไว้ทั้งหมดได้ ตัวอย่างเช่น:

Node.js

function listAllVersions() {
  admin.remoteConfig().listVersions()
    .then((listVersionsResult) => {
      console.log("Successfully fetched the list of versions");
      listVersionsResult.versions.forEach((version) => {
        console.log('version', JSON.stringify(version));
      });
    })
    .catch((error) => {
      console.log(error);
    });
}

Java

ListVersionsPage page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
while (page != null) {
  for (Version version : page.getValues()) {
    System.out.println("Version: " + version.getVersionNumber());
  }
  page = page.getNextPage();
}

// Iterate through all versions. This will still retrieve versions in batches.
page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
for (Version version : page.iterateAll()) {
  System.out.println("Version: " + version.getVersionNumber());
}

พักผ่อน

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:listVersions

คอนโซล Firebase

ในแท็บ พารามิเตอร์ เลือกไอคอน "นาฬิกา" ที่แสดงที่ด้านบนขวา ซึ่งจะเปิดหน้า ประวัติการเปลี่ยนแปลง ที่แสดงเวอร์ชันเทมเพลตที่เก็บไว้ทั้งหมดในเมนูรายการทางด้านขวา

รายละเอียดที่แสดงสำหรับเวอร์ชันที่เก็บไว้แต่ละเวอร์ชันประกอบด้วยข้อมูลว่าการเปลี่ยนแปลงเกิดขึ้นจาก Console กับ REST API จากการย้อนกลับ หรือการเปลี่ยนแปลงที่เพิ่มขึ้นจากการบันทึกเทมเพลตที่บังคับ

Firebase CLI

firebase remoteconfig:versions:list

ใช้ตัวเลือก --limit เพื่อจำกัดจำนวนเวอร์ชันที่ส่งคืน ผ่าน '0' เพื่อดึงข้อมูลทุกเวอร์ชัน

รายการเทมเพลตประกอบด้วยข้อมูลเมตาสำหรับเวอร์ชันที่เก็บไว้ทั้งหมด รวมถึงเวลาของการอัปเดต ผู้ใช้ที่สร้างมันขึ้นมา และไม่ว่าจะสร้างขึ้นผ่านคอนโซลหรือ REST API นี่คือตัวอย่างขององค์ประกอบเวอร์ชัน:

{
  "versions": [{
    "version_number": "6",
    "update_time": "2022-05-12T02:38:54Z",
    "update_user": {
      "name": "Jane Smith",
      "email": "jane@developer.org",
      "imageUrl": "https://lh3.googleusercontent.com/a-/..."
    },
    "description": "One small change on the console",
    "origin": "CONSOLE",
    "update_type": "INCREMENTAL_UPDATE"
  }]

เรียกเวอร์ชันเฉพาะของเทมเพลต Remote Config

คุณสามารถดึงเทมเพลต Remote Config เวอร์ชันใด ๆ ที่เก็บไว้ได้ ตัวอย่างเช่น:

Node.js

ส่งผ่าน getTemplate() โดยไม่มีอาร์กิวเมนต์ใดๆ เพื่อดึงข้อมูลเวอร์ชันล่าสุดของเทมเพลต หรือหากต้องการดึงข้อมูลเวอร์ชันเฉพาะ ให้ใช้ getTemplateAtVersion()

// Get template version: 6
admin.remoteConfig().getTemplateAtVersion('6')
  .then((template) => {
    console.log("Successfully fetched the template with ETag: " + template.etag);
  })
  .catch((error) => {
    console.log(error);
  });

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAtVersionAsync(versionNumber).get();
// See the ETag of the fetched template.
System.out.println("Successfully fetched the template with ETag: " + template.getETag());

พักผ่อน

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig?version_number=6

พารามิเตอร์ URL ?version_number ใช้ได้สำหรับการดำเนินการ GET เท่านั้น คุณไม่สามารถใช้เพื่อระบุหมายเลขเวอร์ชันสำหรับการอัปเดตได้ คำขอรับที่คล้ายกันโดยไม่มีพารามิเตอร์ ?version_number จะดึงข้อมูลเทมเพลตที่ใช้งานอยู่ในปัจจุบัน

คอนโซล Firebase

ตามค่าเริ่มต้น บานหน้าต่างรายละเอียดในแท็บ ประวัติการเปลี่ยนแปลง จะแสดงเทมเพลตที่ใช้งานอยู่ในปัจจุบัน หากต้องการดูรายละเอียดสำหรับเวอร์ชันอื่นในรายการ ให้เลือกจากเมนูด้านขวา

คุณสามารถดูความแตกต่างโดยละเอียดของเวอร์ชันที่เลือกในปัจจุบันและเวอร์ชันที่เก็บไว้อื่นๆ ได้โดยวางเมาส์เหนือเมนูบริบทสำหรับเวอร์ชันที่ไม่ได้เลือกและเลือก เปรียบเทียบกับเวอร์ชันที่เลือก

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

หรือคุณสามารถเขียนเอาต์พุตไปยังไฟล์ที่ระบุด้วย -o, FILENAME

ย้อนกลับไปยังเทมเพลต Remote Config เวอร์ชันที่เก็บไว้โดยเฉพาะ

คุณสามารถย้อนกลับไปยังเทมเพลตเวอร์ชันใดก็ได้ที่เก็บไว้ ตัวอย่างเช่น:

Node.js

// Roll back to template version: 6
admin.remoteConfig().rollback('6')
  .then((template) => {
    console.log("Successfully rolled back to template version 6.");
    console.log("New ETag: " + template.etag);
  })
  .catch((error) => {
    console.log('Error trying to rollback:', e);
  })

Java

try {
  Template template = FirebaseRemoteConfig.getInstance().rollbackAsync(versionNumber).get();
  System.out.println("Successfully rolled back to template version: " + versionNumber);
  System.out.println("New ETag: " + template.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Error trying to rollback template.");
    System.out.println(rcError.getMessage());
  }
}

พักผ่อน

หากต้องการย้อนกลับไปยังเทมเพลต Remote Config ที่จัดเก็บไว้ ให้ออก HTTP POST ด้วยเมธอดแบบกำหนดเอง :rollback และเวอร์ชันเฉพาะที่จะใช้ในเนื้อหาคำขอ ตัวอย่างเช่น:

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -H "Content-Type: application/json" -X POST https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:rollback -d '{"version_number": 6}'

การตอบกลับประกอบด้วยเนื้อหาของเทมเพลตที่เก็บไว้ซึ่งใช้งานอยู่ในขณะนี้ พร้อมด้วยข้อมูลเมตาของเวอร์ชันใหม่

คอนโซล Firebase

สำหรับเทมเพลตเวอร์ชันก่อนหน้าที่มีสิทธิ์ย้อนกลับ ปุ่มตัวเลือกเพื่อย้อนกลับไปยังเวอร์ชันนั้นจะแสดงที่ด้านบนขวาของหน้า ประวัติการเปลี่ยนแปลง คลิกและยืนยันสิ่งนี้ก็ต่อเมื่อคุณแน่ใจว่าต้องการย้อนกลับเป็นเวอร์ชันนั้นและใช้ค่าเหล่านั้น ทันที สำหรับแอปและผู้ใช้ทั้งหมด

Firebase CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

โปรดทราบว่าการดำเนินการย้อนกลับนี้จะสร้างเวอร์ชันที่มีหมายเลขใหม่อย่างมีประสิทธิภาพ ตัวอย่างเช่น การย้อนกลับจากเวอร์ชัน 10 ไปเป็นเวอร์ชัน 6 จะสร้างสำเนาใหม่ของเวอร์ชัน 6 อย่างมีประสิทธิภาพ ซึ่งแตกต่างจากเวอร์ชันเดิมเฉพาะที่หมายเลขเวอร์ชันคือ 11 เวอร์ชันดั้งเดิม 6 ยังคงถูกเก็บไว้ โดยถือว่ายังไม่หมดอายุ และ เวอร์ชัน 11 กลายเป็นเทมเพลตที่ใช้งานอยู่

ดาวน์โหลดค่าเริ่มต้นของเทมเพลตการกำหนดค่าระยะไกล

เนื่องจากแอปของคุณอาจไม่ได้เชื่อมต่อกับอินเทอร์เน็ตเสมอไป คุณควรกำหนดค่าเริ่มต้นของแอปฝั่งไคลเอ็นต์สำหรับพารามิเตอร์ Remote Config ทั้งหมด นอกจากนี้ คุณควรซิงโครไนซ์ค่าเริ่มต้นของไคลเอ็นต์แอปและค่าพารามิเตอร์เริ่มต้นแบ็คเอนด์ของการกำหนดค่าระยะไกลเป็นระยะ เนื่องจากอาจมีการเปลี่ยนแปลงเมื่อเวลาผ่านไป

ตามที่อธิบายไว้ในลิงก์เฉพาะแพลตฟอร์มที่ส่วนท้ายของส่วนนี้ คุณสามารถตั้งค่าเริ่มต้นเหล่านี้ด้วยตนเองในแอปของคุณ หรือคุณสามารถปรับปรุงกระบวนการนี้ได้โดยดาวน์โหลดไฟล์ที่มี เฉพาะ คู่คีย์-ค่าสำหรับพารามิเตอร์ทั้งหมดและค่าเริ่มต้นใน เทมเพลต Remote Config ที่ใช้งานอยู่ จากนั้นคุณสามารถรวมไฟล์นี้ไว้ในโปรเจ็กต์ของคุณและกำหนดค่าแอปของคุณเพื่อนำเข้าค่าเหล่านี้

คุณสามารถดาวน์โหลดไฟล์เหล่านี้ในรูปแบบ XML สำหรับแอป Android รูปแบบรายการคุณสมบัติ (plist) สำหรับแอป iOS และ JSON สำหรับเว็บแอป

เราแนะนำให้ดาวน์โหลดค่าเริ่มต้นของการกำหนดค่าระยะไกลเป็นระยะก่อนเปิดตัวแอปใหม่ เพื่อให้แน่ใจว่าแอปของคุณและแบ็คเอนด์การกำหนดค่าระยะไกลจะซิงค์กัน

ในการดาวน์โหลดไฟล์ที่มีเทมเพลตเริ่มต้น:

พักผ่อน

curl --compressed -D headers -H "Authorization: Bearer token -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=file_format'

ใช้ XML , PLIST หรือ JSON เป็นค่า format ขึ้นอยู่กับรูปแบบไฟล์ที่คุณต้องการดาวน์โหลด

คอนโซล Firebase

  1. ในแท็บ Parameters ให้เปิด Menu และเลือก Download default values
  2. เมื่อได้รับแจ้ง ให้คลิกปุ่มตัวเลือกที่ตรงกับรูปแบบไฟล์ที่คุณต้องการดาวน์โหลด จากนั้นคลิก ดาวน์โหลดไฟล์

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการนำเข้าค่าเริ่มต้นของการกำหนดค่าระยะไกลไปยังแอปของคุณ โปรดดูที่: