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 ערך ברירת המחדל או הערך שלא הוגדר. אם לא מציינים את הערך DocumentView, המערכת משתמשת בערך ברירת המחדל של כל שיטת API.
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.

Methods

batchGet

 אחזור של כמה מסמכים, כל אחד עם תוכן Markdown מלא.

get

 מאחזר מסמך יחיד עם תוכן Markdown מלא.

searchDocumentChunks

 חיפוש ידע למפתחים במסמכי התיעוד למפתחים של Google.