開發人員指南：Java

Blogger Data API 可讓用戶端應用程式以 Google Data API 動態饋給的形式，查看及更新 Blogger 內容。

您的用戶端應用程式可以使用 Blogger Data API 建立新的網誌文章、編輯或刪除自己的網誌文章，以及查詢符合特定條件的網誌文章。

除了提供 Blogger Data API 功能的相關背景外，本文件也提供了使用 Java 用戶端程式庫的基本 Data API 互動範例。如果您想進一步瞭解程式庫使用的基礎通訊協定，請參閱這份開發人員指南的通訊協定部分。

目錄

1. 觀眾
2. 開始使用
   1. 建立 Blogger 帳戶
   2. 執行程式碼範例
3. 驗證 Blogger 服務
   1. OAuth 驗證
   2. AuthSub Proxy 驗證
   3. ClientLogin 使用者名稱/密碼驗證
4. 擷取網誌清單
5. 建立貼文
   1. 發布網誌文章
   2. 建立網誌文章草稿
6. 擷取貼文
   1. 擷取所有網誌文章
   2. 使用查詢參數擷取貼文
7. 更新貼文
8. 刪除貼文
9. 註解
   1. 建立留言
   2. 擷取留言
   3. 刪除留言

觀眾

本文件的適用對象，是想編寫可與 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 目錄下找到 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 就能存取公開和私人的動態消息。 公開動態饋給不需要驗證，但處於唯讀狀態。如要修改網誌，則用戶端必須先進行驗證，才能要求私人動態饋給。可以透過三種方式進行驗證：OAuth 驗證、AuthSub Proxy 驗證或 ClientLogin 使用者名稱/密碼驗證。

如要進一步瞭解如何使用 Google Data API 進行驗證，請參閱驗證說明文件。

在本文件的後續章節中，大部分範例假設您有通過驗證的 GoogleService 物件。

OAuth 驗證

如要瞭解如何使用 Java GData 程式庫執行 OAuth 驗證，請參閱 Google Data Protocol 用戶端程式庫中的 OAuth。

AuthSub Proxy 驗證

需要驗證使用者提供給 Google 帳戶的網頁應用程式會使用 AuthSub Proxy 驗證。網站運算子和用戶端代碼無法存取 Blogger 使用者的使用者名稱和密碼；用戶端則會取得特殊的 AuthSub 權杖，允許用戶端代表特定使用者採取行動。詳情請參閱 AuthSub 說明文件。

使用者第一次造訪您的應用程式時，尚未通過驗證。在這種情況下，您必須顯示某些資訊，以及透過連結將使用者帶往 Google 頁面的連結，以便我們驗證您的網誌存取要求。Java 用戶端程式庫提供一個函式可產生 Google 頁面的網址。下列程式碼會擷取 AuthSubRequest 頁面的網址：

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 會在驗證完成後將使用者重新導向至的網頁網址。

範圍

表示應用程式要求存取權杖，以便存取 Blogger 動態消息。要使用的範圍字串為 http://www.blogger.com/feeds/ (當然是網址編碼)。

安全

指出用戶端是否要求安全權杖。

工作階段

表示傳回的權杖是否可以用於多用途 (工作階段) 權杖。

以上範例顯示了未要求安全權杖的呼叫 (secure 的值為 false)，最終產生的網址看起來會像這樣：

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 網址的 next 查詢參數中指定的網址。AuthSub 系統會將驗證權杖附加至該網址，做為 token 查詢參數的值。例如：

http://www.example.com/welcome.html?token=yourAuthToken

這個權杖值代表一次性的 AuthSub 權杖。在此範例中，因為指定 session = true，所以您可以呼叫 AuthSubSessionToken 服務，將這個權杖交換至 AuthSub 工作階段符記，其中 urlFromAuthSub 是 AuthSub 附加權杖到的網址：

String token = AuthSubUtil.getTokenFromReply(urlFromAuthSub);
String sessionToken = AuthSubUtil.exchangeForSessionToken(token, null);

也就是說，您可以將一次性一次性權杖傳送至 exchangeForSessionToken 方法，同時搭配 null (未註冊模式) 或私密金鑰 (適用於註冊模式)，且 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("[e-mail]", "secretPassword");

