Blogger JSON API: API verwenden

Wichtig: Die Unterstützung der 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 wird beschrieben, wie Sie die gängigen Funktionen der Blogger JSON API mit dem RESTful-Aufrufstil verwenden.

Inhalt

Einführung

Dieses Dokument richtet sich an Entwickler, die Anwendungen erstellen möchten, die mit der Blogger JSON API interagieren können. Blogger ist ein Tool zum Erstellen von Websites, mit dem Nutzer ihre Gedanken kontinuierlich veröffentlichen können.

Wenn Sie mit den Blogger-Konzepten nicht vertraut sind, sollten Sie sich den Artikel Erste Schritte durchlesen, bevor Sie mit dem Codieren beginnen.

Anfragen autorisieren und Ihre Anwendung identifizieren

Jede Anfrage, die Ihre Anwendung an die Blogger JSON API sendet, muss Ihre Anwendung gegenüber Google identifizieren. Dafür gibt es zwei Möglichkeiten: die Verwendung eines OAuth 2.0-Tokens, das auch die Anfrage autorisiert, und/oder die Verwendung des API-Schlüssels der Anwendung. Welche dieser Optionen Sie nutzen sollten, hängt von Folgendem ab:

  • Wenn die Anfrage eine Autorisierung erfordert, beispielsweise für private Daten einer Person, muss die Anwendung ein OAuth 2.0-Token mit der Anfrage bereitstellen. Die Anwendung kann auch den API-Schlüssel bereitstellen, dies ist jedoch nicht notwendig.
  • Wenn die Anfrage keine Autorisierung erfordert, beispielsweise bei einer Anfrage in Bezug auf öffentliche Daten, muss die Anwendung entweder den API-Schlüssel oder ein OAuth 2.0-Token oder beides bereitstellen, je nachdem, was für Sie am bequemsten ist.

Autorisierungsprotokolle

Ihre Anwendung muss zur Autorisierung von Anfragen OAuth 2.0 verwenden. Andere Autorisierungsprotokolle werden nicht unterstützt.

Hinweis: Die Blogger JSON API unterstützt derzeit nicht die gleichzeitige Anmeldung und den Datenzugriff (hybrid) oder die domainweite Delegierung von Berechtigungen (2LO).

Anfragen mit OAuth 2.0 autorisieren

Anfragen an die Blogger JSON API in Bezug auf nicht öffentliche Nutzerdaten müssen von einem authentifizierten Nutzer autorisiert werden.

Die Details dieses Autorisierungsablaufs für OAuth 2.0 hängen davon ab, welche Art von Anwendung du schreibst. Die folgende allgemeine Vorgehensweise gilt für alle Arten von Anwendungen:

  1. Wenn Sie Ihre Anwendung erstellen, registrieren Sie sie bei Google. Google stellt Ihnen dann die Informationen bereit, die Sie später benötigen, z. B. eine Client-ID und einen Clientschlüssel.
  2. Aktivieren Sie die Blogger JSON API im Bereich „Dienste“ der Google APIs Console. Wenn die API nicht in der Console aufgeführt ist, überspringen Sie diesen Schritt.
  3. Wenn Ihre Anwendung Zugriff auf Nutzerdaten benötigt, bittet sie Google um einen bestimmten Zugriffsbereich.
  4. Dem Nutzer wird von Google ein OAuth-Dialogfeld angezeigt, auf dem er gebeten wird, Ihre Anwendung dazu zu autorisieren, einige seiner Daten abzufragen.
  5. Wenn der Nutzer zustimmt, erhält Ihre Anwendung von Google ein kurzlebiges Zugriffstoken.
  6. Die Anwendung fordert Nutzerdaten an, wobei das Zugriffstoken an die Anfrage angehängt wird.
  7. Stellt Google fest, dass Ihre Anfrage und das Token gültig sind, werden die angeforderten Daten zurückgegeben.

Einige Abläufe enthalten zusätzliche Schritte, beispielsweise die Verwendung von Aktualisierungstoken zum Erhalt neuer Zugriffstoken. Weitere Informationen über die Abläufe für die unterschiedlichen Anwendungstypen findest du in der OAuth 2.0-Dokumentation.

Im Folgenden finden Sie die Informationen zum OAuth 2.0-Bereich für die Blogger JSON API:

https://www.googleapis.com/auth/blogger

Zur Anforderung eines Zugriffs mit OAuth 2.0 benötigt Ihre Anwendung die Bereichsinformationen sowie die Informationen, die Google bei der Registrierung Ihrer Anwendung bereitstellt, z. B. die Client-ID und/oder den Clientschlüssel.

