Best Practices für optimale Ergebnisse

Bei der Verwendung der Google Docs API gibt es einige Grundsätze, die Sie befolgen sollten. Dazu gehören:

  • Für mehr Effizienz rückwärts bearbeiten
  • Zusammenarbeit planen
  • Mit dem WriteControl Feld
  • Tabs berücksichtigen

In den folgenden Abschnitten werden diese Prinzipien erläutert.

Für mehr Effizienz rückwärts bearbeiten

Mit einem Aufruf des documents.batchUpdate ordnen Sie Ihre Anfragen in absteigende Reihenfolge des Indexstandorts. Dadurch entfällt die Notwendigkeit, Indexänderungen aufgrund von Einfügungen und Löschungen.

Zusammenarbeit planen

Es ist davon auszugehen, dass sich der Dokumentstatus ändert. Zwischen einem Methodenaufruf und einem anderen Mitbearbeiter können das Dokument aktualisieren, wie im folgenden Diagramm dargestellt:

Gibt an, wie sich ein Dokument zwischen Methodenaufrufen ändern kann.

Dies kann zu Fehlern führen, wenn Ihre Indexe falsch sind. Wenn mehrere Nutzende eine der Benutzeroberfläche verwendet, erledigt Google Docs dies transparent. Sie können jedoch muss Ihre Anwendung dies verwalten. Auch wenn Sie nicht im Voraus am Dokument arbeiten, ist eine defensive Programmgestaltung und dass der Dokumentstatus einheitlich bleibt. Um Einheitlichkeit zu gewährleisten, Sehen Sie sich den Abschnitt WriteControl an.

Zustandskonsistenz mit WriteControl herstellen

Wenn Sie ein Dokument lesen und dann aktualisieren, können Sie konkurrierende Änderungen mithilfe des WriteControl in der Methode documents.batchUpdate. WriteControl bietet Befugnis wie Schreibanfragen ausgeführt werden.

So verwenden Sie diese Funktion:

  1. Rufen Sie das Dokument mit der documents.get-Methode und speichern Sie die revisionId aus der zurückgegebenen documents-Ressource.
  2. Verfassen Sie Ihre Aktualisierungsanfragen.
  3. Fügen Sie ein optionales WriteControl-Element hinzu. mit einer von zwei Optionen:
    1. Das Feld requiredRevisionId ist auf die revisionId des Dokument, auf das die Schreibanfrage angewendet wird. Wenn das Dokument geändert wurde da die API-Leseanfrage die Schreibanfrage nicht verarbeitet, gibt einen Fehler zurück.
    2. Das Feld targetRevisionId ist auf die revisionId des Dokuments festgelegt. auf die die Schreibanfrage angewendet wird. Wenn das Dokument seit dem API-Leseanfrage werden die Änderungen der Schreibanfrage auf die Änderungen von Mitbearbeitern. Das Ergebnis der Schreibanfrage ändert sich die Schreibanfrage und der Mitbearbeiter wechselt zu einem neuen Überarbeitung des Dokuments. Der Google Docs-Server zum Zusammenführen der Inhalte.

Ein Beispiel für das Erstellen einer Batchanfrage mit WriteControl finden Sie unter dieses Beispiel für eine Batchanfrage.

Tabs berücksichtigen

Ein einzelnes Dokument kann mehrere Tabs enthalten, die spezifische Verarbeitung in Ihren API-Anfragen erfordern.

Folgendes solltest du beachten:

  1. Setzen Sie den Parameter includeTabsContent auf true im documents.get-Methode, um den Inhalt aller Tabs in einem Dokument abzurufen. Standardmäßig werden nicht alle Tabs werden zurückgegeben.
  2. Geben Sie die IDs der Tabs an, auf die jeweils Request angewendet werden soll in: documents.batchUpdate . Jedes Request bietet eine Möglichkeit, die Tabs anzugeben, auf die das Update angewendet werden soll. Wenn ein keine Angabe enthält, wird der Request auf den ersten Tab im Dokument angewendet. Weitere Informationen finden Sie in der Requests in der Dokumentation.