Blogger API'sı: Başlarken

Bu dokümanda, Blogger API'sini kullanmaya nasıl başlayabileceğiniz açıklanmaktadır.

Başlamadan önce

Bir Google Hesabı edinin

Bir Google Hesabı oluşturduğunuzdan emin olun. Kendinizi kazara veri kaybından korumak için geliştirme ve test amacıyla ayrı bir Google Hesabı kullanmanızı öneririz. Mevcut bir test hesabınız varsa test verilerinizi oluşturmak, düzenlemek veya görüntülemek için Blogger kullanıcı arayüzünü ziyaret edebilirsiniz.

Blogger hakkında bilgi edinin

Blogger kavramlarına aşina değilseniz bu dokümanı okuyun ve kodlamaya başlamadan önce kullanıcı arayüzü ile denemeler yapın. Bu dokümanda Blogger, web programlama kavramları ve web veri biçimleri hakkında bilgi sahibi olduğunuz varsayılmaktadır.

İstekleri yetkilendirme ve başvurunuzu tanımlama hakkında bilgi edinin

Uygulamanız gizli veri isteğinde bulunduğunda isteğin, söz konusu verilere erişimi olan kimliği doğrulanmış bir kullanıcı tarafından yetkilendirilmesi gerekir.

Uygulamanız herkese açık veriler istediğinde isteğin yetkilendirilmesi gerekmez, ancak API anahtarı gibi bir tanımlayıcıyla birlikte verilmesi gerekir.

İstekleri yetkilendirme ve API anahtarlarını kullanma hakkında bilgi edinmek için API kullanma dokümanındaki İstekleri yetkilendirme ve uygulamanızı tanımlama bölümüne bakın.

Blogger API arka planı

Blogger kavramları

Blogger beş temel kavram üzerine kurulmuştur:

  • Bloglar: API'nin temel kavramı. Bir blogda gönderiler ve sayfalar bulunur. Bu, blog adı ve Açıklama gibi blog meta bilgilerinin kapsayıcısıdır.
  • Gönderiler: Blog yayını, blog yazarının oluşturduğu paylaşılabilir bir öğedir. Yazarların şu anda dünyaya yayınlamak istediklerini yansıtan bu bilgiler, zamanında hazırlanmalıdır. Zaman geçtikçe blog'un içerik yaşları yayınladığı ve daha az düzensiz hale geldiği anlaşılıyor.
  • Yorumlar: Yorum, blog yayını yazarı dışındaki kullanıcıların yazarın yazdıklarına tepki verdiği yerdir. Tuğladan bukete kadar her şey.
  • Sayfa: Biyografi bilgileri veya kullanıcıyla iletişim kurma yolları gibi statik içeriğe sahip bir sayfadır. Bunlar genellikle çok sık değişmeyen, zaman aşımına uğrayan bir bilgidir.
  • Kullanıcılar: Kullanıcı; Yazar, Yönetici veya yalnızca Okuyucu olarak hareket eden Blogger ile etkileşime geçen kişidir. Herkese açık bloglarda okuyucular anonim olabilir ancak özel bloglarda okuyucuların Blogger tarafından tanımlanması gerekir.

Blogger API'si veri modeli

Kaynak, benzersiz tanımlayıcısı olan bağımsız bir veri varlığıdır. Blogger JSON API beş kaynak türü üzerinde çalışır:

  • Blog kaynağı: Bir blogu temsil eder.
  • Gönderi kaynağı: Yayını temsil eder. Her yayın kaynağı, bir blog kaynağının alt öğesidir.
  • Yorum kaynağı: Belirli bir yayındaki yorumu temsil eder. Her yorum kaynağı, yayın kaynağının alt öğesidir.
  • Sayfa kaynağı: Statik bir sayfayı temsil eder. Her sayfa kaynağı, bir blog kaynağının alt öğesidir.
  • Kullanıcı kaynağı: Anonim olmayan bir kullanıcıyı temsil eder. Bu alan, bir sayfanın, yayının veya yorumun Yazarını tanımlamak için kullanılır.
Bloglar kaynağının iki alt kaynak türü, sayfası ve yayını vardır.
          Bir yayın kaynağında yorum kaynağı alt öğeleri olabilir.
Kaynaklar arasındaki ilişkilere genel bakış

Blogger API'si veri modeli, koleksiyon adı verilen kaynak gruplarını temel alır:

Blog koleksiyonu
<span="apicollection&quot&&t;;blog koleksiyonu, kullanıcının erişim haklarına sahip olduğu tüm bloglardan oluşur. Blogları kullanıcıya göre listeleyebilir veya tek bir blogu ID.</span="apicollection">
ile alabilirsiniz
Yayın koleksiyonu
Yayın koleksiyonu, belirli bir blog kaynağı içindeki tüm yayın kaynaklarından oluşur.
Yorum toplama
Yorum koleksiyonu, belirli bir yayın kaynağı içindeki tüm yorum kaynaklarından oluşur.
Sayfa koleksiyonu
Sayfa koleksiyonu, belirli bir blog kaynağı içindeki tüm sayfa kaynaklarından oluşur.
Kullanıcı Toplama
Blogger'daki tüm kullanıcı kaynaklarından oluşan kullanıcı koleksiyonu, bu nedenle listelenemez. Kullanıcılar, kimliğe göre veya self tanımlayıcısını kullanarak kendi kullanıcı kaynaklarını (ancak başka hiç kimse) alamazlar.

