Blogger Data API 可讓用戶端應用程式以 Google Data API 動態饋給的形式，查看及更新 Blogger 內容。
您的用戶端應用程式可以使用 Blogger Data API 建立新的網誌文章、編輯或刪除自己的網誌文章，以及查詢符合特定條件的網誌文章。
除了提供 Blogger Data API 功能的相關背景外，本文件也提供了使用 Python 用戶端程式庫的基本 Data API 互動範例。如果您想進一步瞭解程式庫使用的基礎通訊協定，請參閱這份開發人員指南的通訊協定部分。
目錄
觀眾
本文件的適用對象，是想編寫可與 Blogger 互動的 Python 用戶端應用程式。
本文假設您瞭解 Google Data API 通訊協定的一般概念。
如需一般 Blogger Data API 參考資訊，請參閱通訊協定參考資料指南。
開始
如需設定用戶端程式庫的相關說明，請參閱入門指南。
Python 用戶端程式庫需要使用 Python 2.2 以上版本。下載用戶端程式庫後，您也必須下載並安裝 ElementTree 套件。
建立 Blogger 帳戶
如要進行測試，建議您註冊 Blogger 帳戶。Blogger 會使用 Google 帳戶，因此如果您已經有 Google 帳戶，就表示大功告成。
執行程式碼範例
您可以在 BloggerExample.py 目錄中的 gdata-python-client/samples/blogger/ 檔案中找到完整的完整範例應用程式，其中包含本文件中列出的所有程式碼範例。
範例用戶端會在提供的網誌上執行多項作業，示範 Blogger Data API 的使用方式。
您可以使用下列引數執行範例：
python BloggerExample.py --email [email_address] --password [password]
如要在您自己的程式碼中使用本文件中的範例，您必須使用下列 import 陳述式：
from gdata import service import gdata import atom
驗證 Blogger 服務
使用 Blogger Data API 就能存取公開和私人的動態消息。 公開動態饋給不需要驗證，但處於唯讀狀態。如要修改網誌，則用戶端必須先進行驗證，才能要求私人動態饋給。驗證方式有以下三種：OAuth 驗證、AuthSub Proxy 驗證或 ClientLogin 使用者名稱/密碼驗證。
如要進一步瞭解如何使用 Google Data API 進行驗證，請參閱驗證說明文件。
在本文件的後續章節中，大部分範例假設您有通過驗證的 GDataService 執行個體。
OAuth 驗證
如要瞭解如何使用 Python GData 程式庫執行 OAuth 驗證，請參閱 Google Data Protocol 用戶端程式庫中的 OAuth。
AuthSub Proxy 驗證
需要驗證使用者提供給 Google 帳戶的網頁應用程式會使用 AuthSub Proxy 驗證。網站運算子和用戶端代碼無法存取 Blogger 使用者的使用者名稱和密碼；用戶端則會取得特殊的 AuthSub 權杖，允許用戶端代表特定使用者採取行動。詳情請參閱 AuthSub 說明文件。
使用者第一次造訪您的應用程式時，尚未通過驗證。在這種情況下，您必須顯示某些資訊，以及透過連結將使用者帶往 Google 頁面的連結，以便我們驗證您的網誌存取要求。Python 用戶端程式庫提供了函式，可用來產生 Google 網頁的網址。下列程式碼會擷取 AuthSubRequest 頁面的網址：
def GetAuthSubUrl(): next = 'http://www.example.com/welcome.pyc' scope = 'http://www.blogger.com/feeds/' secure = False session = True blogger_service = service.GDataService() return blogger_service.GenerateAuthSubURL(next, scope, secure, session); authSubUrl = GetAuthSubUrl(); print '<a href="%s">Login to your Google account</a>' % authSubUrl
GenerateAuthSubURL 方法採用下列參數 (對應 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.pyc
使用者點選 Google 網站的連結並驗證自己的 Google 帳戶。
使用者驗證完成後，AuthSub 系統會將使用者重新導向至 AuthSubRequest 網址的 next 查詢參數中指定的網址。AuthSub 系統會將驗證權杖附加至該網址，做為 token 查詢參數的值。例如：
http://www.example.com/welcome.pyc?token=yourAuthToken
有許多方法可從網址擷取權杖值，例如：
import cgi parameters = cgi.FieldStorage() authsub_token = parameters['token']
這個權杖值代表一次性的 AuthSub 權杖。在這個範例中，因為指定了 session = True，所以您可以使用 UpgradeToSessionToken 方法交換這個權杖，以便呼叫 AuthSubSessionToken 服務：
blogger_service = service.GDataService() blogger_service.auth_token = authsub_token blogger_service.UpgradeToSessionToken()
也就是說，你需要將一次性使用權杖傳遞至 UpgradeToSessionToken 方法，且 AuthSub 介面會傳回工作階段符記。
之後，您的應用程式即可在後續與 Blogger 的互動中使用工作階段符記值。用戶端程式庫會自動傳送憑證和要求。
ClientLogin 使用者名稱/密碼驗證
如果您的用戶端是獨立的單一使用者「已安裝」用戶端 (例如電腦版應用程式)，請使用 ClientLogin 驗證。只要在 GDataService 例項上呼叫 ProgrammaticLogin() 方法，系統就會驗證所有與 Blogger 之間的互動：
blogger_service = service.GDataService('user@example.com', 'secretPassword')
blogger_service.source = 'exampleCo-exampleApp-1.0'
blogger_service.service = 'blogger'
blogger_service.account_type = 'GOOGLE'
blogger_service.server = 'www.blogger.com'
blogger_service.ProgrammaticLogin()
在上方的程式碼片段中，我們已在 GDataService 例項上設定三個屬性。第一種是應用程式名稱，格式為 companyName-applicationName-versionID；第二個則是我們要互動的服務名稱，第三個是伺服器的地址。
請注意，account_type 已明確設為 GOOGLE。如未設定這個參數，G Suite 使用者就無法順利使用 Blogger API。
如要進一步瞭解 ClientLogin 驗證，包括要求和回應範例，請參閱已安裝應用程式驗證說明文件。
注意：在特定工作階段中的所有要求都使用相同的權杖；請勿為各個 Blogger 要求取得新權杖。
注意：如「ClientLogin」說明文件中所述，驗證要求可能會失敗，並要求進行人機驗證 (Captcha) 驗證。如果您想讓 Google 發出及處理人機驗證 (Captcha) 驗證問題，請將使用者傳送至 https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger (而非 ClientLogin 說明文件中的人機驗證 (Captcha) 處理網址)。
擷取網誌清單
Blogger Data API 提供動態饋給，可列出特定使用者的網誌；該動態饋給稱為「metafeed」。
下列程式碼範例使用已驗證的 GDataService 執行個體來擷取中繼動態饋給，然後列印每個網誌的標題。
def PrintUserBlogTitles(blogger_service):
query = service.Query()
query.feed = '/feeds/default/blogs'
feed = blogger_service.Get(query.ToUri())
print feed.title.text
for entry in feed.entry:
print "\t" + entry.title.text
記下 Get 方法使用的網址。這是預設的中繼動態饋給網址，會傳回目前已驗證使用者的網誌清單。如要存取其他使用者的動態饋給，請在中繼動態饋給網址中以使用者的 ID 取代 default。使用者的 ID 是使用者個人資料網址結尾的數字字串。
下列程式碼片段示範如何從動態饋給中擷取網誌 ID。您必須具備網誌 ID，才能執行貼文和留言的建立、更新和刪除作業。下列程式碼片段會選擇要為使用者擷取的第一個網誌。
blog_id = feed.entry[0].GetSelfLink().href.split("/")[-1]
在 BloggerExample.py 範例中，系統會建立 BloggerExample 類別，並在建構函式中設定網誌 ID，以便日後存取。在本文件中的大部分範例中，blog_id 會以變數的形式傳入。
建立貼文
Blogger Data API 可讓您建立及發布新的網誌項目，以及建立項目草稿。
注意：目前不支援為貼文設定自訂作者。所有新貼文都會顯示為目前已驗證使用者所建立的貼文。
發布網誌文章
您可以使用 Python 用戶端程式庫來發布新的網誌項目。
首先，請建立 GDataEntry 例項來代表網誌文章。然後設定網誌文章的標題、內容和其他屬性。
最後，使用 GDataService 例項插入貼文。以下說明如何發布新網誌文章：
def CreatePublicPost(blogger_service, blog_id, title, content):
entry = gdata.GDataEntry()
entry.title = atom.Title('xhtml', title)
entry.content = atom.Content(content_type='html', text=content)
return blogger_service.Post(entry, '/feeds/%s/posts/default' % blog_id)
blogEntry = CreatePublicPost(blogger_service, blog_id,
title='I have the answer', content='Eureka! It is 42!')
建立網誌文章草稿
草稿貼文的建立方式與公開貼文相同，但您必須在 GDataEntry 執行個體中設定 draft 擴充功能元素。您可以新增上方的程式碼行，將上述網誌文章儲存為草稿：
def CreateDraftPost(blogger_service, blog_id, title, content):
entry = gdata.GDataEntry()
entry.title = atom.Title('xhtml', title)
entry.content = atom.Content(content_type='html', text=content)
control = atom.Control()
control.draft = atom.Draft(text='yes')
entry.control = control
return blogger_service.Post(entry, '/feeds/%s/posts/default' % blog_id)
draftEntry = CreateDraftPost(blogger_service, blog_id,
title='I have the question',
content='What do you get if you multiply six by nine?')
您可以將現有的草稿網誌文章轉換成已發布的文章，方法是擷取草稿文章，將草稿屬性設為 no，然後更新文章。我們將在接下來兩節中介紹如何擷取及更新貼文。
擷取貼文
下列各節說明如何擷取包含及不含查詢參數的網誌文章清單。
您不必驗證就能查詢 Blogger 公開動態饋給。因此，在從公開網誌擷取貼文之前，您不需要設定憑證或進行 AuthSub 驗證。
擷取所有網誌文章
如要擷取使用者的貼文，請使用網誌文章貼文網址呼叫 GetFeed 方法：
def PrintAllPosts(blogger_service, blog_id):
feed = blogger_service.GetFeed('/feeds/' + blog_id + '/posts/default')
print feed.title.text
for entry in feed.entry:
print "\t" + entry.title.text
print "\t" + entry.content.text
print "\t" + entry.updated.text
print
使用查詢參數擷取貼文
Blogger Data API 可讓您要求一組與指定條件相符的項目，例如要求在指定日期範圍內發布或更新的網誌文章。如要執行此操作，請建立 Query 執行個體，然後呼叫 Get() 方法。
舉例來說，如要傳送日期範圍查詢，請設定 Query 執行個體的 published_min 和 published_min 屬性。
下列程式碼片段會列印在特定開始時間和結束時間之間發布的各篇網誌文章的標題和內容：
def PrintPostsInDateRange(blogger_service, blog_id, start_time='2007-04-01', end_time='2007-04-25'):
query = service.Query()
query.feed = '/feeds/' + blog_id + '/posts/default'
query.published_min = start_time
query.published_max = end_time
feed = blogger_service.Get(query.ToUri())
print feed.title.text + " posts between " + start_time + " and " + end_time
for entry in feed.entry:
print "\t" + entry.title.text
print "\t" + entry.content.text
print "\t" + entry.updated.text
print
請注意，Query 物件是以用於擷取貼文的相同貼文動態饋給網址建構。
Blogger Data API 支援下列 Query 屬性：
- categories
- 指定類別 (也就是標籤) 可篩選動態饋給結果。例如，
http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie會傳回同時包含Fritz和Laurie標籤的項目。如要在 Python 用戶端程式庫中指定該類別查詢，您可以使用query.categories = ['Fritz','Laurie',] - max_results
- 要傳回的項目數量上限。
- 已發布_min、publish_max
- 項目發布日期的邊界。
- start_index
- 要擷取的第一個結果以 1 為基礎的索引 (用於分頁)。
- updated_min、update_max
- 項目更新日期的邊界。除非
orderby參數設為updated，否則系統會忽略這些查詢參數。
如要進一步瞭解查詢參數，請參閱 Blogger Data API 參考指南和 Google Data API 參考指南。
正在更新貼文
如要更新現有的網誌文章，請先擷取您要更新的項目，然後加以修改，然後再使用 Put 方法將文章傳送給 Blogger。下列程式碼片段會修改網誌項目的標題，前提是您已從伺服器擷取項目。
def UpdatePostTitle(blogger_service, entry_to_update, new_title='The REAL answer'):
entry_to_update.title = atom.Title('xhtml', new_title)
return blogger_service.Put(entry_to_update, entry_to_update.GetEditLink().href)
上述程式碼會傳回包含完整更新的貼文的 GDataEntry。如要更新任何其他屬性，只要在呼叫 Put 前，在 GDataEntry 執行個體中設定即可。
注意：目前無法修改與貼文相關的作者資料。
刪除貼文
如要刪除貼文，請將貼文的編輯網址傳遞至 GDataService 物件的 Delete 方法，如下所示：
def DeletePost(blogger_service, edit_link_href): blogger_service.Delete(edit_link_href)
留言
Blogger Data API 可讓您建立、擷取及刪除留言。不支援更新註解 (或透過網頁介面提供註解)。
建立註解
如要發布留言，請建立 GDataEntry 物件並插入該物件，如下所示：
def CreateComment(blogger_service, blog_id, post_id, comment_text='Mostly harmless'): feed_uri = '/feeds/' + blog_id + '/' + post_id + '/comments/default' entry = gdata.GDataEntry() entry.content = atom.Content(content_type='xhtml', text=comment_text) return blogger_service.Post(entry, feed_uri)
注意：目前你只能將留言張貼到由已驗證使用者擁有的網誌。
注意：目前不支援為留言設定自訂作者。所有新留言都會顯示為目前已驗證使用者所建立的留言。
擷取註解
您可以從貼文的留言動態饋給網址中擷取特定貼文的留言：
def PrintAllComments(blogger_service, blog_id, post_id):
feed_url = '/feeds/' + blog_id + '/' + post_id + '/comments/default'
feed = blogger_service.Get(feed_url)
print feed.title.text
for entry in feed.entry:
print "\t" + entry.title.text
print "\t" + entry.updated.text
print
或者，你可以使用網誌的留言動態饋給網址，接收所有貼文的留言：
http://www.blogger.com/feeds/blogID/comments/default
刪除留言
如要刪除註解，請將註解的編輯網址傳遞至 GDataService 物件的 Delete 方法，如下所示：
def DeleteComment(blogger_service, post_id, comment_id): feed_url = '/feeds/' + post_id + '/comments/default/' + comment_id blogger_service.Delete(feed_url)