REST Resource: documents

리소스: Document

문서는 개발자 지식 코퍼스의 콘텐츠를 나타냅니다.

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

출력 전용입니다. 문서의 전체 콘텐츠를 마크다운 형식으로 포함합니다.
description

string

출력 전용입니다. 문서에 대한 설명을 제공합니다.
dataSource

string

출력 전용입니다. 문서의 데이터 소스를 지정합니다. 데이터 소스 예: firebase.google.com
title

string

출력 전용입니다. 문서의 제목을 제공합니다.
updateTime

string (Timestamp format)

출력 전용입니다. 문서의 콘텐츠 또는 메타데이터가 마지막으로 업데이트된 타임스탬프를 나타냅니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. '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가 지정되지 않은 경우 각 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의 기본 보기입니다.

메서드

batchGet

 각각 전체 마크다운 콘텐츠가 포함된 여러 문서를 가져옵니다.

get

 전체 마크다운 콘텐츠가 포함된 단일 문서를 가져옵니다.

searchDocumentChunks

 Google의 개발자 문서에서 개발자 지식을 검색합니다.