開發人員指南：Java

重要事項：這是舊版頁面。如要取得最新版本，請使用左側導覽列中的連結。

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 Proxy 驗證或 ClientLogin 使用者名稱/密碼驗證。

如要進一步瞭解 Google Data API 驗證的一般資訊，請參閱驗證說明文件。

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

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

也就是說，將一次性權杖與 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 建構函式。第一個參數是我們要與其互動的服務名稱第二個參數是應用程式的名稱，格式為 companyName-applicationName-versionID。

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

注意：針對特定工作階段中的所有要求使用相同符記；不要為每個 Blogger 要求取得新符記。

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

擷取網誌清單

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 方法使用的網址。這是預設的中繼動態饋給網址，它會傳回目前已驗證使用者的網誌清單。如要存取其他使用者的動態消息，您可以在中繼動態饋給網址中，將使用者 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

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

setPublishedMin、setPublishedMax

設定項目出版日期的邊界。

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

返回頁首