Method: documents.create

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

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

HTTP リクエスト

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

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

リクエストの本文

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

JSON 表現 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
フィールド
documentId

string

出力専用。ドキュメントの ID。
title

string

ドキュメントのタイトル。
tabs[]

object (Tab)

ドキュメントの一部であるタブ。

タブには子タブ（別のタブ内にネストされたタブ）を含めることができます。子タブは Tab.childTabs フィールドで表されます。
revisionId

string

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

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

enum (SuggestionsViewMode)

出力専用。ドキュメントに適用されている候補ビューモード。

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

object (Body)

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

従来フィールド: 代わりに Document.tabs.documentTab.body を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.body はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
headers

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

出力専用。ドキュメント内のヘッダー（ヘッダー ID でキー設定）。

従来フィールド: 代わりに Document.tabs.documentTab.headers を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.headers はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
footers

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

出力専用。フッター ID をキーとするドキュメント内のフッター。

以前のフィールド: 代わりに Document.tabs.documentTab.footers を使用します。これにより、includeTabsContent パラメータが true に設定されている場合に、すべてのタブから実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
footnotes

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

出力専用。脚注 ID をキーとするドキュメント内の脚注。

従来フィールド: 代わりに Document.tabs.documentTab.footnotes を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.footnotes はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
documentStyle

object (DocumentStyle)

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

以前のフィールド: 代わりに Document.tabs.documentTab.documentStyle を使用します。これにより、includeTabsContent パラメータが true に設定されている場合に、すべてのタブから実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
suggestedDocumentStyleChanges

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

出力専用。ドキュメントのスタイルに対する提案された変更（提案 ID でキー設定）。

従来フィールド: 代わりに Document.tabs.documentTab.suggestedDocumentStyleChanges を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.suggestedDocumentStyleChanges はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
namedStyles

object (NamedStyles)

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

従来フィールド: 代わりに Document.tabs.documentTab.namedStyles を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.namedStyles はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
suggestedNamedStylesChanges

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

出力専用。ドキュメントの名前付きスタイルに対する推奨される変更（候補 ID でキーが付けられています）。

従来フィールド: 代わりに Document.tabs.documentTab.suggestedNamedStylesChanges を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.suggestedNamedStylesChanges はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
lists

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

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

以前のフィールド: 代わりに Document.tabs.documentTab.lists を使用します。これにより、includeTabsContent パラメータが true に設定されている場合に、すべてのタブから実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
namedRanges

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

出力専用。ドキュメント内の名前付き範囲（名前がキー）。

従来フィールド: 代わりに Document.tabs.documentTab.namedRanges を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.namedRanges はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
inlineObjects

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

出力専用。ドキュメント内のインライン オブジェクト（オブジェクト ID をキーとする）。

以前のフィールド: 代わりに Document.tabs.documentTab.inlineObjects を使用します。これにより、includeTabsContent パラメータが true に設定されている場合に、すべてのタブから実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
positionedObjects

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

出力専用。ドキュメント内の配置済みオブジェクト（オブジェクト ID をキーとする）。

従来フィールド: 代わりに Document.tabs.documentTab.positionedObjects を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.positionedObjects はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。

レスポンスの本文

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

認可スコープ

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

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

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