REST Resource: documents

منبع: سند

یک سند، بخشی از محتوا را از مجموعه دانش توسعه‌دهندگان نشان می‌دهد.

نمایش 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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

view

enum ( DocumentView )

فقط خروجی. نمای سند DocumentView را مشخص می‌کند.

نمای سند

مشخص می‌کند که کدام فیلدهای Document شامل می‌شوند.

انوم‌ها
DOCUMENT_VIEW_UNSPECIFIED مقدار پیش‌فرض / تنظیم نشده. در صورت مشخص نشدن DocumentView برای اطلاع از مقدار پیش‌فرض هر متد API به آن مراجعه کنید.
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

 در مستندات توسعه‌دهندگان گوگل، دانش توسعه‌دهندگان را جستجو می‌کند.