Wichtig: Die Unterstützung für die JSON API v2.0 wird am 30. September 2024 eingestellt. Aktualisieren Sie Ihre Anwendungen, die auf der JSON API v2.0 basieren, auf die neueste API-Version, damit sie weiterhin funktionieren. Die aktuelle Version findest du über die Links in der linken Navigationsleiste.
In diesem Dokument werden die ersten Schritte mit der Blogger JSON API beschrieben.
Inhalt
Einleitung
Dieses Dokument richtet sich an Entwickler, die Anwendungen schreiben möchten, die mit der Blogger JSON API interagieren können.
Die Blogger JSON API ist eine Erweiterung von 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 schreibgeschützt. Wir planen jedoch, Lese-/Schreibfunktionen sowie weitere Funktionen hinzuzufügen. Du kannst gerne andere Funktionen im Blogger-Hilfeforum anfordern.
Hinweis
Erstellen Sie sich ein Google-Konto
Sie müssen ein Google-Konto eingerichtet haben. Wir empfehlen, für Entwicklungs- und Testzwecke ein separates Google-Konto zu verwenden, um sich vor versehentlichen Datenverlusten zu schützen. Wenn Sie bereits ein Testkonto haben, sind Sie startklar. Rufen Sie die Blogger-Benutzeroberfläche auf, um Testdaten einzurichten, zu bearbeiten oder anzusehen.
Mit Blogger vertraut machen
Falls Ihnen die Konzepte von Blogger nicht bekannt sind, lesen Sie dieses Dokument und experimentieren Sie mit der Benutzeroberfläche, bevor Sie mit dem Programmieren beginnen. In diesem Dokument wird davon ausgegangen, dass Sie mit Blogger, mit Webprogrammierungskonzepten und mit 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 ö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 zum Verwenden von API-Schlüsseln finden Sie im Dokument „API verwenden“ unter Anfragen autorisieren und Ihre Anwendung identifizieren.
Hintergrund: Blogger JSON API
Blogger-Konzepte
Blogger basiert auf fünf grundlegenden Konzepten:
- Blogs: Das Grundkonzept der API Ein Blog besteht aus Beiträgen und Seiten. Dies ist der Container für Blog-Meta-Informationen wie Blogname und -beschreibung.
- Posts: Ein Blogpost ist das veröffentlichbare Element, das vom Blogautor erstellt wurde. Diese Informationen sollen aktuell sein und widerspiegeln, was die Autoren jetzt veröffentlichen möchten. Blogposts werden mit der Zeit immer älter und werden immer weniger relevant.
- Kommentare: Ein Kommentar ist die Stelle, an der andere Personen als der Verfasser des Blogposts auf den Verfasser des Beitrags reagieren. Alles von Ziegeln bis hin zu Blumensträußen.
- Seiten: Eine Seite ist ein Ort für statische Inhalte wie biografische Informationen oder Möglichkeiten, Nutzer zu kontaktieren. Dies sind in der Regel zeitlose Informationen, die sich nicht sehr oft ändern.
- Nutzer: Ein Nutzer ist jemand, der mit Blogger interagiert, egal ob er als Autor, Administrator oder nur als Leser auftritt. Bei öffentlichen Blogs sind Leser möglicherweise anonym, bei privaten Blogs müssen Leser jedoch von Blogger identifiziert werden.
Blogger JSON API-Datenmodell
Eine Ressource ist ein individuelles Datenobjekt mit einer eindeutigen ID. Die JSON API von Blogger unterstützt fünf Arten von Ressourcen:
- Blogressource: Steht für einen Blog.
- Posts-Ressource: Stellt einen Post dar. Jede Post-Ressource ist einer Blogs-Ressource untergeordnet.
- Kommentarressource: Stellt einen Kommentar zu einem bestimmten Beitrag dar. Jede Kommentarressource ist einer Beitragsressource untergeordnet.
- Seitenressource: Stellt eine statische Seite dar. Jede Ressource vom Typ „Seiten“ ist einer Blogs-Ressource untergeordnet.
- 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, die als Sammlungen bezeichnet werden:
- Blogs-Sammlung
- Eine <span="apicollection">Blogsammlung besteht aus allen Blogs, auf die ein Nutzer Zugriff hat. Sie können Blogs nach Nutzer auflisten oder einen einzelnen Blog nach ID abrufen.</span="apicollection">
- Sammlung „Posts“
- Eine Sammlung von Posts besteht aus allen Beitragsressourcen innerhalb einer bestimmten Blog-Ressource.
- Kommentarsammlung
- Eine Kommentarsammlung besteht aus allen Kommentarressourcen innerhalb einer bestimmten Ressource vom Typ "Posts".
- Sammlung „Pages“
- Eine Seitensammlung besteht aus allen Seitenressourcen innerhalb einer bestimmten Blogressource.
- Sammlung „Nutzer“
- Eine Nutzersammlung umfasst alle Nutzerressourcen auf Blogger und kann daher nicht aufgelistet werden. Ein Nutzer kann seine eigene Nutzerressource (aber keine Ressource) über die ID oder die Kennung
selfabrufen.
Blogger JSON API-Vorgänge
Sie können in der Blogger JSON API zwei verschiedene Methoden für Sammlungen und Ressourcen aufrufen, wie in der folgenden Tabelle beschrieben.
| Vorgang | Beschreibung | REST-HTTP-Zuordnungen |
|---|---|---|
| list | Listet alle Ressourcen in einer Sammlung auf. | Für einen Sammlungs-URI ist dies GET. |
| get | Ruft eine bestimmte Ressource ab. | GET für einen Ressourcen-URI. |
In der folgenden Tabelle sehen Sie, welche Methoden von den einzelnen Ressourcentypen unterstützt werden. Für alle list- und get-Vorgänge in privaten Blogs ist eine Authentifizierung erforderlich.
Ressourcentyp |
Unterstützte Methoden |
|
|---|---|---|
| Liste | ||
| 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:
- Verwendung von REST direkt 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.
REST steht für "Representational State Transfer". Im Kontext der Google APIs ist damit die Verwendung von HTTP-Verben gemeint, um Darstellungen von Daten, die bei Google gespeichert sind, abzufragen und zu bearbeiten.
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 den RESTful APIs von Google gibt der Client eine Aktion mit einem HTTP-Verb wie POST, GET, PUT oder DELETE an. Eine Ressource wird durch einen global eindeutigen URI in der folgenden Form angegeben:
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 lassen sich direkt den REST-HTTP-Verben zuordnen, wie unter Blogger JSON API-Vorgänge beschrieben.
Das spezifische Format für Blogger JSON API-URIs lautet:
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 Erläuterung der verwendeten URIs und der Ergebnisse für die einzelnen unterstützten Vorgänge in der API finden Sie im Referenzdokument zur Blogger JSON API.
Hier sind einige Beispiele, wie dies in der Blogger JSON API funktioniert.
Listen Sie die Blogs auf, für die der authentifizierte Nutzer Zugriffsrechte hat:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Laden Sie die Posts im Blog code.blogger.com mit der Blog-ID 3213900 herunter:
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST aus JavaScript
Sie können die Blogger JSON API über REST aus JavaScript aufrufen. Verwenden Sie dazu den Abfrageparameter callback und eine Callback-Funktion. Auf diese Weise können Sie umfangreiche Anwendungen schreiben, die Blogger-Daten anzeigen, ohne serverseitigen Code schreiben zu müssen.
Im folgenden Beispiel wird ein Post aus dem Blog code.blogger.com abgerufen, nachdem Sie YOUR-API-KEY durch Ihren API-Schlüssel ersetzt haben.
<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.