Interfejs API Bloggera: pierwsze kroki

Z tego dokumentu dowiesz się, jak zacząć korzystać z interfejsu Blogger API.

Zanim rozpoczniesz

Uzyskaj konto Google

Sprawdź, czy masz skonfigurowane konto Google. Aby chronić się przed przypadkową utratą danych, zalecamy używanie osobnego konta Google do celów związanych z programowaniem i testowaniem. Jeśli masz już konto testowe, możesz przejść do interfejsu użytkownika Bloggera, aby skonfigurować, edytować lub wyświetlić dane testowe.

Zapoznaj się z Bloggerem

Jeśli nie znasz pojęć związanych z Bloggerem, przeczytaj ten dokument i wypróbuj interfejs użytkownika, zanim zaczniesz pisać kod. W tym dokumencie zakładamy, że znasz Bloggera, koncepcje programowania aplikacji internetowych i formaty danych internetowych.

Więcej informacji o autoryzowaniu żądań i identyfikowaniu aplikacji

Gdy Twoja aplikacja żąda prywatnych danych, użytkownik mający do nich dostęp musi autoryzować takie żądanie.

Gdy aplikacja żąda danych publicznych, nie musi autoryzować żądania, ale musi dołączyć identyfikator, np. klucz API.

Informacje o autoryzowaniu żądań i używaniu kluczy interfejsu API znajdziesz w sekcji Autoryzowanie żądań i identyfikowanie aplikacji w dokumencie Korzystanie z interfejsu API.

Informacje o interfejsie Blogger API

Pojęcia związane z Bloggerem

Blogger opiera się na 5 podstawowych koncepcjach:

Blogi: podstawowa koncepcja interfejsu API. Blog zawiera posty i strony. Jest to kontener metadanych bloga, takich jak nazwa bloga i opis.
Posty: post na blogu to element, który autor bloga może opublikować. Te informacje mają być aktualne i odzwierciedlać to, co autorzy chcą teraz opublikować. Z czasem treści postów na blogu stają się mniej aktualne i przydatne.
Komentarze: w tym miejscu osoby inne niż autor posta na blogu mogą reagować na to, co napisał autor. Wszystko, od cegieł po bukiety.
Strony: strona to miejsce na statyczne treści, takie jak informacje biograficzne lub sposoby kontaktu z użytkownikiem. Są to zazwyczaj informacje ponadczasowe, które nie zmieniają się zbyt często.
Użytkownicy: użytkownik to osoba, która korzysta z Bloggera jako autor, administrator lub czytelnik. W przypadku blogów publicznych czytelnicy mogą być anonimowi, ale w przypadku blogów prywatnych czytelnik musi być zidentyfikowany przez Bloggera.

Model danych interfejsu Blogger API

Zasób to pojedynczy obiekt danych z unikalnym identyfikatorem. Interfejs Blogger JSON API obsługuje 5 rodzajów zasobów:

Zasób Blogs: reprezentuje bloga.
Zasób Posts: reprezentuje post. Każdy zasób Posts jest zasobem podrzędnym zasobu Blogs.
Zasób komentarzy: reprezentuje komentarz do konkretnego posta. Każdy zasób komentarzy jest elementem podrzędnym zasobu postów.
Zasób Pages: reprezentuje statyczną stronę. Każdy zasób pages jest zasobem podrzędnym zasobu blogs.
Zasób Users: reprezentuje użytkownika nieanonimowego. Służy do identyfikowania autora strony, posta lub komentarza.

Zasób blogi ma 2 typy zasobów podrzędnych: strony i posty.
Zasób postów może mieć podrzędne zasoby komentarzy. — Omówienie relacji między zasobami

Model danych interfejsu Blogger API opiera się na grupach zasobów, zwanych kolekcjami:

Kolekcja blogów: Kolekcja <span="apicollection">blogów zawiera wszystkie blogi, do których użytkownik ma prawa dostępu. Możesz wyświetlić listę blogów według użytkownika lub pobrać pojedynczy blog według identyfikatora.</span="apicollection">
Kolekcja postów: Kolekcja postów zawiera wszystkie zasoby postów w ramach konkretnego zasobu blogów.
Kolekcja komentarzy: Kolekcja komentarzy składa się ze wszystkich zasobów komentarzy w ramach konkretnego zasobu postów.
Kolekcja stron: Kolekcja stron zawiera wszystkie zasoby stron w ramach konkretnego zasobu blogów.
Kolekcja użytkowników: Kolekcja użytkowników zawiera wszystkie zasoby użytkowników w Bloggerze, dlatego nie można jej wyświetlić. Użytkownik może pobrać własny zasób users (ale nie zasób innego użytkownika) według identyfikatora lub za pomocą identyfikatora self.

Operacje interfejsu Blogger API

