REST Resource: sites.versions

แหล่งข้อมูล: เวอร์ชัน

Version คือการกำหนดค่าและคอลเล็กชันของไฟล์แบบคงที่ซึ่งกำหนดวิธีแสดงเว็บไซต์

การแสดง JSON 
{
  "name": string,
  "status": enum (VersionStatus),
  "config": {
    object (ServingConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "createUser": {
    object (ActingUser)
  },
  "finalizeTime": string,
  "finalizeUser": {
    object (ActingUser)
  },
  "deleteTime": string,
  "deleteUser": {
    object (ActingUser)
  },
  "fileCount": string,
  "versionBytes": string
}
ช่อง
name

string

ชื่อทรัพยากรที่มีคุณสมบัติครบถ้วนของเวอร์ชัน ในรูปแบบ:

sites/SITE_ID/versions/VERSION_ID

ชื่อนี้จะอยู่ในเนื้อหาการตอบกลับเมื่อคุณเรียกใช้ versions.create
status

enum (VersionStatus)

สถานะการทำให้ใช้งานได้ของเวอร์ชัน

เพื่อให้ติดตั้งใช้งานได้สำเร็จ โปรดเรียกใช้ versions.create เพื่อสร้างเวอร์ชันใหม่ (สถานะ CREATED) อัปโหลดไฟล์ที่ต้องการทั้งหมดเป็นเวอร์ชัน จากนั้นอัปเดตเวอร์ชันเป็นสถานะ FINALIZED

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

นอกจากนี้ คุณยังเปลี่ยนสถานะของเวอร์ชันเป็น DELETED ได้โดยเรียกใช้ versions.delete
config

object (ServingConfig)

การกำหนดค่าสำหรับลักษณะการทำงานของเว็บไซต์ มีการกำหนดค่านี้อยู่ในไฟล์ firebase.json
labels

map (key: string, value: string)

ป้ายกำกับที่ใช้สำหรับข้อมูลเมตาเพิ่มเติมและ/หรือการกรอง

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างเวอร์ชัน

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
createUser

object (ActingUser)

เอาต์พุตเท่านั้น ระบุผู้ใช้ที่สร้างเวอร์ชัน
finalizeTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เวอร์ชันคือ FINALIZED

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
finalizeUser

object (ActingUser)

เอาต์พุตเท่านั้น ระบุผู้ใช้ที่FINALIZEDเวอร์ชัน
deleteTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เวอร์ชันคือ DELETED

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
deleteUser

object (ActingUser)

เอาต์พุตเท่านั้น ระบุผู้ใช้ที่DELETEDเวอร์ชัน
fileCount

string (int64 format)

เอาต์พุตเท่านั้น จำนวนไฟล์ทั้งหมดที่เชื่อมโยงกับเวอร์ชันนี้

ค่านี้จะคำนวณหลังจากเวอร์ชันคือ FINALIZED
versionBytes

string (int64 format)

เอาต์พุตเท่านั้น ไบต์ที่จัดเก็บทั้งหมดของเวอร์ชัน

ค่านี้จะคำนวณหลังจากเวอร์ชันคือ FINALIZED

สถานะเวอร์ชัน

สถานะปัจจุบันของเวอร์ชันที่เจาะจงในวงจรการทำให้ใช้งานได้

Enum
VERSION_STATUS_UNSPECIFIED สถานะเริ่มต้น คุณไม่ควรจงใจ
CREATED สร้างเวอร์ชันนี้แล้วและกำลังเพิ่มเนื้อหาลงในเวอร์ชันนี้
FINALIZED เนื้อหาทั้งหมดถูกเพิ่มลงในเวอร์ชันนี้และไม่สามารถเปลี่ยนแปลงเวอร์ชันได้อีกต่อไป
DELETED ลบเวอร์ชันนี้แล้ว
ABANDONED เวอร์ชันนี้ไม่ได้อัปเดตเป็น FINALIZED ภายใน 12 ชั่วโมงและถูกลบโดยอัตโนมัติ
EXPIRED เวอร์ชันนี้อยู่นอกขีดจำกัดที่เว็บไซต์กำหนดไว้สำหรับจำนวนเวอร์ชันที่เก็บรักษาไว้ ระบบจึงกำหนดเวลาในการลบเนื้อหาของเวอร์ชัน
CLONING กำลังโคลนเวอร์ชันนี้จากเวอร์ชันอื่น เนื้อหาทั้งหมดยังคงอยู่ระหว่างการคัดลอก

DISPLAYConfig

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

การแสดง JSON 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
ช่อง
headers[]

object (Header)

อาร์เรย์ของออบเจ็กต์ที่แต่ละออบเจ็กต์ระบุรูปแบบ URL ซึ่งหากตรงกับเส้นทาง URL ของคำขอ โฮสติ้งให้ใช้ส่วนหัวการตอบกลับที่กำหนดเองที่ระบุไว้
redirects[]

object (Redirect)

อาร์เรย์ของออบเจ็กต์ (เรียกว่ากฎการเปลี่ยนเส้นทาง) ซึ่งแต่ละกฎจะระบุรูปแบบ URL ซึ่งหากตรงกับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ตอบกลับด้วยการเปลี่ยนเส้นทางไปยังเส้นทางปลายทางที่ระบุ
rewrites[]

object (Rewrite)

อาร์เรย์ของออบเจ็กต์ (เรียกว่ากฎการเขียนใหม่) โดยที่แต่ละกฎระบุรูปแบบ URL ซึ่งหากตรงกับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ตอบกลับราวกับว่าบริการได้รับ URL ปลายทางที่ระบุ
cleanUrls

boolean

กำหนดว่าจะวางนามสกุลไฟล์จากไฟล์ที่อัปโหลดหรือไม่
trailingSlashBehavior

enum (TrailingSlashBehavior)

กำหนดวิธีจัดการเครื่องหมายทับต่อท้ายในเส้นทาง URL
i18n

object (I18nConfig)

ไม่บังคับ กำหนดลักษณะการเขียน i18n ใหม่

Header จะระบุรูปแบบ URL ซึ่งหากตรงกับเส้นทาง URL ของคำขอ โฮสติ้งให้ใช้ส่วนหัวการตอบกลับที่กำหนดเอง

การแสดง JSON 
{
  "headers": {
    string: string,
    ...
  },

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
ช่อง
headers

map (key: string, value: string)

ต้องระบุ ส่วนหัวเพิ่มเติมที่จะเพิ่มลงในคำตอบ

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
ช่องการรวม pattern
ต้องระบุ รูปแบบ URL ของสตริงที่จะจับคู่กับเส้นทาง URL คำขอเพื่อระบุว่าจะใช้ส่วนหัวการตอบกลับที่กำหนดเองนี้หรือไม่ อาจเป็น glob แบบ Bash หรือนิพจน์ทั่วไป RE2

pattern เป็นได้เพียงค่าใดค่าหนึ่งต่อไปนี้
glob

string

glob ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ
regex

string

นิพจน์ทั่วไป RE2 ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ

เปลี่ยนเส้นทาง

Redirect ระบุรูปแบบ URL ที่ถ้าตรงกับเส้นทาง URL คำขอ โฮสติ้งให้ตอบกลับด้วยการเปลี่ยนเส้นทางไปยังเส้นทางปลายทางที่ระบุ

การแสดง JSON 
{
  "statusCode": integer,
  "location": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
ช่อง
statusCode

integer

ต้องระบุ รหัส HTTP สถานะที่จะแสดงผลในการตอบกลับ ต้องเป็นรหัสสถานะ 3xx ที่ถูกต้อง
location

string

ต้องระบุ ค่าที่จะใส่ในส่วนหัวตำแหน่ง HTTP ของคำตอบ

ตำแหน่งอาจมีค่าแคปเจอร์กรุ๊ปจากรูปแบบที่ใช้คำนำหน้า : ในการระบุกลุ่ม และจะมี * ที่ไม่บังคับเพื่อบันทึก URL ที่เหลือ เช่น

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"
ช่องการรวม pattern
ต้องระบุ รูปแบบ URL สตริงที่จะจับคู่กับเส้นทาง URL คำขอ เพื่อพิจารณาว่าจะใช้การเปลี่ยนเส้นทางนี้หรือไม่ อาจเป็น glob แบบ Bash หรือนิพจน์ทั่วไป RE2

pattern ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
glob

string

glob ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ
regex

string

นิพจน์ทั่วไป RE2 ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ

เขียนใหม่

Rewrite จะระบุรูปแบบ URL ซึ่งหากตรงกับเส้นทาง URL คำขอ โฮสติ้งให้ตอบสนองเสมือนว่าบริการได้รับ URL ปลายทางที่ระบุ

การแสดง JSON 
{
  "functionRegion": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.

  // Union field behavior can be only one of the following:
  "path": string,
  "function": string,
  "run": {
    object (CloudRunRewrite)
  }
  // End of list of possible types for union field behavior.
}
ช่อง
functionRegion

string

ไม่บังคับ ระบุภูมิภาคระบบคลาวด์สำหรับการเรียกใช้ฟังก์ชันที่เขียนใหม่ หากไม่ระบุ ระบบจะใช้ค่าเริ่มต้นเป็น us-central1
ช่องการรวม pattern
ต้องระบุ รูปแบบ URL สตริงที่จะจับคู่กับเส้นทาง URL ของคำขอเพื่อระบุว่าจะใช้การเขียนใหม่นี้หรือไม่ อาจเป็น glob แบบ Bash หรือนิพจน์ทั่วไป RE2

pattern ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
glob

string

glob ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ
regex

string

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

behavior ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
path

string

เส้นทาง URL ที่จะเขียนคำขอใหม่
function

string

ฟังก์ชันสำหรับส่งคำขอไปยังพร็อกซี ต้องตรงกับชื่อฟังก์ชันที่ส่งออกทุกประการ
run

object (CloudRunRewrite)

ระบบจะส่งต่อคำขอไปยัง Cloud Run

เขียน Cloud Run ใหม่

การเขียนใหม่ที่กำหนดค่าไว้ซึ่งส่งคำขอไปยังบริการ Cloud Run หากไม่มีบริการ Cloud Run ขณะตั้งค่าหรืออัปเดตการกำหนดค่าโฮสติ้งของ Firebase คำขอจะล้มเหลว ระบบจะส่งข้อผิดพลาดจากบริการ Cloud Run ไปยังผู้ใช้ปลายทาง (เช่น หากคุณลบบริการ คำขอที่ส่งไปยังบริการนั้นจะได้รับข้อผิดพลาด 404)

การแสดง JSON 
{
  "serviceId": string,
  "region": string,
  "tag": string
}
ช่อง
serviceId

string

ต้องระบุ รหัสของบริการ Cloud Run ที่ผู้ใช้กำหนด
region

string

ไม่บังคับ ภูมิภาคที่ผู้ใช้ระบุซึ่งโฮสต์บริการ Cloud Run อยู่

ค่าเริ่มต้นจะเป็น us-central1 หากไม่ได้ให้ไว้
tag

string

ไม่บังคับ แท็ก TrafficConfig ที่ผู้ใช้ระบุเพื่อส่งการเข้าชมไปให้

หากไม่ระบุ ระบบจะส่งการรับส่งข้อมูลไปยัง URI ทั่วทั้งบริการ

ลักษณะการทำงานของเครื่องหมายทับปิดท้าย

กำหนดว่าควรเพิ่มหรือนำเครื่องหมายทับต่อท้ายออกจากเส้นทาง URL คำขอ

Enum
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

ไม่ได้ระบุลักษณะการทำงาน

ไฟล์จะแสดงในตำแหน่งที่แน่นอนเท่านั้น และจะเพิ่มเครื่องหมายทับต่อท้ายลงในดัชนีไดเรกทอรีเท่านั้น
ADD ระบบจะเพิ่มเครื่องหมายทับต่อท้ายลงในดัชนีไดเรกทอรี รวมถึงเส้นทาง URL ที่ไม่ได้ลงท้ายด้วยนามสกุลไฟล์
REMOVE ระบบจะนำเครื่องหมายทับต่อท้ายออกจากดัชนีไดเรกทอรีและจากเส้นทาง URL ที่ไม่ได้ลงท้ายด้วยนามสกุลไฟล์

การกำหนดค่า

หากระบุ จะมีการเปิดใช้การเขียน i18n ใหม่

การแสดง JSON 
{
  "root": string
}
ช่อง
root

string

ต้องระบุ เส้นทางที่ผู้ใช้ระบุ ซึ่งจะค้นหาเนื้อหาเฉพาะประเทศและภาษาในไดเรกทอรีสาธารณะ

เมธอด

clone

 สร้างเวอร์ชันใหม่ในเว็บไซต์เป้าหมายที่ระบุโดยใช้เนื้อหาของเวอร์ชันที่ระบุ

create

 สร้างเวอร์ชันใหม่สำหรับเว็บไซต์ที่ระบุ

delete

 ลบเวอร์ชันที่ระบุ

get

 รับเวอร์ชันที่ระบุซึ่งสร้างขึ้นสำหรับเว็บไซต์ที่ระบุ

list

 แสดงรายการเวอร์ชันที่สร้างขึ้นสำหรับเว็บไซต์ที่ระบุ

patch

 อัปเดตข้อมูลเมตาที่ระบุสำหรับเวอร์ชันที่ระบุ

populateFiles

 เพิ่มไฟล์เนื้อหาไปยังเวอร์ชันที่ระบุ