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,
  "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)
    },
    ...
  }
}
Campos
documentId

string

Apenas saída. O ID do documento.

title

string

O título do documento.

body

object (Body)

Apenas saída. O corpo principal do documento.

headers

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

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

footers

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

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

footnotes

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

Apenas saída. As notas de rodapé no documento, codificadas pelo código da nota de rodapé.

documentStyle

object (DocumentStyle)

Apenas saída. O estilo do documento.

suggestedDocumentStyleChanges

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

Apenas saída. As alterações sugeridas para o estilo do documento, codificadas pelo código da sugestão.

namedStyles

object (NamedStyles)

Apenas saída. Os estilos nomeados do documento.

suggestedNamedStylesChanges

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

Apenas saída. As alterações sugeridas para os estilos nomeados do documento, codificadas pelo ID da sugestão.

lists

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

Apenas saída. As listas no documento, codificadas pelo código da lista.

namedRanges

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

Apenas saída. Os intervalos nomeados no documento, codificados por nome.

revisionId

string

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

O código de revisão não é um número sequencial, mas uma string opaca. O formato do ID de revisão pode mudar ao longo do tempo. Um código de revisão retornado só é válido por 24 horas depois de ser retornado e não pode ser compartilhado entre usuários. Se o ID de revisão não for alterado entre as chamadas, o documento não foi alterado. Por outro lado, um ID alterado (para o mesmo documento e usuário) normalmente significa que o documento foi atualizado. No entanto, um ID alterado também pode ser causado por fatores internos, como alterações 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 alterações precisam ser baseadas em um documento com SUGGESTIONS_INLINE.

inlineObjects

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

Apenas saída. Os objetos in-line no documento, codificados pelo ID do objeto.

positionedObjects

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

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

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 de 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.