開發人員指南:.NET

重要事項:這是舊版的舊版頁面。如需最新版本,請使用左側導覽列中的連結。

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

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

除了提供 Blogger Data API 功能的背景外,本文件也提供了使用 .NET 用戶端程式庫的基本 Data API 互動範例。如要進一步瞭解程式庫使用的基本通訊協定,請參閱本開發人員指南的通訊協定部分

目錄

觀眾

本文件的適用對象,是想編寫可與 Blogger 互動的 .NET 用戶端應用程式。

本文假設您瞭解 Google Data API 通訊協定的一般概念。

如要進一步瞭解用戶端程式庫提供的類別和方法,請參閱 .NET 用戶端程式庫 API 參考資料。如需一般 Blogger Data API 參考資料資訊,請參閱通訊協定參考資料指南

開始

如需設定用戶端程式庫的相關說明,請參閱入門指南

如要使用 .NET 用戶端程式庫,您需要 .NET 1.1 執行階段,此外也應適用於所有修補程式。下載用戶端程式庫後,即可開始使用發布的 lib/Release 子目錄,開始使用所需的 DLL。

建立 Blogger 帳戶

如要進行測試,建議您註冊 Blogger 帳戶。Blogger 會使用 Google 帳戶,因此如果您已經有 Google 帳戶,就表示大功告成。

執行程式碼範例

.NET 用戶端程式庫專案中的所有專案 (包括本文件中列出的所有程式碼範例) 都具備完整運作的範例。您可以在 SVN 存放區的「Source」分頁中找到範例 (位於 /中繼/clients/cs/samples/blogger/ConsoleSample.cs)。

在編譯和執行這個範例之前,請將 usernamepasswordblogNamepostId 的值更新為適當的值。usernamepassword 值代表用來登入 Blogger 的憑證。blogName 值是網誌的網誌文章開頭。

範例用戶端會在提供的網誌上執行多項作業,示範 Blogger Data API 的使用方式。

如要將本文件中的範例編譯到您自己的程式碼,您需要下列 using 陳述式:

using Google.GData.Client;
using System.Net;
using System.Xml;
using System.Text.RegularExpressions;

驗證 Blogger 服務

使用 Blogger Data API 就能存取公開和私人的動態消息。 公開動態饋給不需要驗證,但處於唯讀狀態。如要修改網誌,則用戶端必須先進行驗證,才能要求私人動態饋給。身分驗證方式有兩種:AuthSub Proxy 驗證或 ClientLogin 使用者名稱/密碼驗證。

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

AuthSub Proxy 驗證

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

使用者第一次造訪您的應用程式時,尚未通過驗證。在這種情況下,您必須顯示某些資訊,以及透過連結將使用者帶往 Google 頁面的連結,以便我們驗證您的網誌存取要求。

假設網頁中定義了下列 ASP 超連結:

<asp:HyperLink ID="GotoAuthSubLink" runat="server"/>

如要為應用程式建構 AuthSubRequest 網址,請發出 .NET 用戶端程式庫呼叫,如下所示:

GotoAuthSubLink.Text = "Login to your Google Account";
GotoAuthSubLink.NavigateUrl =
  AuthSubUtil.getRequestUrl("http://www.example.com/RetrieveToken",
  "http://www.blogger.com/feeds/",
  false,
  true);

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%2FRetrieveToken

使用者點選 Google 網站的連結並驗證自己的 Google 帳戶。

使用者驗證完成後,AuthSub 系統會將使用者重新導向至 AuthSubRequest 網址的 next 查詢參數中指定的網址。AuthSub 系統會將驗證權杖附加至該網址,做為 token 查詢參數的值。因此,這個權杖可在 ASP 網頁的 Request.QueryString 物件中以變數的形式存取。系統會將使用者重新導向至類似的網址:

http://www.example.com/RetrieveToken?token=yourAuthToken

這個權杖值代表一次性的 AuthSub 權杖。在本範例中,由於指定 session = true,因此這個權杖可順利用於 AuthSub 工作階段符記,如下所示:

SessionsessionToken = AuthSubUtil.exchangeForSessionToken(Request.QueryStringtoken, null);

也就是說,您可以將一次性一次性權杖傳送至 exchangeForSessionToken 方法,同時搭配 null (未註冊模式) 或私密金鑰 (適用於註冊模式),且 AuthSub 介面會傳回工作階段符記。如要進一步瞭解已註冊的應用程式和私密金鑰,請參閱 AuthSub 說明文件的「簽署要求」一節。