Tipp:Die Google APIs-Clientbibliotheken können einige Schritte des Autorisierungsvorgangs für Sie übernehmen. Sie sind für verschiedene Programmiersprachen verfügbar. Weitere Informationen erhältst du auf der Seite Bibliotheken und Beispiele.

API-Schlüssel erhalten und nutzen

Anfragen an die Blogger JSON API für öffentliche Daten müssen eine Kennzeichnung enthalten. Das kann ein API-Schlüssel oder ein Authentifizierungstoken sein.

Einen API-Schlüssel erhalten Sie in der APIs Console. Aktivieren Sie im Bereich „Dienste“ die [api_name]. Wenn die Nutzungsbedingungen angezeigt werden, lesen Sie sie und akzeptieren Sie sie.

Rufen Sie als Nächstes den Bereich API-Zugriff auf. Der API-Schlüssel befindet sich unten im Bereich „Einfacher API-Zugriff“.

Nachdem Sie einen API-Schlüssel haben, kann Ihre Anwendung den Suchparameter key=yourAPIKey an alle Anfrage-URLs anhängen.

Der API-Schlüssel lässt sich sicher in URLs einbetten. Eine Codierung ist nicht notwendig.

Arbeiten mit Blogs

Blog abrufen

Sie können Informationen für eine bestimmte Blogressource abrufen, indem Sie eine HTTP-GET-Anfrage an den URI des Blogs senden. Der URI für eine Blogressource hat folgendes Format:

https://www.googleapis.com/blogger/v2/blogs/blogId

Anfrage

Hier ein Beispiel:

GET https://www.googleapis.com/blogger/v2/blogs/2399953&key=YOUR-API-KEY

Da ein Nutzer nicht authentifiziert werden muss, um einen öffentlichen Blog abzurufen, musst du bei dieser GET-Anfrage keinen Authorization-HTTP-Header angeben. Wenn du diesen Header jedoch nicht angibst, musst du einen API-Schlüssel angeben.

Blogger bietet auch private Blogs an, für die eine Authentifizierung erforderlich ist.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und den Blogdaten:

200 OK

{
  "kind": "blogger#blog",
  "id": "2399953",
  "name": "Blogger Buzz",
  "description": "The Official Buzz from Blogger at Google",
  "published": "2007-04-23T22:17:29.261Z",
  "updated": "2011-08-02T06:01:15.941Z",
  "url": "http://buzz.blogger.com/",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953",
  "posts": {
    "totalItems": 494,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts"
  },
  "pages": {
    "totalItems": 2,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/pages"
  },
  "locale": {
    "language": "en",
    "country": "",
    "variant": ""
  }
}

Blogs eines Nutzers abrufen

Du kannst eine Liste der Blogs eines Nutzers abrufen, indem du eine HTTP-GET-Anfrage an den URI der Blogs-Sammlung sendest:

https://www.googleapis.com/blogger/v2/users/userId/blogs

Anfrage

Hier ist ein Beispiel für eine GET-Anfrage, die die Blogs eines Nutzers auflistet:

GET https://www.googleapis.com/blogger/v2/users/self/blogs
Authorization: /* OAuth 2.0 token here */

Hinweis: Der Nutzer muss authentifiziert sein, um seine eigenen Blogs auflisten zu können. Daher musst du den Authorization-HTTP-Header mit der GET-Anfrage angeben.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und der vollständigen Liste der Blogs des Nutzers:

200 OK

{
  "kind": "blogger#blogList",
  "items": [
    {
      "kind": "blogger#blog",
      "id": "4967929378133675647",
      "name": "Brett's Test Blawg",
      "description": "",
      "published": "2010-10-06T23:33:31.662Z",
      "updated": "2011-08-08T06:50:02.005Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647",
      "posts": {
        "totalItems": 13,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/posts"
      },
      "pages": {
        "totalItems": 1,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages"
      },
      "locale": {
        "language": "en",
        "country": "",
        "variant": ""
      }
    }
  ]
}

Mit Beiträgen arbeiten

Beiträge aus einem Blog abrufen

Du kannst eine Liste der Beiträge eines bestimmten Blogs abrufen, indem du eine GET-Anfrage an den URI der Beitragssammlung sendest. Der URI für eine Sammlung von Beiträgen hat folgendes Format:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts

Anfrage

Hier ein Beispiel:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts&key=YOUR-API-KEY

Da ein Nutzer nicht authentifiziert werden muss, um die Beiträge aus einem öffentlichen Blog abzurufen, musst du bei dieser GET-Anfrage nicht den Authorization-HTTP-Header angeben. Wenn du diesen Header jedoch nicht angibst, musst du einen API-Schlüssel angeben.

Blogger bietet auch private Blogs an, für die eine Authentifizierung erforderlich ist.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und der Liste der Beiträge:

