Dieses Dokument enthält eine detaillierte Referenzdokumentation für das Rohprotokoll (XML und HTTP) für das Google Sites Data API.
Dieses Dokument enthält keine Informationen zu den Clientbibliotheken für Programmiersprachen. Referenzinformationen zu Clientbibliotheken finden Sie unter den Links in den Abschnitten zu den Programmiersprachen im Entwicklerhandbuch.
Zielgruppe
Dieses Dokument richtet sich an Programmierer, die Client-Anwendungen schreiben möchten, die mit Google Sites interagieren können.
Es ist ein Referenzdokument. Es wird davon ausgegangen, dass Sie die im Protokollleitfaden vorgestellten Konzepte und die allgemeinen Konzepte hinter dem Google Data APIs-Protokoll verstehen.
Google Sites-Feedtypen
Das Google Sites Data API stellt die folgenden Feedtypen bereit:
Aktivitätsfeed
Der Aktivitätsfeed ist ein Feed mit Beschreibungen aller Aktivitäten auf einer Website.
Der GET
-URI dieses Feeds für eine Website innerhalb einer bestimmten Domain lautet:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName ist entweder „Website“ oder eine G Suite-Domain.
siteName ist der Name der Website, wie er in der Landingpage-URL der Website erscheint: http://sites.google.com/a/domainName/siteName/.
Alle Anfragen an diesen Feed müssen authentifiziert werden.
Unterstützte Anfragetypen: GET
Inhaltsfeed
Der Content-Feed ist ein Feed, der den aktuellen, bearbeitbaren Website-Content enthält.
Der GET
-URI dieses Feeds für eine Website innerhalb einer bestimmten Domain lautet:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName ist entweder „Website“ oder eine G Suite-Domain.
siteName ist der Name der Website, wie er in der Landingpage-URL der Website erscheint: http://sites.google.com/a/domainName/siteName.
Für Anfragen an diesen Feed ist möglicherweise eine Authentifizierung erforderlich. Dies ist abhängig von den (veröffentlichten) Einstellungen der Website.
Unterstützte Anfragetypen: GET
, POST
, PUT
, DELETE
Neben den Standardabfrageparametern für die Data API ermöglicht das Sites Data API die folgenden optionalen Parameter:
GET
-Anfrage über den Content-Feed:
Parameter | Beschreibung | Typ | Hinweise |
---|---|---|---|
ancestor |
Fordert nur Einträge mit dem angegebenen Ancestor an. | String | Geben Sie die ID des gewünschten Ancestor-Eintrags an. Beispiel: 0123456789 . Gibt alle Einträge zurück, die den angegebenen Ancestor als übergeordnetes Element, das übergeordnete Element eines übergeordneten Elements usw. haben. |
include-deleted |
Gibt an, ob gelöschte Einträge berücksichtigt werden sollen. | boolean | Mögliche Werte sind true und false . Der Standardwert ist false . |
include-draft |
Gibt an, ob Entwurfseinträge einbezogen werden. | boolean | Mögliche Werte sind true und false . Der Standardwert ist false . Du musst der Eigentümer oder Autor sein
des Entwurfs, um ihn anzuzeigen. |
kind |
Gibt die Art(en) der Inhaltseinträge an, die zurückgegeben werden sollen. Sie richten sich nach dem Seitentyp in Google Sites. | Durch Kommas getrennte Liste von Strings | Mögliche Werte sind announcement , announcementspage , attachment ,
comment , filecabinet , listitem , listpage , webpage , webattachment ,
template |
parent |
Fordert nur Einträge mit dem angegebenen übergeordneten Element an. | String | Geben Sie die ID des übergeordneten Eintrags an. Beispiel: 0123456789 . |
path |
Fordert Inhalte unter einer bestimmten Seitenhierarchie an | String | Der Pfad zu einer Unterseite innerhalb einer Website, für die Inhalte abgerufen werden sollen. Beispiel: path=/path/to/page . |
Überarbeitungsfeed
Der Überarbeitungsfeed ist ein Feed, der frühere Versionen des Websitecontents enthält.
Der GET
-URI dieses Feeds für eine Website innerhalb einer bestimmten Domain lautet:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName ist entweder „Website“ oder eine G Suite-Domain.
siteName ist der Name der Website, wie er in der Landingpage-URL der Website erscheint: http://sites.google.com/a/domainName/siteName.
Alle Anfragen an diesen Feed müssen authentifiziert werden.
Unterstützte Anfragetypen: GET
Website-Feed
Mit dem Website-Feed können die Google Sites-Websites aufgelistet werden, die einem Nutzer gehören oder für die er Leseberechtigungen hat. Es kann auch sein, zum Erstellen neuer Websites, Kopieren von Websites oder Ändern des Namens einer vorhandenen Website verwendet wird.
Der Feed-URI für den Websites-Eintrag lautet:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName ist entweder „Website“ oder eine G Suite-Domain.
Alle Anfragen an diesen Feed müssen authentifiziert werden.
Unterstützte Anfragetypen: GET
, POST
, PUT
Der Website-Feed unterstützt die folgenden (optionalen) Parameter bei einer GET
-Anfrage zum Auflisten von Websites:
Parameter | Beschreibung | Typ | Hinweise |
---|---|---|---|
include-all-sites |
Listen Sie alle Websites auf, die von einem Nutzer in der G Suite-Domain zumindest angesehen werden können. | boolean | Dieser Parameter gilt nur, wenn Websites für eine G Suite-Domain aufgelistet werden. Mögliche Werte sind true
oder false . Der Standardwert ist false . |
with-mappings |
Umfasst die Webadressen-Zuordnungen in einem Website-Eintrag. | boolean | Mögliche Werte sind true und false . Der Standardwert ist false . |
ACL-Feed
Der ACL-Feed kann verwendet werden, um die Freigabeberechtigungen (ACLs) einer Google Sites-Website aufzulisten und/oder zu ändern.
Der Feed-URI für den Websites-Eintrag lautet:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName ist entweder „Website“ oder eine G Suite-Domain.
Alle Anfragen an diesen Feed müssen authentifiziert werden.
Unterstützte Anfragetypen: GET
, POST
, PUT
, DELETE
Referenz zu Google Sites-Suchparametern
Unterstützte Abfrageparameter des Google Data API-Protokolls:
max-results
published-max
(nur Content-Feed)published-min
(nur Content-Feed)start-index
updated-max
updated-min
q
(vollständige Textabfragen)
Die Parameter für den jeweiligen Feed sind oben in den einzelnen Feeds aufgeführt.