开发者指南:Python

Blogger Data API 允许客户端应用以 Google Data API Feed 的形式查看和更新 Blogger 内容。

您的客户端应用可以使用 Blogger 数据 API 创建新的博文、修改或删除现有的博文,以及查询符合特定条件的博文。

除了介绍一些有关 Blogger 数据 API 功能的背景信息之外,本文还提供了使用 Python 客户端库进行基本数据 API 交互的示例。如果您想详细了解该库使用的底层协议,请参阅本开发者指南的协议部分

目录

受众

本文档适用于想要编写可与 Blogger 交互的 Python 客户端应用的程序员。

本文档假定您了解 Google Data API 协议的一般概念。

如需了解 Blogger 数据 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 数据 API 访问公开 Feed 和不公开 Feed。 公开 Feed 不需要任何身份验证,但它们是只读的。如果您想修改博客,那么您的客户端需要先进行身份验证,然后才能请求不公开 Feed。可以使用以下三种方法中的任何一种进行身份验证:OAuth 身份验证、AuthSub 代理身份验证或 StreetView 用户名/密码身份验证。

如需详细了解通常如何使用 Google 数据 API 进行身份验证,请参阅身份验证文档

本文档后续部分中的大多数示例都假定您有一个经过身份验证的 GDataService 实例。

OAuth 身份验证

有关使用 Python GData 库进行 OAuth 身份验证的文档,请参阅 Google 数据协议客户端库中的 OAuth

AuthSub 代理身份验证

需要向 Google 帐号对用户进行身份验证的 Web 应用会使用 AuthSub 代理身份验证。网站运营商和客户端代码无法访问 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 Feed。要使用的范围字符串为 http://www.blogger.com/feeds/(当然是网址编码)。
安全
指示客户端是否请求安全令牌。
session
指示是否可以用返回的令牌交换多用途(会话)令牌。

上面的示例展示了没有请求安全令牌的调用(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 服务)使用此令牌交换 AuthSub 会话令牌:

blogger_service = service.GDataService()
blogger_service.auth_token = authsub_token
blogger_service.UpgradeToSessionToken()

也就是说,您将一次性令牌传递给 UpgradeToSessionToken 方法,然后 AuthSub 接口会返回一个会话令牌。

然后,您的应用可以在与 Blogger 后续互动时使用会话令牌值。客户端库会自动随请求一起发送令牌。

ClientLogin 用户名/密码身份验证

如果您的客户端是独立的单用户“安装”客户端(例如桌面应用),请使用 EGL 身份验证。只需在 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。

如需详细了解 EGL 身份验证(包括示例请求和响应),请参阅针对已安装应用的身份验证文档。

注意:对于给定会话中的所有请求,都使用相同的令牌;不要为每个 Blogger 请求获取新的令牌。

注意:如 EGL 文档中所述,身份验证请求可能会失败并发出人机识别系统质询。如果您希望 Google 发出并处理人机识别系统质询,请将用户定向到 https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger(而不是发送到 EGL 文档中提供的人机识别系统处理网址)。

检索博客列表

Blogger 数据 API 提供的 Feed 列出了特定用户的博客;该 Feed 称为“元 Feed”。

以下示例代码使用经过身份验证的 GDataService 实例来检索元 Feed,然后输出每个博客的标题。

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 方法使用的网址。这是默认的元 Feed 网址;它会返回当前已通过身份验证的用户的博客列表。如需访问其他用户的 Feed,您可以将该用户的 ID 替换到元 Feed 网址中 default 的位置。用户 ID 是用户个人资料网址末尾的一串数字。

以下代码段演示了如何从 Feed 中提取博客 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 公开 Feed。因此,在从公开博客检索博文之前,无需设置凭据或执行 AuthSub 身份验证。

检索所有博文

如需检索用户的帖子,请使用博文 Feed 网址调用 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_minpublished_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 对象是使用与检索帖子相同的帖子 Feed 网址构建的。

Blogger 数据 API 支持以下 Query 属性:

类别
指定类别(也称为标签)以过滤 Feed 结果。例如,http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie 会返回带有 FritzLaurie 标签的条目。如需在 Python 客户端库中指定该类别查询,您可以使用 query.categories = ['Fritz','Laurie',]
结果数上限
要返回的条目数上限。
publish_min、publish_max
条目发布日期的边界。
start_index
要检索的第一个结果的索引(从 1 开始,用于分页)。
updated_min、updated_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)

注意:目前,您只能向经过身份验证的用户拥有的博客发表评论。

注意:目前不支持为评论设置自定义作者。所有新评论将显示为由当前经过身份验证的用户创建。

检索评论

您可以从帖子的评论 Feed 网址中检索特定帖子的评论:

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 

或者,您也可以使用博客的评论 Feed 网址来获取所有博文中的评论:

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)

返回页首