REST Resource: documents

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

يمثّل المستند جزءًا من المحتوى من مجموعة Developer Knowledge.

تمثيل JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
الحقول
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 المستند.

DocumentView

تحدّد هذه السمة الحقول التي يتم تضمينها في Document.

عمليات التعداد
DOCUMENT_VIEW_UNSPECIFIED القيمة التلقائية أو غير المضبوطة راجِع كل طريقة من طرق واجهة برمجة التطبيقات لمعرفة القيمة التلقائية إذا لم يتم تحديد DocumentView.
DOCUMENT_VIEW_BASIC

تتضمّن هذه السمة حقول البيانات الوصفية الأساسية فقط: - name - uri - dataSource - title - description - updateTime - view

هذه هي طريقة العرض التلقائية لـ DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL تتضمّن جميع حقول Document.
DOCUMENT_VIEW_CONTENT

يتضمّن حقول DOCUMENT_VIEW_BASIC وحقل content.

هذا هو العرض التلقائي لـ DeveloperKnowledge.GetDocument وDeveloperKnowledge.BatchGetDocuments.

الطُرق

batchGet

 يستردّ هذا الإجراء مستندات متعددة، يحتوي كل منها على محتوى Markdown الكامل.

get

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

searchDocumentChunks

 يبحث هذا المكوّن الإضافي عن معلومات للمطوّرين في مستندات Google الخاصة بالمطوّرين.