Blogger API işlemleri

Blogger API'sindeki koleksiyonlar ve kaynaklarda, aşağıdaki tabloda açıklandığı gibi farklı yöntemlerden yararlanabilirsiniz.

İşlem Açıklama REST HTTP eşlemeleri
list Bir koleksiyondaki tüm kaynakları listeler. Bir koleksiyon URI'sinde GET.
al Belirli bir kaynağı alır. Kaynak URI'sında GET.
GETByUrl Bir kaynağı URL bazında arar. URL parametre olarak aktarılmış GET.
getByPath Kaynağı kaynağına göre arayarak alır. Yol, parametre olarak aktarılırken GET.
listByUser Kullanıcının sahip olduğu kaynakları listeler. Kullanıcının sahip olduğu bir koleksiyonda GET.
search Bir sorgu parametresine göre kaynak arayın. Sorgunun parametre olarak aktarıldığı bir Arama URL'sindeki GET
ekle Bir koleksiyonda kaynak oluşturun. Bir koleksiyon URI'sinde POST.
sil Kaynağı siler. Kaynak URI'sında DELETE.
yama Kaynakları, semantik kullanarak güncelleyin. Kaynak URI'sında PATCH.
güncelle Bir kaynağı güncelleyin. Kaynak URI'sında PUT.

Aşağıdaki tabloda, her kaynak türü tarafından desteklenen yöntemler gösterilmektedir. Özel bloglardaki tüm listeleme ve get işlemleri kimlik doğrulama gerektirir.

Kaynak Türü
Desteklenen Yöntemler
liste al getByUrl getByPath listByUser'dan ara ekle sil yama güncelleyin
Bloglar hayır evet evet hayır evet hayır hayır hayır hayır hayır
Gönderiler evet evet hayır evet hayır evet evet evet evet evet
Yorumlar evet evet hayır hayır hayır hayır hayır hayır hayır hayır
Sayfalar evet evet hayır hayır hayır hayır hayır hayır hayır hayır
Kullanıcı sayısı hayır evet hayır hayır hayır hayır hayır hayır hayır hayır

Arama stilleri

API'yi çağırmanın birkaç yolu vardır:

REST

REST, veri isteme ve değiştirmeye kullanışlı ve tutarlı yaklaşım sağlayan bir yazılım mimarisi stilidir.

REST terimi, "Representational State Transfer"in (Temsili Durum Aktarımı) kısaltmasıdır. Google API'leri bağlamında, Google tarafından saklanan verilerin temsillerini almak ve değiştirmek için HTTP fiillerini kullanma anlamına gelir.

RESTful bir sistemde, kaynaklar bir veri deposunda saklanır. Bir istemci, sunucunun belirli bir işlemi (ör. kaynak oluşturma, alma, güncelleme veya silme) gerçekleştirmesi için istek gönderir. Sunucu, işlemi gerçekleştirir ve yanıt gönderir. Bu yanıt genelde belirtilen kaynağın bir temsili biçimindedir.

Google'ın RESTful API'lerinde istemci POST, GET, PUT veya DELETE gibi bir HTTP fiilini kullanarak bir işlem belirtir. Bir kaynağı aşağıdaki biçimdeki genel olarak benzersiz bir URI ile belirtir:

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

Tüm API kaynaklarının HTTP tarafından erişilebilen benzersiz URI'ları olduğu için REST, veri önbelleğe almayı etkinleştirir ve web'deki dağıtılan altyapıyla birlikte çalışmak üzere optimize edilmiştir.

HTTP 1.1 standartları belgelerindeki yöntem tanımlarını yararlı bulabilirsiniz. Bu tanımlar GET, POST, PUT ve DELETE özelliklerini içerir.

Blogger API'sinde REST

Desteklenen Blogger işlemleri, Blogger API işlemlerinde açıklandığı gibi, doğrudan REST HTTP fiilleriyle eşlenir.

Blogger API URI'ları için belirli biçim şöyledir:

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

Kullanılan URI'lerin tam açıklaması ve API'de desteklenen her işlemin sonuçları Blogger API Referansı belgesinde özetlenmiştir.

Örnekler

Kimliği doğrulanmış kullanıcının erişim haklarına sahip olduğu blogları listeleme:

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

Yayınları 3213900 blog kimliğine sahip code.blogger.com blogundan alın:

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

JavaScript'ten REST

Blogger API'sini JavaScript'ten, callback sorgu parametresini kullanarak ve bir geri çağırma işlevi sağlayarak çağırabilirsiniz. Tarayıcı komut dosyasını yüklediğinde geri çağırma işlevi yürütülür ve geri çağırma işlevine yanıt verilir. Bu yaklaşım, sunucu tarafı kodu gerektirmeden Blogger verilerini görüntüleyen zengin uygulamalar yazmanıza olanak tanır.

Aşağıdaki örnek, YOUR-API-KEY kodunu API anahtarınızla değiştirdikten sonra code.blogger.com blogundan bir yayın alır.

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

Veri biçimi

JSON

JSON (JavaScript Object Notation), rastgele veri yapılarının basit metin temsilini sağlayan yaygın, dilden bağımsız bir veri biçimidir. Daha fazla bilgi için json.org adresine bakın.