Wichtig: Die Unterstützung für die JSON API 2.0 wird am 30. September 2024 eingestellt. Damit Ihre Anwendungen weiterhin funktionieren, aktualisieren Sie sie auf die neueste API-Version. Die neueste Version finden Sie über die Links in der linken Navigationsleiste.
In diesem Dokument werden die ersten Schritte mit der Blogger JSON API erläutert.
Inhalt
Einführung
Dieses Dokument richtet sich an Entwickler, die Anwendungen erstellen möchten, die mit der Blogger JSON API interagieren können.
Die Blogger JSON API ist eine Erweiterung der Version 2.0 der Blogger Data API. Wenn Sie Daten aus Blogger im JSON-Format statt im XML-Format abrufen möchten, verwenden Sie die Blogger JSON API. Wenn Sie Daten im XML-Format abrufen möchten, verwenden Sie die Blogger Data API.
Diese Version der Blogger JSON API ist derzeit nur lesend. Wir planen jedoch, Lese-/Schreibfunktionen sowie weitere Funktionen hinzuzufügen. Im Blogger-Hilfeforum können Sie weitere Funktionen anfordern.
Vorbereitung
Erstellen Sie sich ein Google-Konto
Sie benötigen ein Google-Konto. Wir empfehlen, ein separates Google-Konto für Entwicklungs- und Testzwecke zu verwenden, um sich vor versehentlichen Datenverlusten zu schützen. Wenn Sie bereits ein Testkonto haben, können Sie die Blogger-Benutzeroberfläche aufrufen, um Ihre Testdaten einzurichten, zu bearbeiten oder anzusehen.
Blogger kennenlernen
Wenn Sie mit den Blogger-Konzepten nicht vertraut sind, lesen Sie dieses Dokument und experimentieren Sie mit der Benutzeroberfläche, bevor Sie mit dem Codieren beginnen. In diesem Dokument wird davon ausgegangen, dass Sie mit Blogger, Webprogrammierkonzepten und Webdatenformaten vertraut sind.
Informationen zum Autorisieren von Anfragen und Identifizieren Ihrer Anwendung
Wenn Ihre Anwendung private Daten anfordert, muss die Anfrage von einem authentifizierten Nutzer autorisiert werden, der Zugriff auf diese Daten hat.
Fordert Ihre Anwendung dagegen öffentliche Daten an, muss die Anfrage nicht autorisiert werden. Sie benötigt jedoch eine Kennung, z. B. einen API-Schlüssel.
Informationen zum Autorisieren von Anfragen und Verwenden von API-Schlüsseln finden Sie im Dokument „API verwenden“ unter Anfragen autorisieren und Anwendung identifizieren.
Hintergrundinformationen zur Blogger JSON API
Blogger-Konzepte
Blogger basiert auf fünf grundlegenden Konzepten:
- Blogs: Das Hauptkonzept der API. Ein Blog enthält Beiträge und Seiten. Dies ist der Container für Metadaten wie den Blognamen und die Beschreibung.
- Beiträge: Ein Blogpost ist das publizierbare Element, das der Blogautor erstellt hat. Diese Informationen sollen aktuell sein und widerspiegeln, was die Autoren der Welt jetzt mitteilen möchten. Es ist klar, dass Blogbeiträge mit der Zeit an Aktualität verlieren.
- Kommentare: Hier können Nutzer, die nicht der Autor des Blogposts sind, auf den Beitrag reagieren. Alles von Backsteinen bis zu Blumensträußen.
- Seiten: Eine Seite ist ein Ort für statische Inhalte wie biografische Informationen oder Möglichkeiten, den Nutzer zu kontaktieren. Das sind in der Regel zeitlose Informationen, die sich nicht sehr oft ändern.
- Nutzer: Ein Nutzer ist eine Person, die mit Blogger interagiert, sei es als Autor, Administrator oder nur als Leser. Bei öffentlichen Blogs können Leser anonym sein, bei privaten Blogs muss ein Leser von Blogger identifiziert werden.
Blogger JSON API-Datenmodell
Eine Ressource ist ein individuelles Datenobjekt mit einer eindeutigen ID. Die Blogger JSON API unterstützt fünf Arten von Ressourcen:
- Blogs-Ressource: Stellt einen Blog dar.
- Posts-Ressource: Stellt einen Beitrag dar. Jede Posts-Ressource ist ein untergeordnetes Element einer Blogs-Ressource.
- Kommentarressource: Stellt einen Kommentar zu einem bestimmten Beitrag dar. Jede Kommentarressource ist eine untergeordnete Ressource einer Beitragsressource.
- Seitenressource: Stellt eine statische Seite dar. Jede Seitenressource ist eine untergeordnete Ressource einer Blogressource.
- Nutzerressource: Stellt einen nicht anonymen Nutzer dar. Damit wird der Autor einer Seite, eines Beitrags oder eines Kommentars identifiziert.
Das Datenmodell der Blogger JSON API basiert auf Ressourcengruppen, sogenannten Sammlungen:
- Blogs-Sammlung
- Eine <span="apicollection">Blogs-Sammlung besteht aus allen Blogs, auf die ein Nutzer Zugriffsrechte hat. Du kannst Blogs nach Nutzer auflisten oder einen einzelnen Blog anhand der ID abrufen.</span="apicollection">
- Sammlung „Beiträge“
- Eine Beitragssammlung besteht aus allen Beitragsressourcen in einer bestimmten Blogressource.
- Kommentare-Sammlung
- Eine Kommentaresammlung besteht aus allen Kommentare-Ressourcen innerhalb einer bestimmten Posts-Ressource.
- Seitensammlung
- Eine Seitensammlung besteht aus allen Seitenressourcen in einer bestimmten Blogressource.
- Nutzersammlung
- Eine Nutzersammlung besteht aus allen Nutzerressourcen auf Blogger und kann daher nicht aufgeführt werden. Ein Nutzer kann seine eigene Nutzerressource (aber keine andere) anhand der ID oder mithilfe der Kennung
selfabrufen.
Blogger JSON API-Vorgänge
In der Blogger JSON API können Sie zwei verschiedene Methoden für Sammlungen und Ressourcen aufrufen, wie in der folgenden Tabelle beschrieben.
| Vorgang | Beschreibung | REST-HTTP-Zuordnungen |
|---|---|---|
| list | Hier werden alle Ressourcen in einer Sammlung aufgelistet. | GET für einen Sammlungs-URI. |
| get | Ruft eine bestimmte Ressource ab. | GET für einen Ressourcen-URI. |
In der folgenden Tabelle sehen Sie, welche Methoden für die einzelnen Ressourcentypen unterstützt werden. Für alle list- und get-Vorgänge auf privaten Blogs ist eine Authentifizierung erforderlich.
Ressourcentyp |
Unterstützte Methoden |
|
|---|---|---|
| list | get | |
| Blogs | Ja | Ja |
| Beiträge | Ja | Ja |
| Kommentare | Ja | Ja |
| Seiten | Ja | Ja |
| Nutzer | Nein | Ja |
Anrufstile
Es gibt mehrere Möglichkeiten, die API aufzurufen:
- Direkte Verwendung von REST oder über JavaScript (kein serverseitiger Code erforderlich)
- Clientbibliotheken verwenden
REST
REST ist eine Art Softwarearchitektur, die einen bequemen und einheitlichen Ansatz zur Abfrage und Bearbeitung von Daten bietet.
Der Begriff REST steht für Representational State Transfer. Im Zusammenhang mit Google-APIs bezieht es sich auf die Verwendung von HTTP-Verben zum Abrufen und Ändern von Darstellungen von Daten, die von Google gespeichert sind.
In einem als "RESTful" bezeichneten System werden Ressourcen in einem Datenspeicher abgelegt; ein Client sendet eine Aufforderung, der Server möge eine bestimmte Aktion ausführen (z. B. eine Ressource erstellen, abfragen, aktualisieren oder löschen), und der Server führt die Aktion aus und sendet eine Antwort, oft in Form einer Darstellung der angegebenen Ressource.
In Googles RESTful APIs spezifiziert der Client eine Aktion mit einem HTTP-Verb wie POST, GET, PUT oder DELETE. Eine Ressource wird anhand eines weltweit eindeutigen URIs im folgenden Format spezifiziert:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Weil alle API-Ressourcen eindeutige, über HTTP zugängliche URIs haben, ermöglicht REST das Caching von Daten und ist optimal geeignet, mit der verteilten Infrastruktur des Webs zu arbeiten.
Dafür können die Methodendefinitionen in der Dokumentation der HTTP 1.1-Standards hilfreich sein. Hier finden Sie auch die Spezifikationen für GET, POST, PUT und DELETE.
REST in der Blogger JSON API
Die unterstützten Blogger-Vorgänge sind REST-HTTP-Verben direkt zugeordnet, wie unter Blogger JSON API-Vorgänge beschrieben.
Für Blogger JSON API-URIs gelten folgende spezielle Formate:
https://www.googleapis.com/blogger/v2/users/userId https://www.googleapis.com/blogger/v2/users/self https://www.googleapis.com/blogger/v2/users/userId/blogs https://www.googleapis.com/blogger/v2/users/self/blogs https://www.googleapis.com/blogger/v2/blogs/blogId/posts https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v2/blogs/blogId/pages https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId
Eine vollständige Erklärung der verwendeten URIs und der Ergebnisse für jeden unterstützten Vorgang in der API finden Sie im Referenzdokument zur Blogger JSON API.
Hier sind einige Beispiele dafür, wie das in der Blogger JSON API funktioniert.
Liste die Blogs auf, auf die der authentifizierte Nutzer Zugriffsrechte hat:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
So rufen Sie die Beiträge im Blog code.blogger.com (Blog-ID 3213900) ab:
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST aus JavaScript
Sie können die Blogger JSON API mit REST über JavaScript aufrufen, indem Sie den Abfrageparameter callback und eine Callback-Funktion verwenden. So können Sie umfangreiche Anwendungen erstellen, die Blogger-Daten anzeigen, ohne serverseitigen Code schreiben zu müssen.
Im folgenden Beispiel wird ein Beitrag aus dem Blog code.blogger.com abgerufen, nachdem YOUR-API-KEY durch Ihren API-Schlüssel ersetzt wurde.
<html>
<head>
<title>Blogger JSON API Example</title>
</head>
<body>
<div id="content"></div>
<script>
function handleResponse(response) {
document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
}
</script>
<script
src="https://www.googleapis.com/blogger/v2/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY "></script>
</body>
</html>Datenformat
JSON
JSON (JavaScript Object Notation) ist ein gängiges sprachunabhängiges Datenformat, das eine einfache Textdarstellung beliebiger Datenstrukturen bietet. Weitere Informationen finden Sie unter json.org.