Method: documents.create

Crea un documento en blanco con el título proporcionado en la solicitud. Se ignoran los demás campos de la solicitud, incluido el contenido proporcionado.

Muestra el documento creado.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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

Solo salida. Es el ID del documento.

title

string

Es el título del documento.

body

object (Body)

Solo salida. Es el cuerpo principal del documento.

headers

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

Solo salida. Son los encabezados del documento, codificados por ID de encabezado.

footers

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

Solo salida. Son los pies de página del documento, codificados por el ID del pie de página.

footnotes

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

Solo salida. Son las notas al pie del documento, marcadas por un ID de nota al pie.

documentStyle

object (DocumentStyle)

Solo salida. Es el estilo del documento.

suggestedDocumentStyleChanges

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

Solo salida. Los cambios sugeridos en el estilo del documento, basados en el ID de sugerencia.

namedStyles

object (NamedStyles)

Solo salida. Los estilos con nombre del documento.

suggestedNamedStylesChanges

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

Solo salida. Los cambios sugeridos en los estilos con nombre del documento, con claves según el ID de sugerencia.

lists

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

Solo salida. Son las listas del documento, codificadas por ID de lista.

namedRanges

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

Solo salida. Los rangos con nombre en el documento, codificados por nombre.

revisionId

string

Solo salida. El ID de revisión del documento. Se puede usar en solicitudes de actualización para especificar a qué revisión de un documento se deben aplicar actualizaciones y cómo debe comportarse la solicitud si el documento se editó desde esa revisión. Solo se propaga si el usuario tiene acceso de edición al documento.

El ID de revisión no es un número secuencial, sino una string opaca. El formato del ID de revisión puede cambiar con el tiempo. El ID de revisión que se muestra solo puede ser válido por 24 horas después de que se muestra y no puede compartirse entre usuarios. Si el ID de revisión no se modifica entre llamadas, el documento no se modifica. Por el contrario, un ID modificado (para el mismo documento y el mismo usuario) suele significar que el documento se actualizó. Sin embargo, un ID modificado también puede deberse a factores internos, como cambios de formato de ID.

suggestionsViewMode

enum (SuggestionsViewMode)

Solo salida. El modo de vista de sugerencias aplicado al documento.

Nota: Cuando se edita un documento, los cambios deben basarse en un documento que tenga SUGGESTIONS_INLINE.

inlineObjects

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

Solo salida. Los objetos intercalados en el documento, codificados por ID de objeto.

positionedObjects

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

Solo salida. Los objetos posicionados en el documento, codificados por ID de objeto.

Cuerpo de la respuesta

Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de Document.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta la Guía de autorización.