Hay varios principios que debes seguir cuando usas la API de Documentos de Google. Incluye las siguientes herramientas:
- Retroceder para aumentar la eficiencia
- Cómo planificar la colaboración
- Garantiza la coherencia del estado con
WriteControl
En las siguientes secciones, se explican estos principios.
Retroceder para aumentar la eficiencia
Dentro de una sola llamada al método BatchUpdate, ordena tus solicitudes en orden descendente según la ubicación del índice. Esto elimina la necesidad de calcular los cambios de índice debido a las inserciones y eliminaciones.
Cómo planificar la colaboración
El estado del documento debería cambiar. Entre una llamada de método y otra, es posible que otros colaboradores actualicen el documento, como se muestra en el siguiente diagrama:
Esto puede generar errores si tus índices son incorrectos. Si varios usuarios editan un documento con la IU, Documentos de Google se encarga de esta tarea con transparencia, pero, como cliente de la API, tu app debe administrar esto. Incluso si no esperas una colaboración en el documento, es importante programar defensivamente y asegurarte de que el estado del documento sea coherente. Para garantizar la coherencia, revisa la sección WriteControl que aparece a continuación.
Garantiza la coherencia del estado con WriteControl
Cuando lees y actualizas un documento, puedes asegurarte de que no se actualizó mediante el campo WriteControl en el método BatchUpdate. Esto te permite editar el documento solo si la versión no cambió. A continuación, te indicamos cómo usarlo:
- Obtén el documento y guarda la string
revisionIdque se incluye. - Redacta tus solicitudes de actualización.
- Incluye un objeto
WriteControlcon el obligatorio RevisionId configurado en la string que guardaste. - Cuando llamas a
BatchUpdate, si cambió la revisión del documento, se muestra un error y no se realiza una actualización.