Prácticas recomendadas para obtener los mejores resultados

Hay varios principios que debes seguir cuando usas la API de Documentos de Google. Incluye las siguientes herramientas:

• Editar hacia atrás para aumentar la eficiencia
• Planifica la colaboración
• Garantiza la coherencia del estado con WriteControl

En las siguientes secciones, se explican estos principios.

Editar hacia atrás para aumentar la eficiencia

Dentro de una sola llamada al método BatchUpdate, ordena las solicitudes en orden descendente de ubicación del índice. Esto elimina la necesidad de calcular los cambios del índice debido a inserciones y eliminaciones.

Planifica la colaboración

Es posible que cambie el estado del documento. Entre una llamada de método y otra, otros colaboradores podrían actualizar el documento, como se muestra en el siguiente diagrama:

Esto puede generar errores si tus índices son incorrectos. Dado que varios usuarios editan un documento con la IU, Documentos de Google se encarga de esta tarea con transparencia. Sin embargo, como cliente de la API, tu app debe administrar esto. Incluso si no prevés una colaboración en el documento, es importante que programes de manera defensiva y te asegures de que el estado del documento se mantenga coherente. Para conocer una forma de garantizar la coherencia, revisa la sección WriteControl que se encuentra a continuación.

Garantiza la coherencia del estado con WriteControl

Cuando leas y actualices un documento, puedes asegurarte de que no se haya actualizado con el campo WriteControl del método BatchUpdate. Esto te permite editar el documento solo si la versión no cambió. Así es como se usa:

1. Obtén el documento y guarda la string revisionId incluida en él.
2. Redacta tus solicitudes de actualización.
3. Incluye un objeto WriteControl con el valor requiredRevisionId establecido en la string que guardaste.
4. Cuando llamas a BatchUpdate, si se modificó la revisión del documento, se muestra un error y no se realiza una actualización.