REST Resource: documents

المورد: المستند

يمثّل المستند صفحة من مستندات قاعدة المعارف الخاصة بالمطوّرين، مثل الصفحة على https://docs.cloud.google.com/storage/docs/creating-buckets.

تمثيل 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.

عمليات التعداد
DOCUMENT_VIEW_UNSPECIFIED القيمة التلقائية أو غير المحدّدة راجِع كل طريقة من طرق واجهة برمجة التطبيقات لمعرفة قيمتها التلقائية في حال عدم تحديد 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

 يستردّ مستندًا واحدًا يتضمّن محتوى Markdown الكامل.

searchDocumentChunks

 يبحث عن قاعدة المعارف الخاصة بالمطوّرين في مستندات المطوّرين من Google.