Method: documents.create

Crea un documento en blanco con el título que se proporciona en la solicitud. Se ignoran 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 de 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),
  "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

Solo salida. Es el ID del documento.
title

string

Es el título del documento.
tabs[]

object (Tab)

Son las pestañas que forman parte de un documento.

Las pestañas pueden contener pestañas secundarias, es decir, una pestaña anidada dentro de otra. 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 usar en solicitudes de actualización para especificar qué revisión de un documento se debe actualizar y cómo se debe comportar 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 cadena opaca. El formato del ID de revisión puede cambiar con el tiempo. Se garantiza que un ID de revisión devuelto solo es válido durante 24 horas después de que se devolvió y no se puede compartir entre usuarios. Si el ID de revisión no cambia entre las llamadas, significa que el documento no se modificó. Por el contrario, un ID cambiado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un cambio de ID también puede deberse a factores internos, como cambios 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.
commentsViewMode

enum (CommentsViewMode)

Solo salida. Es el modo de vista de comentarios aplicado al documento.

comments[]

object (CommentThread)

Solo salida. Son los comentarios asociados al documento. Solo se propaga si el parámetro commentsViewMode está configurado para requerir comentarios (como COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

Solo salida. Son las sugerencias asociadas al documento. Solo se propaga si el parámetro commentsViewMode está configurado para requerir comentarios (como COMMENTS_VIEW_MODE_INCLUDED).

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 está configurado, este campo contiene información sobre la primera pestaña del documento.
headers

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

Solo salida. Encabezados del documento, con la clave del ID del encabezado.

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 está configurado, este campo contiene información sobre la primera pestaña del documento.
footers

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

Solo salida. Son los pies de página del documento, con el ID del pie de página como clave.

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 está configurado, este campo contiene información sobre la primera pestaña del documento.
footnotes

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

Solo salida. Son las notas al pie del documento, con el ID de la nota al pie como clave.

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 está configurado, 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 está configurado, este campo contiene información sobre la primera pestaña del documento.
suggestedDocumentStyleChanges

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

Solo salida. Son los cambios sugeridos en el estilo del documento, con la clave del 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 está configurado, 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 está configurado, este campo contiene información sobre la primera pestaña del documento.
suggestedNamedStylesChanges

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

Solo salida. Son los cambios sugeridos en los estilos con nombre del documento, organizados 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 está configurado, este campo contiene información sobre la primera pestaña del documento.
lists

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

Solo salida. Son las listas del documento, con el ID de la 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 está configurado, este campo contiene información sobre la primera pestaña del documento.
namedRanges

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

Solo salida. Son los rangos con nombre del documento, con el nombre como clave.

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 está configurado, este campo contiene información sobre la primera pestaña del documento.
inlineObjects

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

Solo salida. Son los objetos intercalados en el documento, con el ID del objeto como clave.

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 está configurado, este campo contiene información sobre la primera pestaña del documento.
positionedObjects

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

Solo salida. Son los objetos posicionados en el documento, con el ID del objeto como clave.

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 está configurado, 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.