之後,您的應用程式即可在後續與 Blogger 的互動中使用工作階段符記值。如要告知 .NET 用戶端程式庫在每個要求中自動傳送 Authorization 標頭 (包含工作階段符記),請按照下列指示操作:

GAuthSubRequestFactory authFactory = new GAuthSubRequestFactory("blogger", "BloggerSampleApp");
authFactory.Token = SessionsessionToken.ToString();
Service service = new Service(authFactory.ApplicationName);
service.RequestFactory = authFactory;

ClientLogin 使用者名稱/密碼驗證

如果您的用戶端是獨立的單一使用者「已安裝」用戶端 (例如電腦版應用程式),請使用 ClientLogin 驗證。請按照下列方式設定服務物件的憑證:

Service service = new Service("blogger", "exampleCo-exampleApp-1");
service.Credentials = new GDataCredentials("user@example.com", "secretPassword");
GDataGAuthRequestFactory factory = (GDataGAuthRequestFactory) service.RequestFactory;
factory.AccountType = "GOOGLE";

在上方的程式碼片段中,我們會將兩個參數傳遞至 Service 建構函式。第一個參數是我們要互動的服務名稱,第二個參數是應用程式名稱,格式為 companyName-applicationName-versionID。此外,Service.RequestFactory 也設定為僅使用 GOOGLE 帳戶類型,以便為 G Suite 使用者進行適當的驗證。

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

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

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

擷取網誌清單

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

下列程式碼範例使用已驗證的 Service 物件來擷取中繼動態饋給,然後列印每個網誌的標題。

query.Uri = new Uri("http://www.blogger.com/feeds/default/blogs");
AtomFeed feed = null;
try
{
  feed = service.Query(query);
  foreach (AtomEntry entry in feed.Entries)
  {
    Console.WriteLine("Blog Title: " + entry.Title.Text);
  }
}

記下 getFeed 方法使用的網址。這是預設的中繼動態饋給網址,會傳回目前已驗證使用者的網誌清單。如要存取其他使用者的動態饋給,請在中繼動態饋給網址中以使用者的 ID 取代 default。使用者的 ID 是使用者個人資料網址結尾的數字字串。

建立貼文

Blogger Data API 可讓您建立及發布新的網誌項目,以及建立項目草稿。

下列所有範例均假設您有通過驗證的 Service 物件。

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

發布網誌文章

您可以使用 .NET 用戶端程式庫發布新的網誌項目。

首先,請建立 AtomEntry 物件來代表網誌文章。然後設定網誌文章的標題、內容和其他屬性。 最後,使用 Service 物件插入貼文。以下說明如何發布新網誌文章:

AtomEntry newPost = new AtomEntry();
newPost.Title.Text = "Marriage!";
newPost.Content = new AtomContent();
newPost.Content.Content = "<div xmlns='http://www.w3.org/1999/xhtml'>" +
  "<p>Mr. Darcy has <em>proposed marriage</em> to me!</p>" +
  "<p>He is the last man on earth I would ever desire to marry.</p>" +
  "<p>Whatever shall I do?</p>" +
  "</div>";
newPost.Content.Type = "xhtml";

Uri blogFeedUri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
AtomEntry createdEntry = service.Insert(blogFeedUri, newPost);

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

如果因為某些原因導致要求失敗,Blogger 可能會傳回不同的狀態碼。如需狀態碼的相關資訊,請參閱 Google Data API 通訊協定參考文件

建立網誌文章草稿

草稿草稿的建立方式與公開貼文相同,但您必須設定 AtomEntry 物件的 draft 屬性。您可以新增醒目顯示的那一行,將上述網誌文章儲存為草稿:

AtomEntry newPost = new AtomEntry();
newPost.Title.Text = "Marriage!";
newPost.Content = new AtomContent();
newPost.Content.Content = "<div xmlns='http://www.w3.org/1999/xhtml'>" +
    "<p>Mr. Darcy has <em>proposed marriage</em> to me!</p>" +
    "<p>He is the last man on earth I would ever desire to marry.</p>" +
    "<p>Whatever shall I do?</p>" +
    "</div>";
newPost.Content.Type = "xhtml";
newPost.IsDraft = true;

Uri blogFeedUri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
AtomEntry createdEntry = service.Insert(blogFeedUri, newPost);

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

擷取貼文

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

您不必驗證就能查詢 Blogger 公開動態饋給。因此,在從公開網誌擷取貼文之前,您不需要設定憑證或進行 AuthSub 驗證。

