Best Practices für optimale Ergebnisse

Bei der Verwendung der Google Docs API gibt es mehrere Prinzipien. Verfügbare Ausrichtungsmethoden:

  • Aus Effizienz hinten bearbeiten
  • Zusammenarbeit planen
  • Statuskonsistenz mit WriteControl gewährleisten

In den folgenden Abschnitten werden diese Prinzipien erläutert.

Aus Effizienz hinten bearbeiten

Sortieren Sie in einem einzigen Aufruf der Methode BatchUpdate Ihre Anfragen in absteigender Reihenfolge des Indexspeicherorts. Dadurch entfällt die Notwendigkeit, die Indexänderungen aufgrund von Einfügungen und Löschungen zu berechnen.

Zusammenarbeit planen

Es wird erwartet, dass sich der Status des Dokuments ändert. Zwischen den Methodenaufrufen können andere Mitbearbeiter das Dokument aktualisieren, wie im folgenden Diagramm dargestellt:

Wie ein Dokument zwischen Methodenaufrufen wechseln kann.

Dies kann zu Fehlern führen, wenn Ihre Indexe falsch sind. Da mehrere Nutzer ein Dokument über die Benutzeroberfläche bearbeiten, wird dies von Google Docs transparent bearbeitet. Als API-Client muss dies jedoch von Ihrer Anwendung verwaltet werden. Selbst wenn Sie die Zusammenarbeit am Dokument nicht erwarten, ist es wichtig, defensiv zu programmieren und dafür zu sorgen, dass der Dokumentstatus konsistent bleibt. Eine Möglichkeit, die Konsistenz zu gewährleisten, finden Sie im Abschnitt WriteControl unten.

Statuskonsistenz mit WriteControl gewährleisten

Wenn Sie ein Dokument lesen und dann aktualisieren, können Sie mit dem Feld WriteControl in der Methode BatchUpdate prüfen, ob das Dokument aktualisiert wurde. So können Sie das Dokument nur bearbeiten, wenn sich die Version nicht geändert hat. So verwenden Sie es:

  1. Rufen Sie das Dokument ab und speichern Sie den darin enthaltenen String revisionId.
  2. Verfassen Sie Ihre Aktualisierungsanfragen.
  3. Fügen Sie ein WriteControl-Objekt ein, bei dem die erforderliche Überarbeitungs-ID auf den gespeicherten String festgelegt ist.
  4. Wenn Sie BatchUpdate aufrufen und eine Änderung der Dokumentversion vorgenommen haben, wird ein Fehler zurückgegeben und keine Aktualisierung durchgeführt.