Blogger API: Erste Schritte

In diesem Dokument wird beschrieben, wie Sie die Blogger API verwenden.

Vorbereitung

Einrichten eines Google-Kontos

Prüfen Sie, ob Sie ein Google-Konto eingerichtet haben. Wir empfehlen, für Entwicklungs- und Testzwecke ein separates Google-Konto zu verwenden, um sich vor versehentlichem Datenverlust 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 probieren Sie die Benutzeroberfläche aus, bevor Sie mit dem Programmieren 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 zur Verwendung von API-Schlüsseln finden Sie im Dokument „API verwenden“ unter Anfragen autorisieren und Anwendung identifizieren.

Hintergrundinformationen zur Blogger API

Blogger-Konzepte

Blogger basiert auf fünf grundlegenden Konzepten:

• Blogs: Das grundlegende Konzept der API. Ein Blog besteht aus Beiträgen und Seiten. Dies ist der Container für Blog-Metainformationen wie Blogname und Beschreibung.
• Beiträge: Ein Blogbeitrag ist das vom Blogautor erstellte Element, das veröffentlicht werden kann. Diese Informationen sollen aktuell sein und widerspiegeln, was die Autoren jetzt veröffentlichen möchten. Im Laufe der Zeit werden Blogbeiträge älter und weniger relevant.
• Kommentare: In einem Kommentar können andere Nutzer als der Autor des Blogbeitrags auf das reagieren, was der Autor geschrieben hat. Alles von Ziegeln bis hin zu Blumensträußen.
• Seiten: Eine Seite ist ein Ort für statische Inhalte wie biografische Informationen oder Kontaktmöglichkeiten. Dabei handelt es sich in der Regel um zeitlose Informationen, die sich nicht sehr oft ändern.
• Nutzer: Ein Nutzer ist jemand, der mit Blogger interagiert, sei es als Autor, Administrator oder Leser. Bei öffentlichen Blogs können Leser anonym sein. Bei privaten Blogs muss ein Leser jedoch von Blogger identifiziert werden.

Blogger API-Datenmodell

Eine Ressource ist ein individuelles Datenobjekt mit einer eindeutigen ID. Die Blogger JSON API arbeitet mit fünf Ressourcentypen:

• 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 ein untergeordnetes Element einer Beitragsressource.
• Seitenressource: Stellt eine statische Seite dar. Jede Seitenressource ist ein untergeordnetes Element einer Blogressource.
• Users-Ressource: Stellt einen nicht anonymen Nutzer dar. Damit wird der Autor einer Seite, eines Beitrags oder eines Kommentars identifiziert.

Übersicht über die Beziehungen zwischen Ressourcen

Das Blogger API-Datenmodell basiert auf Ressourcengruppen, sogenannten Sammlungen:

Sammlung von Blogs

Eine <span="apicollection">Blogs-Sammlung besteht aus allen Blogs, für die ein Nutzer Zugriffsrechte hat. Sie können Blogs nach Nutzer auflisten oder einen einzelnen Blog anhand der ID abrufen.</span="apicollection">

Sammlung von Beiträgen

Eine Sammlung von Beiträgen besteht aus allen Beitragsressourcen in einer bestimmten Blogressource.

Kommentarsammlung

Eine Kommentarsammlung besteht aus allen Kommentarressourcen innerhalb einer bestimmten Beitragsressource.

Sammlung „Seiten“

Eine Seiten-Sammlung besteht aus allen Seitenressourcen innerhalb einer bestimmten Blogressource.

Erhebung von Nutzerdaten

Eine Nutzer-Sammlung besteht aus allen Nutzerressourcen auf Blogger und kann daher nicht aufgeführt werden. Ein Nutzer kann seine eigene users-Ressource (aber nicht die eines anderen Nutzers) anhand der ID oder mit dem Bezeichner self abrufen.

Blogger API-Vorgänge

Sie können eine Reihe verschiedener Methoden für Sammlungen und Ressourcen in der Blogger API aufrufen, wie in der folgenden Tabelle beschrieben.

