重要事項:這是舊版頁面。如要取得最新版本,請使用左側導覽列中的連結。
Blogger Data API 可讓用戶端應用程式查看及更新 Google Data API 資訊提供形式的 Blogger 內容。
您的用戶端應用程式可以使用 Blogger Data API 建立新網誌文章、編輯或刪除現有網誌文章,以及查詢符合特定條件的網誌文章。
除了提供 Blogger Data API 功能的部分背景資訊外,本文件也提供使用原始 XML 和 HTTP 進行基本 Data API 互動的範例。閱讀本文件後,建議您閱讀本開發人員指南中的程式設計語言相關章節,進一步瞭解使用用戶端程式庫與 API 互動的方法。
目錄
觀眾
本文件的適用對象為想使用 XML 和 HTTP 編寫用戶端應用程式,以便與 Blogger 互動的程式設計人員。
本文假設您已瞭解 Google Data API 通訊協定背後的一般概念。
如果使用 UNIX 系統,並且想要在不編寫任何程式碼的情況下試用本文件中的範例,您可能會使用 UNIX 指令列公用程式 curl
或 wget
很有用;詳情請參閱這些公用程式的手冊頁面。
如需 Blogger Data API 參考資訊,請參閱通訊協定參考指南。
開始使用
建立 Blogger 帳戶
你可以註冊 Blogger 帳戶,以便進行測試。Blogger 會使用 Google 帳戶,因此如果您已經有 Google 帳戶,就大功告成了。
驗證 Blogger 服務
您可以使用 Blogger Data API 存取公開和私人動態消息。 公開動態消息不需驗證,但目前處於唯讀狀態。如要修改網誌,則客戶必須先完成驗證,才能要求私人動態消息。您可使用以下兩種方式進行驗證:AuthSub Proxy 驗證或 ClientLogin 使用者名稱/密碼驗證。
如要進一步瞭解 Google Data API 驗證的一般資訊,請參閱驗證說明文件。
本文件後續章節中的大多數範例都假設您提供適當的驗證資訊。
AuthSub Proxy 驗證
需要向 Google 帳戶驗證使用者的網頁應用程式會使用 AuthSub Proxy 驗證。網站營運商和用戶端程式碼無法存取 Blogger 使用者的使用者名稱和密碼,而用戶端會取得特殊的 AuthSub 權杖,讓用戶端代表特定使用者執行動作。詳情請參閱 AuthSub 說明文件。
使用者首次造訪應用程式時,他們尚未通過驗證。在這種情況下,您必須顯示一些資訊,以及可將使用者導向 Google 頁面的連結,以便驗證您對於網誌的存取權。
AuthSubRequest 網址包含下列查詢參數:
- 下一張
- Google 應在驗證後將使用者重新導向的網頁網址。
- 範圍
- 表示應用程式正在要求存取 Blogger 動態消息的憑證。要使用的範圍字串是
http://www.blogger.com/feeds/
(當然,網址經過編碼)。 - 安全
- 指出用戶端是否要求安全權杖。
- 工作階段
- 指出是否能將傳回的權杖換成多用途 (工作階段) 權杖。
AuthSubRequest 網址可能如下所示:
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=1
,因此可在 Authorization 標頭中使用單一使用憑證呼叫 AuthSubSessionToken
服務,以交換這個權杖,如下所示:
GET /accounts/AuthSubSessionToken HTTP/1.1 Content-Type: application/x-www-form-urlencoded Authorization: AuthSub token="yourAuthToken" User-Agent: Java/1.5.0_06 Host: www.google.com Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2 Connection: keep-alive
AuthSubSessionToken 服務回應包含包含工作階段符記的 Token
標頭,以及表示權杖保持有效時間的 Expiration
標頭。
這樣一來,應用程式就能在後續與 Blogger 互動時,在 Authorization
標頭中使用工作階段符記值。
以下是 HTTP 要求的範例,其中包含非安全權杖,您可能需要傳送至 Blogger:
GET /feeds/blogID/blogs/posts/defaults HTTP/1.1 Content-Type: application/x-www-form-urlencoded Authorization: AuthSub token="yourSessionToken" User-Agent: Java/1.5.0_06 Host: www.blogger.com Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2 Connection: keep-alive
ClientLogin 使用者名稱/密碼驗證
如果您的用戶端是獨立的單一使用者「安裝」用戶端 (例如桌面應用程式),請使用 ClientLogin 驗證。如要使用 ClientLogin 機制要求驗證權杖,請傳送 POST
要求至下列網址:
https://www.google.com/accounts/ClientLogin
POST
主體應包含一組查詢參數,看起來與 HTML 表單傳遞的參數類似,且該參數使用 application/x-www-form-urlencoded
內容類型。這些參數如下:
- 電子郵件
- 使用者的電子郵件地址。
- Passwd
- 使用者的密碼。
- 服務
- Blogger 服務名稱為
blogger
。(對於其他服務名稱,請參閱服務名稱清單)。 - accountType
- 使用 Blogger API 時,應一律設為
GOOGLE
。如果沒有設定這個參數,擁有 G Suite 帳戶的使用者就無法存取此參數。 - 來源
- 識別你的用戶端應用程式。格式應為 companyName-applicationName-versionID。範例使用的名稱是
exampleCo-exampleApp-1
。
如要進一步瞭解參數,請參閱已安裝應用程式的驗證文件。
如果驗證要求失敗,伺服器會傳回 HTTP 403 Forbidden
狀態碼。
如果成功,伺服器會傳回 HTTP 200 OK
狀態碼,並在回應內文中加入三個長的英數字元代碼:SID、LSID 和 Auth。驗證值是您在每次要求時傳送給 Blogger 的授權權杖,因此請保留該值的副本。您可以忽略 SID 和 LSID 值。
由於所有私人動態饋給的要求都需要經過驗證,因此您必須在所有後續與 Blogger 互動時,使用以下格式設定 Authorization 標頭:
Authorization: GoogleLogin auth=yourAuthToken
其中 yourAuthToken
是 ClientLogin 要求傳回的驗證字串。
如要進一步瞭解 ClientLogin 驗證,包括要求與回應範例,請參閱安裝版應用程式的驗證說明文件。
注意:針對特定工作階段中的所有要求使用相同符記;不要為每個 Blogger 要求取得新符記。
注意:如 ClientLogin 說明文件所述,驗證要求可能會失敗,並要求進行人機驗證 (CAPTCHA) 驗證問題。如要讓 Google 發出並處理人機驗證 (CAPTCHA) 驗證問題,請將使用者傳送至 https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger
(而不是用戶端登入說明文件中的人機驗證 (CAPTCHA) 處理網址)。
擷取網誌清單
Blogger Data API 提供的資訊提供會列出特定使用者的網誌;該資訊提供稱為「中繼資訊提供」。
將 HTTP GET
傳送至下列網址以擷取網誌清單:
http://www.blogger.com/feeds/userID/blogs
注意:您也可以將使用者 ID 替換成 default
,讓 Blogger 針對要求隨附的使用者憑證傳回網誌清單。
中繼資訊提供中的項目看起來可能像這樣:
<entry> <id>tag:blogger.com,1999:blog-blogID.post-postID</id> <published>2006-08-02T18:44:43.089-07:00</published> <updated>2006-11-08T18:10:23.020-08:00</updated> <title type='text'>Lizzy's Diary</title> <summary type='html'>Being the journal of Elizabeth Bennet</summary> <link rel='alternate' type='text/html' href='http://blogName.blogspot.com/'> </link> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='http://blogName.blogspot.com/feeds/posts/default'> </link> <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='http://www.blogger.com/feeds/blogID/posts/default'> </link> <link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/userID/blogs/blogID'> </link> <link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/userID/blogs/blogID'> </link> <author> <name>Elizabeth Bennet</name> <email>noreply@blogger.com</email> <uri>http://www.blogger.com/profile/profileID</uri> </author> </entry>
如要進一步瞭解這些元素代表的意義,請參閱 Google Data API 通訊協定參考資料文件或 Atom 1.0 規格。
如果因為某些原因導致你的要求失敗,Blogger 可能會傳回不同的狀態碼。如要進一步瞭解 HTTP 狀態碼,請參閱 Google Data API 通訊協定參考資料文件。
正在建立貼文
Blogger Data API 可讓您建立與發布新的網誌項目,以及建立項目草稿。
發布網誌文章
驗證後即可發布新的網誌項目。
首先,請建立要發布貼文的 XML 表示法。這個 XML 必須採用 Atom <entry>
元素的形式,如下所示:
<entry xmlns='http://www.w3.org/2005/Atom'> <title type='text'>Marriage!</title> <content type='xhtml'> <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> </content> <category scheme="http://www.blogger.com/atom/ns#" term="marriage" /> <category scheme="http://www.blogger.com/atom/ns#" term="Mr. Darcy" /> </entry>
注意:目前不支援為貼文設定自訂作者。所有新貼文都會顯示為目前已驗證使用者建立的訊息。
如要發布這個項目,請將這個項目傳送到網誌的文章網址,如下所示。首先,使用 application/atom+xml
內容類型,將 Atom <entry>
元素放在新 POST
要求的內文中。接著,找出 <link>
元素 (其中 rel
屬性結尾為 #post
的項目),在中繼動態消息中找出網誌的文章網址。網誌的文章網址會是此元素的 href
屬性,格式如下:
http://www.blogger.com/feeds/blogID/posts/default
注意:這個網址與使用者可閱讀的網誌版本 <head>
部分中顯示的 <link rel="service.post">
標記網址相同。
Blogger 會使用您傳送的項目建立網誌文章,然後傳回 HTTP 201 CREATED
狀態碼,以及 <entry>
元素形式的新文章副本。傳回的項目與您傳送的項目相同,但包含 Blogger 新增的各種元素,例如 <id>
元素。
如果因為某些原因導致你的要求失敗,Blogger 可能會傳回不同的狀態碼。如需狀態碼的相關資訊,請參閱 Google Data API 通訊協定參考文件。
建立網誌文章草稿
草稿貼文的建立方式與公開貼文相同,但會在項目中加入 <app:control>
元素,指出貼文目前不應發布。
這個 <app:control>
元素應包含單一 <app:draft>
元素做為子項:
<app:control xmlns:app='http://purl.org/atom/app#'> <app:draft>yes</app:draft> </app:control>
<app:draft>
元素所含的資料必須是 yes 字串,才能讓系統將貼文視為草稿。
您可以擷取草稿貼文,將 <app:draft>
元素的資料設為 no 字串,然後更新文章,藉此將現有的網誌文章草稿轉換為已發布的文章。以下兩節將說明擷取與更新貼文的做法。
注意:如要進一步瞭解 Atom 發布通訊協定 (包括 <app:control>
和 <app:draft>
命名空間),請參閱 RFC 5023。
正在擷取訊息
以下各節說明如何擷取包含和不含查詢參數的網誌文章清單。
您不需要驗證即可查詢 Blogger 公開動態消息。因此,從公開網誌擷取網誌文章時,您不需要設定授權參數。
擷取所有網誌文章
如要擷取使用者的文章,請傳送 HTTP GET
要求至網誌的動態消息網址。接著,Blogger 會傳回包含適當網誌內容的資訊提供。舉例來說,如要取得 liz@gmail.com 的網誌文章清單,請將下列 HTTP 要求傳送至 Blogger (當然,應以適當的值取代 blogID
):
GET http://www.blogger.com/feeds/blogID/posts/default
接著,Blogger 會傳回 HTTP 200 OK
狀態碼,以及包含網誌文章的標準 Atom 1.0 動態饋給。
以下是僅有一篇文章的網誌動態消息範例。請注意,我們已將這個範例稍微修改,使其更容易理解。特別是,實際的 Blogger 資訊提供包含實際 ID 和網址。
<feed xmlns='http://www.w3.org/2005/Atom'> <id>tag:blogger.com,1999:blog-blogID</id> <updated>2006-11-08T18:10:23.020-08:00</updated> <title type='text'>Lizzy's Diary</title> <link rel='alternate' type='text/html' href='http://blogName.blogspot.com/index.html'> </link> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='http://blogName.blogspot.com/feeds/posts/default'> </link> <link rel='self' type='application/atom+xml' href='http://blogName.blogspot.com/feeds/posts/default'> </link> <author> <name>Elizabeth Bennet</name> <email>noreply@blogger.com</email> <uri>http://www.blogger.com/profile/profileID</uri> </author> <generator version='7.00' uri='http://www2.blogger.com'>Blogger</generator> <entry> <id>tag:blogger.com,1999:blog-blogID.post-postID</id> <published>2006-11-08T18:10:00.000-08:00</published> <updated>2006-11-08T18:10:14.954-08:00</updated> <title type='text'>Quite disagreeable</title> <content type='html'><p>I met Mr. Bingley's friend Mr. Darcy this evening. I found him quite disagreeable.</p></content> <link rel='alternate' type='text/html' href='http://blogName.blogspot.com/2006/11/quite-disagreeable.html'> </link> <link rel='self' type='application/atom+xml' href='http://blogName.blogspot.com/feeds/posts/default/postID'> </link> <link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/blogID/posts/default/postID'> </link> <author> <name>Elizabeth Bennet</name> <email>noreply@blogger.com</email> <uri>http://www.blogger.com/profile/profileID</uri> </author> </entry> </feed>
使用查詢參數擷取貼文
Blogger Data API 可讓您要求一組符合特定條件的項目,例如要求在指定日期範圍內發布或更新的網誌文章。
舉例來說,如要傳送日期範圍查詢,請在要求網址中加入 published-min
和 published-max
參數。如要取得 2008 年 3 月 16 日至 2008 年 3 月 24 日期間建立的所有網誌項目,請傳送 HTTP 要求到網誌的動態消息網址:
GET http://www.blogger.com/feeds/blogID/posts/default?published-min=2008-03-16T00:00:00&published-max=2008-03-24T23:59:59
當您傳送該 GET
要求時,Blogger 會傳回 HTTP 200 OK
狀態碼,以及包含在指定日期範圍內建立的網誌文章的動態消息。
updated-min
和 updated-max
參數也可以用來取得指定範圍內更新的所有網誌項目。不過請注意,除非 orderby
參數也設為 updated
,否則系統會忽略這些參數。
Blogger Data API 支援下列查詢參數:
- alt
- 要傳回的動態饋給類型,例如
atom
(預設) 或rss
。 - /category
- 指定類別 (也稱為標籤) 來篩選動態饋給結果。舉例來說,
http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie
會傳回同時具有Fritz
和Laurie
標籤的項目。 - max-results
- 要傳回的項目數量上限。
- 訂單比
- 傳回項目的順序,例如
lastmodified
(預設值)、starttime
或updated
。 - Publishing-min、publish-max
- 項目出版日期的邊界,
- start-index
- 要擷取的第一個結果的 1 式索引 (用於分頁)。
- update-min、update-max
- 項目更新日期的範圍,除非
orderby
參數設為updated
,否則系統會忽略這些查詢參數。
如要進一步瞭解查詢參數,請參閱 Blogger Data API 參考指南和 Google Data API 參考指南。
更新訊息
如要更新現有的網誌文章,請先擷取要更新的項目,然後進行修改,接著傳送 PUT
要求 (訊息內文中的更新項目) 至文章的編輯網址。確認 PUT
項目的 <id>
值與現有項目的 <id>
完全相符。
編輯網址會在下列項目中醒目顯示:
<entry> <id>tag:blogger.com,1999:blog-blogID.post-postID</id> <published>2006-11-08T18:10:00.000-08:00</published> <updated>2006-11-08T18:10:14.954-08:00</updated> <title type='text'>Quite disagreeable</title> <content type='html'><p>I met Mr. Bingley's friend Mr. Darcy this evening. I found him quite disagreeable.</p></content> <link rel='alternate' type='text/html' href='http://blogName.blogspot.com/2006/11/quite-disagreeable.html'> </link> <link rel='self' type='application/atom+xml' href='http://blogName.blogspot.com/feeds/posts/default/postID'> </link> <link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/blogID/posts/default/postID'> </link> <category scheme="http://www.blogger.com/atom/ns#" term="Mr. Bingley" /> <category scheme="http://www.blogger.com/atom/ns#" term="Mr. Darcy" /> <author> <name>Elizabeth Bennet</name> <email>noreply@blogger.com</email> <uri>http://www.blogger.com/profile/profileID</uri> </author> </entry>
重要事項:為確保前瞻相容性,請在 PUT
更新項目時保留「所有」從 Blogger 擷取項目時呈現的 XML。否則,當我們實作新功能並在動態饋給中加入 <new-awesome-feature>
元素時,您的用戶端就不會傳回這些元素,而使用者也會遺漏這些元素。Google Data API 用戶端程式庫全部都能正確處理此作業,因此如果您使用的其中一個程式庫已設定妥當。
注意:目前不支援修改與貼文相關聯的作者資料。
疑難排解提示:部分防火牆會封鎖 HTTP PUT
訊息。如要解決這個問題,您可以在 POST
要求中加入 X-HTTP-Method-Override: PUT
標頭。詳情請參閱 Google Data API 通訊協定基本知識文件。
刪除訊息
如要刪除貼文,請傳送 DELETE
要求至貼文的編輯網址。
這個網址與用於更新貼文的網址相同。
疑難排解提示:部分防火牆會封鎖 HTTP DELETE
訊息。如要解決這個問題,您可以在 POST
要求中加入 X-HTTP-Method-Override: DELETE
標頭。詳情請參閱 Google Data API 通訊協定基本知識文件。
註解
Blogger Data API 可讓您建立、擷取及刪除留言。 不支援更新註解 (且不支援在網路介面上更新註解)。
正在建立留言
如要張貼留言,請建立 Atom <entry>
元素,如下所示:
<entry xmlns='http://www.w3.org/2005/Atom'> <title type="text">This is my first comment</title> <content type="html">This is my first comment</content> </entry>
如要發布這則註解,請使用 application/atom+xml
內容類型,將 Atom <entry>
元素放入新 POST
要求的內文中。接著,將 POST
要求傳送至適當的 Blogger 網址:
POST http://www.blogger.com/feeds/blogID/postID/comments/default
注意:您目前只能將留言張貼至通過驗證的使用者所擁有的網誌。
注意:目前不支援為留言設定自訂作者。所有新留言會顯示為目前已驗證使用者建立的留言。
正在擷取註解
如要擷取特定貼文的留言,請將 GET
傳送至這篇文章的留言動態消息網址:
GET http://www.blogger.com/feeds/blogID/postID/comments/default
或者,您也可以使用網誌的留言動態消息網址取得所有文章的留言:
GET http://www.blogger.com/feeds/blogID/comments/default
這些要求會傳回如下的留言動態饋給:
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/" xmlns:thr="http://purl.org/syndication/thread/1.0"> <id>tag:blogger.com,1999:blog-blogID.post-postID.comment-commentID</id> <updated>2007-04-04T21:56:29.803-07:00</updated> <title type="text">My Blog : Time to relax</title> <link rel="alternate" type="text/html" href="http://blogName.blogspot.com/2007/04/first-post.html"/> <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="http://blogName.blogspot.com/feeds/postID/comments/default"/> <link rel="self" type="application/atom+xml" href="http://blogName.blogspot.com/feeds/postID/comments/default"/> <author> <name>Blog Author name</name> </author> <generator version="7.00" uri="http://www2.blogger.com">Blogger</generator> <openSearch:totalResults>1</openSearch:totalResults> <openSearch:startIndex>1</openSearch:startIndex> <entry> <id>tag:blogger.com,1999:blog-blogID.post-commentID</id> <published>2007-04-04T21:56:00.000-07:00</published> <updated>2007-04-04T21:56:29.803-07:00</updated> <title type="text">This is my first comment</title> <content type="html">This is my first comment</content> <link rel="alternate" type="text/html" href="http://blogName.blogspot.com/2007/04/first-post.html#commentID"/> <link rel="self" type="application/atom+xml" href="http://blogName.blogspot.com/feeds/postID/comments/default/commentID"/> <link rel="edit" type="application/atom+xml" href="http://www.blogger.com/feeds/blogID/postID/comments/default/commentID"/> <thr:in-reply-to href="http://blogName.blogspot.com/2007/04/first-post.html" ref="tag:blogger.com,1999:blog-blogID.post-postID" source="http://www.blogger.com/feeds/posts/default/blogID" type="text/html"/> <author> <name>Blog Author name</name> <email>blog_author@gmail.com</email> <uri>http://www.blogger.com/profile/userID</uri> </author> <thr:in-reply-to xmlns:thr='http://purl.org/syndication/thread/1.0' href='http://blogName.blogspot.com/2007/04/first-post.html' ref='tag:blogger.com,1999:blog-blogID.post-postID' source='http://blogName.blogspot.com/feeds/posts/default/postID' type='text/html' /> </entry> </feed>
正在刪除留言
如要刪除註解,請傳送 DELETE
要求至註解的編輯網址。上方留言動態饋給會醒目顯示這個網址。
匯出格式
Blogger 可讓使用者透過 Blogger 匯出檔案匯出及匯入網誌。這個匯出檔案包含單一網誌的所有文章和留言。匯出檔案的格式與擷取貼文和留言的章節中所述的 Atom 格式完全相同。這個匯出檔案會包含貼文動態饋給的內容,以及留言動態饋給的內容合併成一份文件。
如要使用匯出格式匯出或匯入網誌資料,請前往網誌的「設定」頁面。如要使用 Data API 擷取網誌的匯出檔案,請使用下列網址:
GET http://www.blogger.com/feeds/blogID/archive
如要匯入匯出檔案,請為下列網址建立 POST
要求,並將匯出檔案的內容做為要求資料,並將 application/atom+xml
設為內容類型:
POST http://www.blogger.com/feeds/blogID/archive/full
上述任一網址都不支援查詢參數。這兩項要求都必須包含驗證資訊,且只有網誌管理員可以使用這些動態饋給網址匯入/匯出網誌。
注意:如果您要建立自己的 Blogger 匯出檔案,目前系統對文章和留言項目的順序有一項限制。Blogger 匯出檔案會先列出所有文章 然後再列出所有留言只要留言項目位於留言發布的位置之後,就可以交互顯示貼文與留言項目。
如要進一步瞭解 Blogger 如何在匯出檔案中使用 Atom 格式,請參閱通訊協定參考指南。