200 OK

{
  "kind": "blogger#postList",
  "nextPageToken": "CgkIChiAkceVjiYQ0b2SAQ",
  "prevPageToken": "CgkIChDBwrK3mCYQ0b2SAQ",
  "items": [
    {
      "kind": "blogger#post",
      "id": "7706273476706534553",
      "blog": {
        "id": "2399953"
      },
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.947Z",
      "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
      "title": "Latest updates, August 1st",
      "content": "elided for readability",
      "author": {
        "id": "401465483996",
        "displayName": "Brett Wiltshire",
        "url": "http://www.blogger.com/profile/01430672582309320414",
        "image": {
          "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
         }
      },
      "replies": {
        "totalItems": "0",
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
      }
    },
    {
      "kind": "blogger#post",
      "id": "6069922188027612413",
      elided for readability
    }
  ]
}

Einen bestimmten Beitrag abrufen

Sie können einen bestimmten Beitrag aus einem Blog abrufen, indem Sie eine GET-Anfrage an die URI der Beitragsressource senden. Der URI für eine Beitragsressource hat folgendes Format:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId

Anfrage

Hier ein Beispiel:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553&key=YOUR-API-KEY

Da ein Nutzer nicht authentifiziert werden muss, um die Beiträge aus einem öffentlichen Blog abzurufen, musst du bei dieser GET-Anfrage nicht den Authorization-HTTP-Header angeben. Wenn du diesen Header jedoch nicht angibst, musst du einen API-Schlüssel angeben.

Blogger bietet auch private Blogs an, für die eine Authentifizierung erforderlich ist.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und dem Inhalt des Beitrags:

200 OK

{
  "kind": "blogger#post",
  "id": "7706273476706534553",
  "blog": {
    "id": "2399953"
  },
  "published": "2011-08-01T19:58:00.000Z",
  "updated": "2011-08-01T19:58:51.947Z",
  "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
  "title": "Latest updates, August 1st",
  "content": "elided for readability",
  "author": {
    "id": "401465483996",
    "displayName": "Brett Wiltshire",
    "url": "http://www.blogger.com/profile/01430672582309320414",
    "image": {
      "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
    }
  },
  "replies": {
    "totalItems": "0",
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
  }
}

Mit Kommentaren arbeiten

Kommentare zu einem Beitrag abrufen

Du kannst eine Liste der Kommentare zu einem Beitrag abrufen, indem du eine GET-Anfrage an den URI der Kommentarsammlung sendest. Der URI für eine Kommentarsammlung hat folgendes Format:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments

Anfrage

Hier ein Beispiel:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments&key=YOUR-API-KEY

Da ein Nutzer nicht authentifiziert werden muss, um die Kommentare aus einem öffentlichen Blog abzurufen, musst du bei dieser GET-Anfrage nicht den Authorization-HTTP-Header angeben. Wenn du diesen Header jedoch nicht angibst, musst du einen API-Schlüssel angeben.

Blogger bietet auch private Blogs an, für die eine Authentifizierung erforderlich ist.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und der Liste der Kommentare:

200 OK

{
  "kind": "blogger#commentList",
  "nextPageToken": "CgkIFBDwjvDXlyYQ0b2SARj9mZe9n8KsnlQ",
  "prevPageToken": "CgkIFBisvMGRlyYQ0b2SARj9mZe9n8KsnlQ",
  "items": [
    {
       "kind": "blogger#comment",
       "id": "9200761938824362519",
       "post": {
         "id": "6069922188027612413"
       },
       "blog": {
         "id": "2399953"
       },
       "published": "2011-07-28T19:19:57.740Z",
       "updated": "2011-07-28T21:29:42.015Z",
       "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
       "content": "elided",
       "author": {
         "id": "530579030283",
         "displayName": "elided",
         "url": "elided",
         "image": {
           "url": "elided"
         }
       }
    },
    {
      "kind": "blogger#comment",
      "id": "400101178920857170",
      elided for readability
    }
  ]
}

Bestimmten Kommentar abrufen

Du kannst einen bestimmten Kommentar aus einem Beitrag abrufen, indem du eine GET-Anfrage an die URI der Kommentarressource sendest. Der URI für eine Kommentarressource hat folgendes Format:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId

Anfrage

Hier ein Beispiel:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519&key=YOUR-API-KEY

Da ein Nutzer nicht authentifiziert werden muss, um die Kommentare aus einem öffentlichen Blog abzurufen, musst du bei dieser GET-Anfrage nicht den Authorization-HTTP-Header angeben. Wenn du diesen Header jedoch nicht angibst, musst du einen API-Schlüssel angeben.