Vorgang	Beschreibung	REST-HTTP-Zuordnungen
list	Listet alle Ressourcen in einer Sammlung auf.	GET für einen Sammlungs-URI.
get	Ruft eine bestimmte Ressource ab.	GET für einen Ressourcen-URI.
getByUrl	Ruft eine Ressource ab, indem sie anhand der URL gesucht wird.	GET mit der URL, die als Parameter übergeben wird.
getByPath	Ruft eine Ressource ab, indem sie anhand ihres Pfads gesucht wird.	GET mit dem als Parameter übergebenen Pfad.
listByUser	Listet Ressourcen auf, die einem Nutzer gehören.	GET in einer Sammlung, die einem Nutzer gehört.
search	Suchen Sie anhand eines Suchparameters nach Ressourcen.	GET in einer Such-URL, wobei die Anfrage als Parameter übergeben wird.
insert	Ressource in einer Sammlung erstellen	POST für einen Sammlungs-URI.
Delete	Löscht eine Ressource.	DELETE für einen Ressourcen-URI.
patch	Aktualisieren Sie eine Ressource mit Patch-Semantik.	PATCH für einen Ressourcen-URI.
Aktualisieren	Ressource aktualisieren	PUT 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 für private Blogs ist eine Authentifizierung erforderlich.

Ressourcentyp	Unterstützte Methoden
	list	get	getByUrl	getByPath	listByUser	Suche	insert	delete	Patch	Aktualisieren
Blogs	Nein	Ja	Ja	Nein	Ja	nein	Nein	Nein	Nein	Nein
Beiträge	Ja	Ja	Nein	Ja	Nein	Ja	Ja	Ja	Ja	Ja
Kommentare	Ja	Ja	nein	Nein	Nein	Nein	Nein	Nein	Nein	Nein
Seiten	Ja	Ja	nein	Nein	Nein	Nein	Nein	Nein	Nein	Nein
Nutzer	Nein	Ja	nein	Nein	Nein	Nein	Nein	Nein	Nein	Nein

Aufrufstile

Es gibt mehrere Möglichkeiten, die API aufzurufen:

• Direkt über 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 API

Die unterstützten Blogger-Vorgänge sind REST-HTTP-Verben direkt zugeordnet, wie unter Blogger API-Vorgänge beschrieben.

Für Blogger API-URIs gelten folgende spezielle Formate:

https://www.googleapis.com/blogger/v3/users/userId
https://www.googleapis.com/blogger/v3/users/self
https://www.googleapis.com/blogger/v3/users/userId/blogs
https://www.googleapis.com/blogger/v3/users/self/blogs
https://www.googleapis.com/blogger/v3/blogs/blogId
https://www.googleapis.com/blogger/v3/blogs/byurl
https://www.googleapis.com/blogger/v3/blogs/blogId/posts
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId
https://www.googleapis.com/blogger/v3/blogs/blogId/pages
https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId

Eine vollständige Beschreibung der verwendeten URIs und der Ergebnisse für jeden unterstützten Vorgang in der API finden Sie im Referenzdokument zur Blogger API.

Beispiele

Die Blogs auflisten, auf die der authentifizierte Nutzer Zugriffsrechte hat:

GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY

So rufen Sie die Posts im Blog code.blogger.com mit der Blog-ID 3213900 ab:

GET https://www.googleapis.com/blogger/v3/blogs/3213900?key=YOUR-API-KEY

REST über JavaScript

Sie können die Blogger API über JavaScript aufrufen. Verwenden Sie dazu den Abfrageparameter callback und geben Sie eine Callback-Funktion an. Wenn der Browser das Skript lädt, wird die Callback-Funktion ausgeführt und die Antwort wird an die Callback-Funktion übergeben. So können Sie umfangreiche Anwendungen schreiben, in denen Blogger-Daten angezeigt werden, ohne dass serverseitiger Code erforderlich ist.

Im folgenden Beispiel wird ein Beitrag aus dem Blog code.blogger.com abgerufen, nachdem Sie YOUR-API-KEY durch Ihren API-Schlüssel ersetzt haben.

<html>
  <head>
    <title>Blogger 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/v3/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.