在上方的程式碼片段中，我們會將兩個參數傳遞至 GoogleService 建構函式。第一個參數是我們要互動的服務名稱，第二個參數是應用程式名稱，格式為 companyName-applicationName-versionID。

如要進一步瞭解 ClientLogin 驗證，包括要求和回應範例，請參閱已安裝應用程式驗證說明文件。

注意：在特定工作階段中的所有要求都使用相同的權杖；請勿為各個 Blogger 要求取得新權杖。

注意：如「ClientLogin」說明文件中所述，驗證要求可能會失敗，並要求進行人機驗證 (Captcha) 驗證。如果您想讓 Google 發出及處理人機驗證 (Captcha) 驗證問題，請將使用者傳送至 https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger (而非 ClientLogin 說明文件中的人機驗證 (Captcha) 處理網址)。

擷取網誌清單

Blogger Data API 提供動態饋給，可列出特定使用者的網誌；該動態饋給稱為「metafeed」。

下列程式碼範例使用已驗證的 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 方法使用的網址。這是預設的中繼動態饋給網址，會傳回目前已驗證使用者的網誌清單。如要存取其他使用者的動態饋給，請在中繼動態饋給網址中以使用者的 ID 取代 default。使用者的 ID 是使用者個人資料網址結尾的數字字串。

建立貼文

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 方法會將服務的貼文網址做為參數。接著，這個方法會傳回 Blogger 儲存的項目。傳回的項目與您傳送的項目相同，但也包含 Blogger 新增的各種元素，例如文章 ID。

如果因為某些原因導致要求失敗，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);
}

將草稿的草稿擷取成文章、將草稿屬性設為 false，然後更新文章，即可將現有草稿網誌文章轉換成已發布的文章。我們將在接下來兩節中介紹如何擷取及更新貼文。

擷取貼文

下列各節說明如何擷取包含及不含查詢參數的網誌文章清單。

您不必驗證就能查詢 Blogger 公開動態饋給。因此，在從公開網誌擷取文章之前，您不需要呼叫 setUserCredentials 方法或進行 AuthSub 驗證。

擷取所有網誌文章

如要擷取使用者的貼文，請呼叫用來擷取網誌中繼動態饋給的 getFeed 方法，但這次要傳送網誌文章的動態消息網址：

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 物件是以用於擷取貼文的相同貼文動態饋給網址建構。

Blogger Data API 支援下列 Query 方法：

addCategoryFilter

指定類別來篩選動態饋給結果。例如，http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie 會傳回同時包含 Fritz 和 Laurie 標籤的項目。

setMaxResults

設定要傳回的項目數量上限。

setPublishMin、setPublishMax

設定項目發布日期的邊界。

setStartIndex

為要擷取的第一個結果設定以 1 為基礎的索引 (適用於分頁)。

setUpdatedMin、setUpdatedMax

設定項目更新日期的邊界。除非 orderby 參數設為 updated，否則系統會忽略這些查詢參數。

注意：orderby 查詢參數目前沒有 setter。不過，您還是可以使用 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 物件中設定這些屬性即可。

注意：目前無法修改與貼文相關的作者資料。

刪除貼文

如要刪除貼文，請將貼文的編輯網址傳遞至 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);
}

注意：目前你只能將留言張貼到由已驗證使用者擁有的網誌。

注意：目前不支援為留言設定自訂作者。所有新留言都會顯示為目前已驗證使用者所建立的留言。

擷取註解

您可以從貼文的留言動態饋給網址中擷取特定貼文的留言：

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();
}

或者，你可以使用網誌的留言動態饋給網址，接收所有貼文的留言：

http://www.blogger.com/feeds/blogID/comments/default

刪除留言

如要刪除註解，請將註解的編輯網址傳遞至 GoogleService 物件的 delete 方法，如下所示：

public static void deleteComment(GoogleService myService, String editLinkHref)
    throws ServiceException, IOException {
  URL deleteUrl = new URL(editLinkHref);
  myService.delete(deleteUrl);
}

返回頁首