擷取所有網誌文章

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

query.Uri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
feed = service.Query(query);
Console.WriteLine(feed.Title.Text);
foreach (AtomEntry entry in feed.Entries)
{
  Console.WriteLine("Entry Title: " + entry.Title.Text);
}

使用查詢參數擷取貼文

Blogger Data API 可讓您要求一組與指定條件相符的項目,例如要求在指定日期範圍內發布或更新的網誌文章。方法是建立 FeedQuery 物件,並將該物件傳送到 Service.Query() 方法。

舉例來說,如要傳送日期範圍查詢,請設定 FeedQuery 物件的 MinPublicationMaxPublication 成員。 下列程式碼片段會列印在特定開始時間和結束時間之間發布的各篇網誌文章的標題:

FeedQuery query = new FeedQuery();
query.Uri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
query.MinPublication = new DateTime(2006, 1, 1);
query.MaxPublication = new DateTime(2007, 4, 12);
AtomFeed feed = service.Query(query);
foreach (AtomEntry entry in feed.Entries)
{
  Console.WriteLine("  Entry Title: " + entry.Title.Text);
}

請注意,FeedQuery 物件是以用於擷取貼文的相同貼文動態饋給網址建構。

Blogger Data API 支援下列查詢參數:

alt
要傳回的動態饋給類型,例如 atom (預設) 或 rss
/category
指定類別來篩選動態饋給結果。例如,http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie 會傳回同時包含 FritzLaurie 標籤的項目。
最大結果
要傳回的項目數量上限。
排序依據
傳回項目的順序,例如 lastmodified (預設值)、starttimeupdated
發布-分鐘,發布上限
項目發布日期的邊界。
起始索引
要擷取的第一個結果以 1 為基礎的索引 (用於分頁)。
updated-min, updated-max
項目更新日期的邊界。除非 orderby 參數設為 updated,否則系統會忽略這些查詢參數。

如要進一步瞭解查詢參數,請參閱 Blogger Data API 參考指南Google Data API 參考指南

正在更新貼文

如要更新現有的網誌文章,請先擷取您要更新的項目,然後加以修改,然後再使用項目的 Update() 方法,將資料傳送至 Blogger。下列程式碼片段會修改網誌項目的標題,假設您已經從伺服器擷取了項目。

static AtomEntry EditEntry(AtomEntry toEdit)
{
  // Edit the entry by changing the Title and calling Update().
  if (toEdit != null)
  {
    toEdit.Title.Text = "Marriage Woes!";
    toEdit = toEdit.Update();
  }
  return toEdit;
}

上述程式碼會傳回包含完整更新的貼文的 AtomEntry。如要更新任何其他屬性,只要在呼叫 Update() 之前,在 AtomEntry 物件中設定這些屬性即可。

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

刪除貼文

如要刪除貼文,請在現有的 AtomEntry 物件上呼叫 Delete 方法,如下所示:

static void DeleteEntry(AtomEntry toDelete)
{
  // Delete the edited entry
  if (toDelete != null)
  {
    toDelete.Delete();
  }
}

留言

Blogger Data API 可讓您建立、擷取及刪除留言。不支援更新註解 (或透過網頁介面提供註解)。

建立註解

如要發布留言,請建立 AtomEntry 物件並插入該物件,如下所示:

AtomEntry comment;
comment = new AtomEntry();
comment.Title.Text = "This is my first comment";
comment.Content.Content = "This is my first comment";
Uri commentPostUri = new Uri("http://www.blogger.com/feeds/" + blogId + "/" + entryId + "/comments/default");
postedComment = service.Insert(commentPostUri, comment);

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

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

擷取註解

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

static void ListEntryComments(Service service, Uri commentUri)
{
  if (commentUri != null)
  {
    // Retrieve all comments on a blog entry
    FeedQuery query = new FeedQuery();
    query.Uri = commentUri;
    AtomFeed feed = service.Query(query);
    foreach (AtomEntry entry in feed.Entries)
    {
      Console.WriteLine("  Comment Title: " + entry.Title.Text);
    }
  }
}

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

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

刪除留言

如要刪除註解,請在現有的註解 AtomEntry 物件上呼叫 Delete() 方法,如下所示:

static void DeleteComment(AtomEntry commentEntry)
{
  if (commentEntry != null)
  {
    // Delete the comment.
    commentEntry.Delete();
  }
}

返回頁首