Blogger bietet auch private Blogs an, für die eine Authentifizierung erforderlich ist.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und den Kommentardaten:

200 OK

{
  "kind": "blogger#comment",
  "id": "9200761938824362519",
  "post": {
    "id": "6069922188027612413"
  },
  "blog": {
    "id": "2399953"
  },
  "published": "2011-07-28T19:19:57.740Z",
  "updated": "2011-07-28T21:29:42.015Z",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
  "content": "elided",
  "author": {
    "id": "530579030283",
    "displayName": "elided",
    "url": "elided",
    "image": {
      "url": "elided"
    }
  }
}

Mit Seiten arbeiten

Seiten für einen Blog abrufen

Sie können eine Liste der Seiten für einen Blog abrufen, indem Sie eine GET-Anfrage an den URI der Seitensammlung senden. Der URI für eine Seitensammlung hat folgendes Format:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages

Anfrage

Hier ein Beispiel:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages&key=YOUR-API-KEY

Da ein Nutzer nicht authentifiziert werden muss, um die Seiten aus einem öffentlichen Blog abzurufen, musst du bei dieser GET-Anfrage nicht den Authorization-HTTP-Header angeben. Wenn du diesen Header jedoch nicht angibst, musst du einen API-Schlüssel angeben.

Blogger bietet auch private Blogs an, für die eine Authentifizierung erforderlich ist.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und der Liste der Seiten:

200 OK

{
  "kind": "blogger#pageList",
  "items": [
    {
      "kind": "blogger#page",
      "id": "273541696466681878",
      "blog": {
        "id": "4967929378133675647"
      },
      "published": "2011-07-14T16:16:00.000Z",
      "updated": "2011-07-14T16:16:23.602Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
      "title": "Static Content",
      "content": "elided for readability",
      "author": {
        "id": "901569848744",
        "displayName": "brett",
        "url": "http://www.blogger.com/profile/16258312240222542576",
        "image": {
          "url": "https://resources.blogblog.com/img/b16-rounded.gif"
        }
      }
    }
  ]
}

Bestimmte Seite abrufen

Sie können eine bestimmte Seite aus einem Blog abrufen, indem Sie eine GET-Anfrage an den URI der Seitenressource senden. Der URI für eine Google-Seiten-Ressource hat folgendes Format:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId

Anfrage

Hier ein Beispiel:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878&key=YOUR-API-KEY

Da ein Nutzer nicht authentifiziert werden muss, um die Seiten aus einem öffentlichen Blog abzurufen, musst du bei dieser GET-Anfrage nicht den Authorization-HTTP-Header angeben. Wenn du diesen Header jedoch nicht angibst, musst du einen API-Schlüssel angeben.

Blogger bietet auch private Blogs an, für die eine Authentifizierung erforderlich ist.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und den Seitendaten:

200 OK

{
  "kind": "blogger#page",
  "id": "273541696466681878",
  "blog": {
    "id": "4967929378133675647"
  },
  "published": "2011-07-14T16:16:00.000Z",
  "updated": "2011-07-14T16:16:23.602Z",
  "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
  "title": "Static Content",
  "content": "elided for readability",
  "author": {
    "id": "901569848744",
    "displayName": "brett",
    "url": "http://www.blogger.com/profile/16258312240222542576",
    "image": {
      "url": "https://resources.blogblog.com/img/b16-rounded.gif"
    }
  }
}

Mit Nutzern arbeiten

Nutzer abrufen

Sie können die Informationen eines Nutzers abrufen, indem Sie eine HTTP-GET-Anfrage an die URI der Nutzerressource senden:

https://www.googleapis.com/blogger/v2/users/userId

Anfrage

Hier ist ein Beispiel für eine GET-Anfrage, die die Blogs eines Nutzers auflistet:

GET https://www.googleapis.com/blogger/v2/users/self
Authorization: /* OAuth 2.0 token here */

Hinweis: Der Nutzer muss authentifiziert sein, um seine eigenen Informationen auflisten zu können. Daher müssen Sie den Authorization-HTTP-Header mit der GET-Anfrage angeben.

Antwort

Wenn die Anfrage erfolgreich ist, antwortet der Server mit dem HTTP-Statuscode 200 OK und einem Link zu einer Liste der Blogs des Nutzers:

200 OK

{
  "kind": "blogger#user",
  "id": "901569848744",
  "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744",
  "blogs": {
    "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744/blogs"
  }
}

Standardabfrageparameter

Die folgenden Abfrageparameter können mit allen Methoden und allen Ressourcen in den Blogger APIs verwendet werden.

Abfrageparameter, die für alle Blogger API-Vorgänge gelten, sind unter Systemparameter dokumentiert.