REST Resource: documents

แหล่งข้อมูล: เอกสาร

เอกสารแสดงถึงเนื้อหาจากคลังความรู้ของนักพัฒนาซอฟต์แวร์

การแสดง JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView),
  "contentLengthBytes": integer
}
ช่อง
name

string

ตัวระบุ มีชื่อทรัพยากรของเอกสาร รูปแบบ: documents/{uri_without_scheme} ตัวอย่าง: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

เอาต์พุตเท่านั้น ระบุ URI ของเนื้อหา เช่น docs.cloud.google.com/storage/docs/creating-buckets
content

string

เอาต์พุตเท่านั้น มีเนื้อหาทั้งหมดของเอกสารในรูปแบบ Markdown
description

string

เอาต์พุตเท่านั้น ระบุคำอธิบายของเอกสาร
dataSource

string

เอาต์พุตเท่านั้น ระบุแหล่งข้อมูลของเอกสาร ตัวอย่างแหล่งข้อมูล: firebase.google.com
title

string

เอาต์พุตเท่านั้น ระบุชื่อเอกสาร
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น แสดงการประทับเวลาเมื่ออัปเดตเนื้อหาหรือข้อมูลเมตาของเอกสารครั้งล่าสุด

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
view

enum (DocumentView)

เอาต์พุตเท่านั้น ระบุ DocumentView ของเอกสาร
contentLengthBytes

integer

เอาต์พุตเท่านั้น ความยาวของฟิลด์ content ในหน่วยไบต์

DocumentView

ระบุว่าจะรวมฟิลด์ใดของ Document

Enum
DOCUMENT_VIEW_UNSPECIFIED ค่าเริ่มต้น / ไม่ได้ตั้งค่า ดูค่าเริ่มต้นของแต่ละเมธอด API หากไม่ได้ระบุ DocumentView
DOCUMENT_VIEW_BASIC

มีเฉพาะช่องข้อมูลเมตาพื้นฐาน ได้แก่

  • name
  • uri
  • dataSource
  • title
  • description
  • updateTime
  • view
  • contentLengthBytes

นี่คือมุมมองเริ่มต้นของ DeveloperKnowledge.SearchDocumentChunks
DOCUMENT_VIEW_FULL รวมช่อง Document ทั้งหมด
DOCUMENT_VIEW_CONTENT

รวมฟิลด์ DOCUMENT_VIEW_BASIC และฟิลด์ content

นี่คือมุมมองเริ่มต้นสำหรับ DeveloperKnowledge.GetDocument และ DeveloperKnowledge.BatchGetDocuments

เมธอด

batchGet

 ดึงข้อมูลเอกสารหลายรายการ โดยแต่ละรายการจะมีเนื้อหา Markdown ทั้งหมด

get

 ดึงข้อมูลเอกสารเดียวที่มีเนื้อหามาร์กดาวน์ทั้งหมด

searchDocumentChunks

 ค้นหาความรู้สำหรับนักพัฒนาซอฟต์แวร์ในเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์ของ Google