W interfejsie Blogger API możesz wywoływać różne metody w kolekcjach i zasobach, co opisano w tabeli poniżej.

Operacja	Opis	Mapowania REST HTTP
list	Wyświetla listę wszystkich zasobów w kolekcji.	`GET` w identyfikatorze URI kolekcji.
get	Pobiera określony zasób.	`GET` w identyfikatorze URI zasobu.
getByUrl	Pobiera zasób, wyszukując go według adresu URL.	`GET` z adresem URL przekazanym jako parametr.
getByPath	Pobiera zasób, wyszukując go według ścieżki.	`GET`, w którym ścieżka jest przekazywana jako parametr.
listByUser	Wyświetla listę zasobów należących do użytkownika.	`GET` w przypadku kolekcji należącej do użytkownika.
search	Wyszukiwanie zasobów na podstawie parametru zapytania.	`GET` w adresie URL wyszukiwania, z zapytaniem przekazywanym jako parametr.
wstaw	Tworzenie zasobu w kolekcji.	`POST` w identyfikatorze URI kolekcji.
usuń	Usuwa zasób.	`DELETE` w identyfikatorze URI zasobu.
patch	Aktualizuje zasób przy użyciu semantyki poprawki.	`PATCH` w identyfikatorze URI zasobu.
aktualizować	Zaktualizuj zasób.	`PUT` w identyfikatorze URI zasobu.

Tabela poniżej zawiera informacje o tym, które metody są obsługiwane przez poszczególne typy zasobów. Wszystkie operacje list i get na blogach prywatnych wymagają uwierzytelnienia.

Typ zasobu	Obsługiwane metody
	list	pobierz	getByUrl	getByPath	listByUser	wyszukiwanie	wstaw	usuń	patch	update
Blogi	nie	tak	tak	nie	tak	nie	nie	nie	nie	nie
Posty	tak	tak	nie	tak	nie	tak	tak	tak	tak	tak
komentarzami.	tak	tak	nie	nie	nie	nie	nie	nie	nie	nie
Strony	tak	tak	nie	nie	nie	nie	nie	nie	nie	nie
Użytkownicy	nie	tak	nie	nie	nie	nie	nie	nie	nie	nie

Style połączeń

Interfejs API można wywołać na kilka sposobów:

Bezpośrednio za pomocą REST lub z użyciem JavaScript (nie wymaga kodu po stronie serwera)
korzystanie z bibliotek klientów.

REST

REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do wysyłania żądań dotyczących danych i ich modyfikowania.

REST to skrót od „Representational State Transfer”. W kontekście interfejsów API Google oznacza to używanie czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.

W systemie RESTful zasoby są przechowywane w magazynie danych. Klient wysyła żądanie, aby serwer wykonał określone działanie (np. utworzył, pobrał, zaktualizował lub usunął zasób), a serwer wykonuje to działanie i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.

W interfejsach API REST Google klient określa działanie za pomocą czasownika HTTP, takiego jak POST, GET, PUT lub DELETE. Określa zasób za pomocą unikalnego globalnie identyfikatora URI w tej postaci:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Ponieważ wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem współpracy z rozproszoną infrastrukturą internetu.

W dokumentacji standardów HTTP 1.1 znajdziesz definicje metod, w tym specyfikacje metod GET, POST, PUT i DELETE.

REST w interfejsie Blogger API

Obsługiwane operacje Bloggera są bezpośrednio powiązane z czasownikami REST HTTP, jak opisano w operacjach interfejsu Blogger API.

Identyfikatory URI interfejsu Blogger API mają te formaty:

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

Pełne wyjaśnienie używanych identyfikatorów URI i wyników każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumencie Dokumentacja interfejsu Blogger API.

Przykłady

Wyświetl listę blogów, do których uwierzytelniony użytkownik ma prawa dostępu:

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

Pobierz posty z bloga code.blogger.com, którego identyfikator to 3213900:

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

REST z JavaScriptu

Interfejs Blogger API możesz wywołać z JavaScriptu, używając parametru zapytania callback i podając funkcję wywołania zwrotnego. Gdy przeglądarka wczyta skrypt, funkcja wywołania zwrotnego zostanie wykonana, a odpowiedź zostanie przekazana do tej funkcji. Takie podejście umożliwia pisanie rozbudowanych aplikacji, które wyświetlają dane z Bloggera bez konieczności pisania kodu po stronie serwera.

Poniższy przykład pobiera post z bloga code.blogger.com po zastąpieniu symbolu YOUR-API-KEY kluczem API.

<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>

Format danych

JSON

JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który zapewnia prostą tekstową reprezentację dowolnych struktur danych. Więcej informacji znajdziesz na stronie json.org.

Interfejs API Bloggera: pierwsze kroki Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.