重要: これはこのページの古いバージョンです。最新バージョンでは、左側のナビゲーション バーのリンクを使用してください。
Blogger Data API を使用すると、クライアント アプリケーションで Google Data API フィードの形式で Blogger のコンテンツを表示、更新できます。
クライアント アプリケーションで Blogger Data API を使用すると、新しいブログ投稿の作成、既存のブログ投稿の編集または削除、特定の条件に一致するブログ投稿の検索を行うことができます。
このドキュメントでは、Blogger Data API の機能の概要に加えて、Java クライアント ライブラリを使用した Data API の基本的な操作例についても説明します。ライブラリが使用する基礎となるプロトコルの詳細については、このデベロッパー ガイドのプロトコルのセクションをご覧ください。
目次
対象読者
このドキュメントは、Blogger とやり取りできる Java クライアント アプリケーションを作成するプログラマーを対象としています。
このドキュメントは、Google Data API プロトコルの背後にある一般的な概念を理解していることを前提としています。
クライアント ライブラリによって提供されるクラスとメソッドのリファレンス情報については、Java クライアント ライブラリ API リファレンスをご覧ください。Blogger Data API の一般的なリファレンス情報については、プロトコルのリファレンス ガイドをご覧ください。
ご利用にあたって
クライアント ライブラリの設定については、スタートガイドをご覧ください。
Java クライアント ライブラリには Java 1.5 が必要です。クライアント ライブラリをダウンロードした後、使用を開始するために必要なクラスが java/lib/gdataclient-1.0.jar
ファイルに含まれています。
Blogger アカウントを作成する
テスト目的で Blogger アカウントに登録することもできます。Blogger では Google アカウントを使用するので、Google アカウントをすでにお持ちであれば問題ありません。
サンプルコードの実行
このドキュメントに記載されているすべてのサンプルコードを含む、完全に機能するサンプル クライアントは、Java クライアント ライブラリのディストリビューションの gdata/java/sample/blogger/BloggerClient.java
ディレクトリにあります。ビルド手順と実行手順は、README.txt
ファイル内の同じディレクトリにあります。
サンプル クライアントは、提供されたブログに対していくつかのオペレーションを実行し、Blogger Data API の使用方法を示します。
このドキュメントの例を独自のコードにコンパイルするには、次の import
ステートメントが必要です。
import com.google.gdata.client.*; import com.google.gdata.data.*; import com.google.gdata.util.*; import java.io.IOException; import java.net.URL;
Blogger サービスの認証
Blogger Data API を使用すると、公開フィードと非公開フィードの両方にアクセスできます。 公開フィードは認証を必要としませんが、読み取り専用です。ブログを変更する場合は、非公開フィードをリクエストする前にクライアントが認証を受ける必要があります。認証には、AuthSub プロキシ認証または ClientLogin ユーザー名/パスワード認証のいずれかの方法を使用できます。
Google Data API での認証に関する一般的な情報については、認証のドキュメントをご覧ください。
このドキュメントの以降のセクションのサンプルのほとんどでは、認証済みの GoogleService
オブジェクトがあることを前提としています。
AuthSub プロキシ認証
AuthSub プロキシ認証は、Google アカウントに対してユーザーを認証する必要があるウェブ アプリケーションで使用されます。ウェブサイト運用者とクライアント コードは、Blogger ユーザーのユーザー名とパスワードにアクセスできません。代わりに、クライアントは、クライアントが特定のユーザーに代わって動作できるようにする特別な AuthSub トークンを取得します。詳しくは、AuthSub のドキュメントをご覧ください。
ユーザーが初めてアプリケーションにアクセスしたときは、まだ認証されていません。この場合、ブログへのアクセス リクエストを認証するために、ユーザーを Google ページに誘導する情報とリンクを表示する必要があります。Java クライアント ライブラリには、Google ページの URL を生成する関数が用意されています。以下のコードは、AuthSubRequest ページの URL を取得します。
String next = "http://www.example.com/welcome.html"; String scope = "http://www.blogger.com/feeds/"; boolean secure = false; boolean session = true; String authSubLogin = AuthSubUtil.getRequestUrl(next, scope, secure, session);
getRequestUrl
メソッドは、次のパラメータ(AuthSubRequest ハンドラで使用されるクエリ パラメータに対応)を受け取ります。
- 次へ
- 認証後に Google がユーザーをリダイレクトするページの URL。
- スコープ
- アプリケーションが Blogger フィードにアクセスするためのトークンをリクエストしていることを示します。使用するスコープ文字列は
http://www.blogger.com/feeds/
です(もちろん URL エンコードされています)。 - 安全
- クライアントがセキュア トークンをリクエストしているかどうかを示します。
- セッション
- 返されたトークンを複数回使用(セッション)トークンと交換できるかどうかを示します。
上記の例は、セキュア トークンをリクエストしない呼び出しを示しています(secure
の値は false
です)。生成されるリクエスト URL は次のようになります。
https://www.google.com/accounts/AuthSubRequest?scope=http%3A%2F%2Fwww.blogger.com%2Ffeeds%2F&session=1&secure=0&next=http%3A%2F%2Fwww.example.com%2Fwelcome.html
ユーザーはリンクをクリックして Google のサイトにアクセスし、Google アカウントで認証を行います。
ユーザーが認証されると、AuthSub システムは AuthSubRequest URL の next
クエリ パラメータで指定した URL にユーザーをリダイレクトします。AuthSub システムは、token
クエリ パラメータの値として、その URL に認証トークンを追加します。次に例を示します。
http://www.example.com/welcome.html?token=yourAuthToken
このトークン値は、1 回限りの AuthSub トークンを表します。この例では、session = true
が指定されているため、次のように AuthSubSessionToken
サービスを呼び出すことで、このトークンを AuthSub セッション トークンと交換できます。ここで、urlFromAuthSub
は AuthSub がトークンを追加した URL です。
String token = AuthSubUtil.getTokenFromReply(urlFromAuthSub); String sessionToken = AuthSubUtil.exchangeForSessionToken(token, null);
つまり、1 回限りのトークンを null
(未登録モードの場合)または秘密鍵(登録モードの場合)とともに exchangeForSessionToken
メソッドに渡すと、AuthSub インターフェースがセッション トークンを返します。登録済みのアプリケーションと秘密鍵の詳細については、AuthSub ドキュメントの「リクエストへの署名」セクションをご覧ください。
これにより、アプリケーションはセッション トークンをその後の Blogger の操作で使用できるようになります。リクエストごとにセッション トークンを自動的に送信するように Java クライアント ライブラリに指示するには、GoogleService
オブジェクトの setAuthSubToken
メソッドを呼び出します。
GoogleService.setAuthSubToken(sessionToken, null);
その後、クライアント ライブラリはリクエストごとにトークンを自動的に送信します。
ClientLogin ユーザー名/パスワード認証
クライアントがスタンドアロンのシングル ユーザーの「インストール」クライアント(デスクトップ アプリケーションなど)の場合は、ClientLogin 認証を使用します。GoogleService
オブジェクトで setUserCredentials
メソッドを呼び出すだけで、それ以降の Blogger の操作はすべて認証されます。
GoogleService myService = new GoogleService("blogger", "exampleCo-exampleApp-1"); myService.setUserCredentials("user@example.com", "secretPassword");
上記のスニペットでは、GoogleService
コンストラクタに 2 つのパラメータを渡します。最初のパラメータは
通信するサービスの名前です2 番目のパラメータは、companyName-applicationName-versionID 形式のアプリケーションの名前です。
リクエストとレスポンスのサンプルなど、ClientLogin 認証の詳細については、インストール済みアプリケーションの認証のドキュメントをご覧ください。
注: 特定のセッションのすべてのリクエストに同じトークンを使用します。Blogger のリクエストごとに新しいトークンを取得しないでください。
注: ClientLogin のドキュメントに記載されているように、認証リクエストが失敗し、CAPTCHA チャレンジがリクエストされることがあります。Google に CAPTCHA チャレンジの発行と処理を任せる場合は、ユーザーを(ClientLogin のドキュメントに記載されている CAPTCHA 処理 URL ではなく)https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger
に送信します。
ブログのリストの取得
Blogger Data API には、特定のユーザーのブログを一覧表示するフィードがあります。このフィードは「メタフィード」と呼ばれます。
次のサンプルコードでは、認証済みの GoogleService
オブジェクトを使用してメタフィードを取得し、各ブログのタイトルを出力します。
public static void printUserBlogs(GoogleService myService) throws ServiceException, IOException { // Request the feed final URL feedUrl = new URL("http://www.blogger.com/feeds/default/blogs"); Feed resultFeed = myService.getFeed(feedUrl, Feed.class); // Print the results System.out.println(resultFeed.getTitle().getPlainText()); for (int i = 0; i < resultFeed.getEntries().size(); i++) { Entry entry = resultFeed.getEntries().get(i); System.out.println("\t" + entry.getTitle().getPlainText()); } }
getFeed
メソッドで使用される URL をメモします。これはデフォルトのメタフィード URL で、現在認証されているユーザーのブログのリストを返します。別のユーザーのフィードにアクセスするには、メタフィード URL の default
の代わりに、そのユーザーの ID を入力します。ユーザーの ID は、ユーザーのプロフィール URL の末尾にある数字の文字列です。
投稿の作成
Blogger Data API を使用すると、新しいブログエントリを作成、公開したり、エントリの下書きを作成したりすることができます。
注: 現在のところ、投稿にカスタムの作成者を設定することはできません。新しい投稿はすべて、現在認証されているユーザーによって作成されたかのように表示されます。
ブログ投稿を公開する
Java クライアント ライブラリを使用して、新しいブログエントリを公開できます。
まず、ブログ投稿を表す Entry
オブジェクトを作成します。次に、ブログ投稿のタイトル、コンテンツ、その他の属性を設定します。最後に、GoogleService
オブジェクトを使用して投稿を挿入します。新しいブログ投稿を公開する方法の例を次に示します。
public static Entry createPost( GoogleService myService, String blogID, String title, String content, String userName) throws ServiceException, IOException { // Create the entry to insert Entry myEntry = new Entry(); myEntry.setTitle(new PlainTextConstruct(title)); myEntry.setContent(new PlainTextConstruct(content)); // Ask the service to insert the new entry URL postUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default"); return myService.insert(postUrl, myEntry); }
insert
メソッドは、サービスの投稿 URL をパラメータとして受け取ります。その後、このメソッドは Blogger で保存されたエントリを返します。返されたエントリは送信されたものと同じですが、投稿 ID など、Blogger によって追加されたさまざまな要素も含まれています。
なんらかの理由でリクエストが失敗した場合、Blogger から別のステータス コードが返されることがあります。ステータス コードの詳細については、Google Data API プロトコルのリファレンス ドキュメントをご覧ください。
ブログ投稿の下書きを作成する
下書きの投稿は一般公開の投稿と同じ方法で作成されますが、Entry
オブジェクトの draft
属性を設定する必要があります。上記のようなブログ投稿を下書きとして作成するには、ハイライト表示された行を追加します。
public static Entry createPost(GoogleService myService, String blogId, String title, String content, String userName, Boolean isDraft) throws ServiceException, IOException { // Create the entry to insert Entry myEntry = new Entry(); myEntry.setTitle(new PlainTextConstruct(title)); myEntry.setContent(new PlainTextConstruct(content)); myEntry.setDraft(isDraft); // Ask the service to insert the new entry URL postUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default"); return myService.insert(postUrl, myEntry); }
既存の下書きのブログ投稿を公開済みの投稿にするには、下書きの投稿を取得し、draft 属性を false に設定してから投稿を更新します。投稿の取得と更新については、次の 2 つのセクションで説明します。
投稿を取得する
以降のセクションでは、クエリ パラメータを使用する場合と使用しない場合で、ブログ投稿のリストを取得する方法について説明します。
認証なしで Blogger の公開フィードにクエリを実行できます。そのため、公開ブログから投稿を取得する前に、setUserCredentials
メソッドを呼び出す必要も、AuthSub 認証を行う必要もありません。
すべてのブログ投稿を取得しています
ユーザーの投稿を取得するには、ブログのメタフィードの取得に使用したのと同じ getFeed
メソッドを呼び出しますが、今回はブログ投稿フィードの URL を送信します。
public static void printAllPosts( GoogleService myService, String blogId) throws ServiceException, IOException { // Request the feed URL feedUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default"); Feed resultFeed = myService.getFeed(feedUrl, Feed.class); // Print the results System.out.println(resultFeed.getTitle().getPlainText()); for (int i = 0; i < resultFeed.getEntries().size(); i++) { Entry entry = resultFeed.getEntries().get(i); System.out.println("\t" + entry.getTitle().getPlainText()); } System.out.println(); }
クエリ パラメータを使用して投稿を取得する
Blogger Data API では、特定の期間に公開または更新されたブログ投稿など、指定した条件に一致する一連のエントリをリクエストできます。そのためには、Query
オブジェクトを作成して GoogleService.getQuery
メソッドに渡します。
たとえば、期間のクエリを送信するには、Query
オブジェクトの setPublishedMin
メソッドと setPublishedMax
メソッドを使用します。次のコード スニペットは、指定された開始時間から終了時間の間に公開された各ブログ投稿のタイトルを出力します。
public static void printDateRangeQueryResults( GoogleService myService, String blogId, DateTime startTime, DateTime endTime) throws ServiceException, IOException { // Create query and submit a request URL feedUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default"); Query myQuery = new Query(feedUrl); myQuery.setPublishedMin(startTime); myQuery.setPublishedMax(endTime); Feed resultFeed = myService.query(myQuery, Feed.class); // Print the results System.out.println(resultFeed.getTitle().getPlainText() + " posts between " + startTime + " and " + endTime); for (int i = 0; i < resultFeed.getEntries().size(); i++) { Entry entry = resultFeed.getEntries().get(i); System.out.println("\t" + entry.getTitle().getPlainText()); System.out.println("\t" + entry.getUpdated().toStringRfc822()); } System.out.println(); }
Query
オブジェクトは、投稿の取得に使用するのと同じ投稿フィードの URL を使用して作成されています。
Blogger Data API では、次の Query
メソッドがサポートされています。
- addCategoryFilter
- カテゴリ(ラベル)を指定して、フィード結果をフィルタリングします。たとえば、
http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie
は、Fritz
とLaurie
の両方のラベルを持つエントリを返します。 - setMaxResults
- 返されるエントリの最大数を設定します。
- setPublishedMin、setPublishedMax
- エントリの公開日の範囲を設定します。
- setStartIndex
- (ページング用に)最初に取得する結果の 1 から始まるインデックスを設定します。
- setUpdatedMin、setUpdatedMax
- エントリの更新期限を設定します。
orderby
パラメータがupdated
に設定されていない限り、これらのクエリ パラメータは無視されます。
注: 現在、orderby
クエリ パラメータのセッターはありません。ただし、必要に応じて Query.addCustomParameter()
メソッドを使用できます。
クエリ パラメータの詳細については、Blogger Data API リファレンス ガイドと Google Data API リファレンス ガイドをご覧ください。
投稿を更新しています
既存のブログ投稿を更新するには、まず更新するエントリを取得してから変更し、update
メソッドを使用して Blogger に送信します。次のコード スニペットは、すでにサーバーからブログエントリを取得していると仮定して、ブログエントリのタイトルを変更します。
public static Entry updatePostTitle( GoogleService myService, Entry entryToUpdate, String newTitle) throws ServiceException, IOException { entryToUpdate.setTitle(new PlainTextConstruct(newTitle)); URL editUrl = new URL(entryToUpdate.getEditLink().getHref()); return myService.update(editUrl, entryToUpdate); }
上記のコードは、新しく更新された投稿全体を含む Entry
を返します。その他のプロパティを更新するには、update
を呼び出す前に Entry
オブジェクト内で設定します。
注: 現在のところ、投稿に関連付けられている作成者データの変更はサポートされていません。
投稿を削除しています
投稿を削除するには、次のように投稿の編集 URL を GoogleService
オブジェクトの delete
メソッドに渡します。
public static void deletePost( GoogleService myService, String editLinkHref) throws ServiceException, IOException { URL deleteUrl = new URL(editLinkHref); myService.delete(deleteUrl); }
コメント
Blogger Data API を使用すると、コメントの作成、取得、削除ができます。 コメントの更新はサポートされていません(ウェブ インターフェースでは利用できません)。
コメントの作成
コメントを投稿するには、Entry
オブジェクトを作成し、次のように挿入します。
public static Entry createComment( GoogleService myService, String blogID, String postId, String commentText) throws ServiceException, IOException { // Build the comment feed URI String commentsFeedUri = "http://www.blogger.com/feeds/" + blogID + "/" + postId + "/comments/default"; URL feedUrl = new URL(commentsFeedUri); // Create a new entry for the comment and submit it to the GoogleService Entry myEntry = new Entry(); myEntry.setContent(new PlainTextConstruct(commentText)); return myService.insert(feedUrl, myEntry); }
注: 現在、コメントを投稿できるのは、認証されたユーザーが所有するブログのみです。
注: 現在のところ、コメントにカスタムの作成者を設定することはできません。すべての新しいコメントは、現在認証されているユーザーによって作成されたかのように表示されます。
コメントの取得
特定の投稿のコメントは、投稿のコメント フィードの URL から取得できます。
public static void printAllComments( GoogleService myService, String blogID, String postId) throws ServiceException, IOException { // Build comment feed URI and request comments on the specified post String commentsFeedUri = "http://www.blogger.com/feeds/" + blogID + "/" + postId + "/comments/default"; URL feedUrl = new URL(commentsFeedUri); Feed resultFeed = myService.getFeed(feedUrl, Feed.class); // Display the results System.out.println(resultFeed.getTitle().getPlainText()); for (int i = 0; i < resultFeed.getEntries().size(); i++) { Entry entry = resultFeed.getEntries().get(i); System.out.println("\t" + ((TextContent) entry.getContent()).getContent().getPlainText()); System.out.println("\t" + entry.getUpdated().toStringRfc822()); } System.out.println(); }
または、ブログのコメント フィードの URL を使用して、すべての投稿のコメントを取得できます。
http://www.blogger.com/feeds/blogID/comments/default
コメントの削除
コメントを削除するには、次のようにコメントの編集 URL を GoogleService
オブジェクトの delete
メソッドに渡します。
public static void deleteComment(GoogleService myService, String editLinkHref) throws ServiceException, IOException { URL deleteUrl = new URL(editLinkHref); myService.delete(deleteUrl); }