Method: documents.create

Crea un documento en blanco con el título proporcionado en la solicitud. Se ignorarán otros campos de la solicitud, incluido el contenido proporcionado.

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

string

Solo salida. Es el ID del documento.
title

string

Es el título del documento.
tabs[]

object (Tab)

Pestañas que forman parte de un documento.

Las pestañas pueden contener pestañas secundarias, una pestaña anidada dentro de otra pestaña. Las pestañas secundarias se representan con el campo Tab.childTabs.
revisionId

string

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

El ID de revisión no es un número secuencial, sino una cadena opaca. El formato del ID de revisión puede cambiar con el tiempo. Si se muestra un ID de revisión, solo se garantiza su validez durante 24 horas, y no se puede compartir con los usuarios. Si el ID de revisión no se cambia entre llamadas, el documento no cambió. En cambio, un ID modificado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un ID modificado también puede deberse a factores internos, como modificaciones en el formato del ID.
suggestionsViewMode

enum (SuggestionsViewMode)

Solo salida. Es el modo de vista de sugerencias que se aplica al documento.

Nota: Cuando edites un documento, los cambios deben basarse en un documento con SUGGESTIONS_INLINE.
body

object (Body)

Solo salida. Es el cuerpo principal del documento.

Campo heredado: En su lugar, usa Document.tabs.documentTab.body, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
headers

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

Solo salida. Los encabezados del documento, con el ID de encabezado de clave.

Campo heredado: En su lugar, usa Document.tabs.documentTab.headers, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
footers

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

Solo salida. Los pies de página del documento, escritos por ID de pie de página

Campo heredado: En su lugar, usa Document.tabs.documentTab.footers, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
footnotes

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

Solo salida. Las notas al pie del documento, escritas por el ID de la nota al pie

Campo heredado: En su lugar, usa Document.tabs.documentTab.footnotes, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
documentStyle

object (DocumentStyle)

Solo salida. Es el estilo del documento.

Campo heredado: En su lugar, usa Document.tabs.documentTab.documentStyle, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
suggestedDocumentStyleChanges

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

Solo salida. Los cambios sugeridos para el estilo del documento, codificados por ID de sugerencia.

Campo heredado: En su lugar, usa Document.tabs.documentTab.suggestedDocumentStyleChanges, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
namedStyles

object (NamedStyles)

Solo salida. Son los estilos con nombre del documento.

Campo heredado: En su lugar, usa Document.tabs.documentTab.namedStyles, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
suggestedNamedStylesChanges

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

Solo salida. Los cambios sugeridos para los estilos con nombre del documento, vinculados por ID de sugerencia.

Campo heredado: En su lugar, usa Document.tabs.documentTab.suggestedNamedStylesChanges, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
lists

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

Solo salida. Las listas del documento, con el ID de lista como clave.

Campo heredado: En su lugar, usa Document.tabs.documentTab.lists, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
namedRanges

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

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

Campo heredado: En su lugar, usa Document.tabs.documentTab.namedRanges, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
inlineObjects

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

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

Campo heredado: En su lugar, usa Document.tabs.documentTab.inlineObjects, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.
positionedObjects

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

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

Campo heredado: En su lugar, usa Document.tabs.documentTab.positionedObjects, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no la estableces, este campo contiene información sobre la primera pestaña del documento.

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