Method: documents.create

リクエストで指定されたタイトルを使用して空白のドキュメントを作成します。リクエストの他のフィールド(提供されたコンテンツなど)は無視されます。

作成されたドキュメントを返します。

HTTP リクエスト

POST https://docs.googleapis.com/v1/documents

この URL では gRPC Transcoding 構文を使用します。

リクエスト本文

リクエストの本文には次の構造のデータが含まれます。

JSON 表現
{
  "documentId": string,
  "title": string,
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
フィールド
documentId

string

出力のみ。ドキュメントの ID。

title

string

ドキュメントのタイトル。

body

object (Body)

出力のみ。ドキュメントの本文。

headers

map (key: string, value: object (Header))

出力のみ。ヘッダー ID をキーとするドキュメントのヘッダー。

footers

map (key: string, value: object (Footer))

出力のみ。フッター ID をキーとしたドキュメントのフッター。

footnotes

map (key: string, value: object (Footnote))

出力のみ。脚注 ID をキーとしたドキュメントの脚注。

documentStyle

object (DocumentStyle)

出力のみ。ドキュメントのスタイル。

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

出力のみ。候補の ID をキーとしたドキュメントのスタイルの変更。

namedStyles

object (NamedStyles)

出力のみ。ドキュメントの名前付きスタイル。

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

出力のみ。提案 ID をキーとするドキュメントの名前付きスタイルの変更候補。

lists

map (key: string, value: object (List))

出力のみ。リスト ID をキーとするドキュメントのリスト。

namedRanges

map (key: string, value: object (NamedRanges))

出力のみ。ドキュメント内の名前付き範囲。名前でキー付けされます。

revisionId

string

出力のみ。ドキュメントのリビジョン ID。更新リクエストで使用できます。更新リクエストでは、更新を適用するドキュメントのバージョンと、ドキュメントがそのリビジョン以降に編集されている場合にリクエストがどのように動作するかを指定できます。ユーザーがドキュメントの編集権限を持っている場合にのみ入力されます。

リビジョン ID は連番ではなく、不透明な文字列です。リビジョン ID の形式は今後変更される可能性があります。返されたリビジョン ID は、返却されてから 24 時間のみ有効であることが保証され、ユーザー間で共有することはできません。呼び出し間でリビジョン ID が変更されていない場合、ドキュメントは変更されていません。反対に、同じドキュメントとユーザーの ID が変更された場合は、通常、ドキュメントが更新されています。ただし、ID の形式の変更などの内部的な要因により、ID が変更される場合もあります。

suggestionsViewMode

enum (SuggestionsViewMode)

出力のみ。候補の表示モードがドキュメントに適用されました。

注: ドキュメントを編集する場合、変更は SUGGESTIONS_INLINE を含むドキュメントに基づいて行う必要があります。

inlineObjects

map (key: string, value: object (InlineObject))

出力のみ。オブジェクト ID をキーとするドキュメントのインライン オブジェクト。

positionedObjects

map (key: string, value: object (PositionedObject))

出力のみ。オブジェクト ID をキーとした、ドキュメント内の配置されたオブジェクト。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Document のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

詳しくは、認可ガイドをご覧ください。