Method: documents.create

Cria um documento em branco usando o título fornecido na solicitação. Outros campos na solicitação, incluindo qualquer conteúdo fornecido, são ignorados.

Retorna o documento criado.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "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)
    },
    ...
  }
}
Campos
documentId

string

Apenas saída. O ID do documento.
title

string

O título do documento.
tabs[]

object (Tab)

Guias que fazem parte de um documento.

As guias podem conter guias filhas, uma guia aninhada em outra guia. As guias filhas são representadas pelo campo Tab.childTabs.
revisionId

string

Apenas saída. O ID da revisão do documento. Pode ser usado em solicitações de atualização para especificar a revisão de um documento a que as atualizações serão aplicadas e como a solicitação deve se comportar se o documento tiver sido editado desde essa revisão. Só será preenchido se o usuário tiver acesso de edição ao documento.

O ID da revisão não é um número sequencial, mas uma string opaca. O formato do ID da revisão pode mudar com o tempo. Um ID de revisão retornado só é válido por 24 horas após o retorno e não pode ser compartilhado entre usuários. Se o ID da revisão não for alterado entre as chamadas, o documento não terá sido alterado. Por outro lado, um ID alterado (para o mesmo documento e usuário) geralmente significa que o documento foi atualizado. No entanto, um ID alterado também pode ser devido a fatores internos, como mudanças no formato do ID.
suggestionsViewMode

enum (SuggestionsViewMode)

Apenas saída. O modo de visualização de sugestões aplicado ao documento.

Observação: ao editar um documento, as mudanças precisam ser baseadas em um documento com SUGGESTIONS_INLINE.
commentsViewMode

enum (CommentsViewMode)

Apenas saída. O modo de visualização de comentários aplicado ao documento.

comments[]

object (CommentThread)

Apenas saída. Os comentários associados ao documento. Só será preenchido se o parâmetro commentsViewMode estiver definido para exigir comentários (como COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

Apenas saída. As sugestões associadas ao documento. Só será preenchido se o parâmetro commentsViewMode estiver definido para exigir comentários (como COMMENTS_VIEW_MODE_INCLUDED).

body

object (Body)

Apenas saída. O corpo principal do documento.

Campo legado: em vez disso, use Document.tabs.documentTab.body, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
headers

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

Apenas saída. Os cabeçalhos no documento, com chave pelo ID do cabeçalho.

Campo legado: em vez disso, use Document.tabs.documentTab.headers, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
footers

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

Apenas saída. Os rodapés no documento, com chave pelo ID do rodapé.

Campo legado: em vez disso, use Document.tabs.documentTab.footers, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
footnotes

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

Apenas saída. As notas de rodapé no documento, com chave pelo ID da nota de rodapé.

Campo legado: em vez disso, use Document.tabs.documentTab.footnotes, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
documentStyle

object (DocumentStyle)

Apenas saída. O estilo do documento.

Campo legado: em vez disso, use Document.tabs.documentTab.documentStyle, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
suggestedDocumentStyleChanges

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

Apenas saída. As mudanças sugeridas no estilo do documento, com chave pelo ID da sugestão.

Campo legado: em vez disso, use Document.tabs.documentTab.suggestedDocumentStyleChanges, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
namedStyles

object (NamedStyles)

Apenas saída. Os estilos nomeados do documento.

Campo legado: em vez disso, use Document.tabs.documentTab.namedStyles, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
suggestedNamedStylesChanges

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

Apenas saída. As mudanças sugeridas nos estilos nomeados do documento, com chave pelo ID da sugestão.

Campo legado: em vez disso, use Document.tabs.documentTab.suggestedNamedStylesChanges, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
lists

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

Apenas saída. As listas no documento, com chave pelo ID da lista.

Campo legado: em vez disso, use Document.tabs.documentTab.lists, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
namedRanges

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

Apenas saída. Os intervalos nomeados no documento, com chave pelo nome.

Campo legado: em vez disso, use Document.tabs.documentTab.namedRanges, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
inlineObjects

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

Apenas saída. Os objetos inline no documento, com chave pelo ID do objeto.

Campo legado: em vez disso, use Document.tabs.documentTab.inlineObjects, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.
positionedObjects

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

Apenas saída. Os objetos posicionados no documento, com chave pelo ID do objeto.

Campo legado: em vez disso, use Document.tabs.documentTab.positionedObjects, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia do documento.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de Document.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o guia de autorização.