In diesem Dokument werden die ersten Schritte mit der Blogger JSON API beschrieben.
Inhalt
Einführung
Dieses Dokument richtet sich an Entwickler, die Anwendungen schreiben möchten, die mit der Blogger JSON API interagieren können.
Die Blogger JSON API erweitert Version 2.0 der Blogger Data API. Wenn Sie Blogger-Daten im JSON-Format anstatt 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, Funktionen zum Lesen und Schreiben sowie weitere Funktionen hinzuzufügen. Im Blogger-Hilfeforum können Sie weitere Funktionen anfordern.
Vorbereitung
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 einen versehentlichen Datenverlust zu vermeiden. Falls Sie bereits ein Testkonto haben, können Sie die Benutzeroberfläche von Blogger einrichten, um Ihre Testdaten einzurichten, zu bearbeiten oder aufzurufen.
Blogger kennenlernen
Wenn Sie mit Blogger-Konzepten nicht vertraut 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 der Anwendung
Wenn Ihre Anwendung private Daten anfordert, muss die Anfrage von einem authentifizierten Nutzer autorisiert werden, der Zugriff auf diese Daten hat.
Wenn Ihre Anwendung öffentliche Daten anfordert, 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 zur Verwendung des API unter Anfragen autorisieren und Ihre Anwendung identifizieren.
Blogger JSON API-Hintergrund
Blogger-Konzepte
Blogger beruht auf fünf grundlegenden Konzepten:
- Blogs: Das Stammkonzept der API. Ein Blog enthält Beiträge und Seiten. Dies ist der Container für Blog-Meta-Informationen wie den Blog-Namen und die Beschreibung.
- Beiträge: Ein Blogpost ist das Publikationselement, das der Blogpostersteller erstellt hat. Diese Informationen sollen rechtzeitig verfügbar sein und dem entsprechen, was die Autoren heute veröffentlichen möchten. Verständlicherweise werden Inhalte von Blogs mit der Zeit immer älter und sind weniger relevant.
- Kommentare: Ein Kommentar ist der Ort, an dem andere Personen als der Autor des Blogposts darauf reagieren. Alles von Ziegeln bis zu Blumensträußen.
- Seiten: Eine Seite ist ein Ort für statische Inhalte, z. B. biografische Informationen oder die Kontaktmöglichkeit des Nutzers. Dies sind in der Regel zeitlose Informationen, die sich nur selten ändern.
- Nutzer: Ein Nutzer ist eine Person, die mit Blogger interagiert, entweder als Autor, als Administrator oder als Leser. Bei öffentlichen Blogs sind Leser möglicherweise anonym, in privaten Blogs müssen sie jedoch von Blogger identifiziert werden.
Blogger JSON API-Datenmodell
Eine Ressource ist eine einzelne Datenentität mit einer eindeutigen Kennung. Die JSON-API von Blogger wird auf fünf Arten von Ressourcen ausgeführt:
- Blogs-Ressource: Steht für einen Blog.
- Posts-Ressource: Stellt einen Post dar. Jede Post-Ressource ist ein untergeordnetes Element einer Blog-Ressource.
- Kommentarressource: Steht für einen Kommentar zu einem bestimmten Beitrag. Jede Kommentarressource ist einer Beitragsressource untergeordnet.
- Seitenressource: Steht für eine statische Seite; jede Seitenressource ist eine untergeordnete Ressource einer Blogs-Ressource.
- Nutzerressource: Steht für einen nicht anonymen Nutzer Er wird verwendet, um den Autor einer Seite, eines Posts oder eines Kommentars zu identifizieren.
Das Blogger JSON API-Datenmodell basiert auf Ressourcengruppen, die als Sammlungen bezeichnet werden:
- Blogs
- Eine <span="apicollection">Blogs-Sammlung enthält alle Blogs, auf die ein Nutzer Zugriffsrechte hat. Du kannst Blogs nach Nutzern auflisten oder einen einzelnen Blog nach ID abrufen.</span="apicollection">
- Sammlung von Beiträgen
- Eine Sammlung von Beiträgen besteht aus allen Ressourcen für Beiträge innerhalb einer bestimmten Blogressource.
- Sammlung von Kommentaren
- Eine Sammlung von Kommentaren besteht aus allen Ressourcen für Kommentare innerhalb einer bestimmten Beiträge-Ressource.
- Seitensammlung
- Eine Seitensammlung besteht aus allen Seitenressourcen innerhalb einer bestimmten Blogressource.
- Nutzersammlung
- Eine Nutzersammlung besteht aus allen Nutzerressourcen auf Blogger und kann daher nicht aufgelistet werden. Ein Nutzer kann seine eigene Nutzerressource (jedoch keine andere) ü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.
| Aktion | Beschreibung | REST-HTTP-Zuordnungen |
|---|---|---|
| list | Listet alle Ressourcen in einer Sammlung auf. | GET für einen Sammlungs-URI. |
| Holen Sie sich | 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. Alle list- und get-Vorgänge in privaten Blogs erfordern eine Authentifizierung.
Ressourcentyp |
Unterstützte Methoden |
|
|---|---|---|
| Liste | erhalten | |
| 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:
- REST direkt oder über JavaScript verwenden (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.
Der Client gibt in den RESTful APIs von Google eine Aktion über ein HTTP-Verb wie POST, GET, PUT oder DELETE an. Sie gibt eine Ressource durch einen global eindeutigen URI in der folgenden Form an:
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.
Das spezifische Format für Blogger-JSON-API-URIs ist:
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
Die vollständige Beschreibung der verwendeten URIs und die Ergebnisse für jeden unterstützten Vorgang in der API finden Sie im Dokument Blogger-JSON-API-Referenz.
Im Folgenden finden Sie einige Beispiele dafür, 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
Rufen Sie die Posts im Blog code.blogger.com ab, in dem die Blog-ID 3213900 enthalten ist:
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 aus JavaScript aufrufen. Verwenden Sie dazu den Abfrageparameter callback und eine Callback-Funktion. So können Sie umfangreiche Anwendungen schreiben, die Blogger-Daten anzeigen, ohne serverseitigen Code zu schreiben.
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.