REST Resource: documents

Kaynak: Doküman

Belge, Geliştirici Bilgi Korpusu'ndaki bir içeriği temsil eder.

JSON gösterimi 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
Alanlar
name

string

Tanımlayıcı. Belgenin kaynak adını içerir. Biçim: documents/{uri_without_scheme} Örnek: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Yalnızca çıkış. İçeriğin URI'sini (ör. docs.cloud.google.com/storage/docs/creating-buckets) sağlar.
content

string

Yalnızca çıkış. Dokümanın tüm içeriğini Markdown biçiminde içerir.
description

string

Yalnızca çıkış. Belgenin açıklamasını sağlar.
dataSource

string

Yalnızca çıkış. Belgenin veri kaynağını belirtir. Örnek veri kaynağı: firebase.google.com
title

string

Yalnızca çıkış. Dokümanın başlığını sağlar.
updateTime

string (Timestamp format)

Yalnızca çıkış. Belgenin içeriğinin veya meta verilerinin en son güncellendiği zaman damgasını gösterir.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

Yalnızca çıkış. Belgenin DocumentView özelliğini belirtir.

DocumentView

Document öğesinin hangi alanlarının dahil edileceğini belirtir.

Sıralamalar
DOCUMENT_VIEW_UNSPECIFIED Varsayılan / ayarlanmamış değer. DocumentView belirtilmemişse varsayılan değer için her API yöntemine bakın.
DOCUMENT_VIEW_BASIC

Yalnızca temel meta veri alanlarını içerir: - name - uri - dataSource - title - description - updateTime - view

Bu, DeveloperKnowledge.SearchDocumentChunks için varsayılan görünümdür.
DOCUMENT_VIEW_FULL Tüm Document alanlarını içerir.
DOCUMENT_VIEW_CONTENT

DOCUMENT_VIEW_BASIC alanlarını ve content alanını içerir.

Bu, DeveloperKnowledge.GetDocument ve DeveloperKnowledge.BatchGetDocuments için varsayılan görünümdür.

Yöntemler

batchGet

 Her biri tam Markdown içeriğine sahip birden fazla dokümanı alır.

get

 Tam Markdown içeriğiyle tek bir dokümanı alır.

searchDocumentChunks

 Google'ın geliştirici belgelerinde geliştirici bilgisi için arama yapar.