开发者指南：PHP

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

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

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

目录

1. 观众群
2. 使用入门
   1. 创建 Blogger 帐号
   2. 运行示例代码
   3. 使用神奇的 getter 和 setter
   4. 其他资源
3. 向 Blogger 服务进行身份验证
   1. OAuth 身份验证
   2. AuthSub 代理身份验证
   3. StreetView 用户名/密码身份验证
4. 检索博客列表
5. 创建帖子
   1. 发布博文
   2. 创建博文草稿
6. 检索帖子
   1. 检索所有博文
   2. 使用查询参数检索帖子
7. 更新帖子
8. 删除帖子
9. 备注
   1. 创建评论
   2. 检索评论
   3. 删除评论

受众

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

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

如需了解客户端库提供的类和方法，请参阅 PHP 客户端库 API 参考文档。如需了解通用的 Blogger 数据 API 参考信息，请参阅协议参考指南。

开始使用

如需有关设置客户端库的帮助，请参阅入门指南。

Zend 客户端库要求使用 PHP 5.1.4 或更高版本。它作为 Zend Framework 的一部分提供，也可以单独下载。若要与 Blogger 进行交互，请使用 1.0.0 或更高版本的客户端库。

创建 Blogger 帐号

您可以注册 Blogger 帐号以进行测试。Blogger 使用的是 Google 帐号，因此如果您已经拥有 Google 帐号，就大功告成了。

运行示例代码

Zend Framework SVN 代码库中提供了一个完整的示例客户端，其中包含本文档中显示的所有示例代码。示例位于 /framework/standard/中继/demos/Zend/Gdata/Blogger.php。该示例包含本文档介绍的所有函数。它只能从命令行运行：

php Blogger.php -- --user=[email_address] --pass=[password]

在运行此示例或使用 Zend 框架开发代码之前，您可能需要设置 include_path 并加载相应的类。您可以使用 php.ini 设置或使用 set_include_path 方法设置包含路径。此代码用于请求访问核心 Zend_Gdata 类、Zend_Gdata_Query 类和身份验证类 Zend_Gdata_StreetView。

require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata');
Zend_Loader::loadClass('Zend_Gdata_Query');
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');

使用神奇的 getter 和 setter

在整个 PHP 客户端库中，为方便开发者，添加了对魔法 setter/getter 的支持。这样一来，用户便可以使用传统的 setter/getter 方法或通过访问属性安全地访问类的属性。例如，如果 $gdataObject 是此库中的对象实例，那么以下两行代码具有相同的效果：

$gdataObject->setFoo("bar");
$gdataObject->foo = "bar";

同样，这两行代码也会产生相同的效果：

$baz = $gdataObject->getFoo();
$baz = $gdataObject->foo;

同样，魔法工厂方法可让您更轻松地声明新对象。您可以通过对 Zend 服务客户端调用 newObject(); 来创建新的 object 名称，而不是记住 Zend 命名惯例规定的长类名称。例如，以下两个代码段都声明了新的 draft 扩展对象。如需详细了解 drafts，请参阅创建帖子部分。

// Traditional instantiation
$gdClient = new Zend_Gdata();
$draft = new Zend_Gdata_App_Extension_Draft();

// Magic factory instantiation
$gdClient = new Zend_Gdata();
$draft = $gdClient->newDraft();

神奇的 setter/getter 和工厂是可选项，因此请使用最适合您的方法。

其他资源

Zend Framework 的 Google Data API 组件 (Zend_Gdata) 的其他资源：

• 参考文档
• 邮寄名单信息和归档
• Zend Framework Subversion 信息
• Zend Framework Nightly 快照

向 Blogger 服务进行身份验证

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

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

本文档后续部分中的大多数示例都假定您有一个名为 $gdClient 且经过身份验证的客户端对象。

OAuth 身份验证

如需查看有关使用 Zend PHP GData 库进行 OAuth 身份验证的文档，请参阅 Google 数据协议客户端库中的 OAuth。

AuthSub 代理身份验证

需要向 Google 帐号对用户进行身份验证的 Web 应用会使用 AuthSub 代理身份验证。网站运营商和客户端代码无法访问 Blogger 用户的用户名和密码；客户端会获取特殊的 AuthSub 令牌，这些令牌使客户端能够代表特定用户执行操作。如需了解详情，请参阅 AuthSub 文档。

用户首次访问您的应用时，尚未经过身份验证。在这种情况下，您需要显示一些信息和一个链接，将用户定向到一个 Google 页面，以对您访问其博客的请求进行身份验证。Zend 客户端库提供了一个用于生成 Google 网页的网址的函数。以下代码会检索 AuthSubRequest 页面的网址：

function getAuthSubUrl()
{
  $next = getCurrentUrl();
  $scope = 'http://www.google.com/blogger/feeds/';
  $secure = false;
  $session = true;
  return Zend_Gdata_AuthSub::getAuthSubTokenUri($next, $scope, $secure, $session);
}

$authSubUrl = getAuthSubUrl();
echo '<a href=\"$authSubUrl\">login to your Google account</a>';

getAuthSubTokenUri 方法采用以下参数（与 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.php

用户点击指向 Google 网站的链接，并向自己的 Google 帐号进行身份验证。

用户进行身份验证后，AuthSub 系统会将用户重定向到您在 AuthSubRequest 网址的 next 查询参数中指定的网址。AuthSub 系统会在该网址中附加一个身份验证令牌，作为 token 查询参数的值。例如：

http://www.example.com/welcome.php?token=yourAuthToken

您可以使用 $_GET['token'] 检索令牌值。

此令牌值代表一个单次使用的 AuthSub 令牌。在此示例中，由于指定了 $session = true，可以使用 Zend_Gdata_AuthSub::getAuthSubSessionToken 方法（用于调用 AuthSubSessionToken 服务）使用此令牌交换 AuthSub 会话令牌：

if(! isset($_SESSION['sessionToken']) && isset($_GET['token'])) {
  $_SESSION['sessionToken'] =
      Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
}

该代码段会先检查 AuthSub 会话令牌是否已存在。如果不是，但在网址中指定了一次性令牌，则代码段会将一次性令牌传递给 getAuthSubSessionToken 方法，而 AuthSub 接口会返回会话令牌。代码随后会将会话令牌值放入会话变量 $_SESSION['sessionToken'] 中。

然后，您的应用可以在与 Blogger 后续互动时使用会话令牌值。您可以使用 Zend_Gdata_AuthSub::getHttpClient 方法获取一个 Zend_Http_Client 对象，该对象包含 Authorization 标头预设，以包含 AuthSub 凭据：

$client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['sessionToken']);

ClientLogin 用户名/密码身份验证

如果您的客户端是独立的单用户“安装”客户端（例如桌面应用），请使用 EGL 身份验证。

以下代码使用 Zend_Gdata_ClientLogin::getHttpClient 方法向 EGL 服务发出请求、检索身份验证令牌，并使用适当的身份验证标头创建 Zend_Http_Client 对象。然后，此方法返回的 HttpClient 用于构造 Zend_Gdata 服务对象。

请注意，$accountType 已明确设置为 GOOGLE。如果未能设置此参数，G Suite 用户将无法使用 Blogger API。

$user = '[e-mail]';
$pass = 'secretPasswd';
$service = 'blogger';

$client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service, null,
        Zend_Gdata_ClientLogin::DEFAULT_SOURCE, null, null,
        Zend_Gdata_ClientLogin::CLIENTLOGIN_URI, 'GOOGLE');
$gdClient = new Zend_Gdata($client);

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

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

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

检索博客列表

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

以下示例代码使用经过身份验证的 $gdClient 对象检索元 Feed，然后输出每个博客的标题。

Zend_Gdata_Query 类负责构造查询网址。在这种情况下，您无需执行额外的操作，但 Query 类的实用性将在本文档的按查询参数检索博文部分变得明显。

function printAllBlogs()
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/default/blogs');
  $feed = $gdClient->getFeed($query);
  printFeed($feed);
}

function printFeed($feed)
{
  $i = 0;
  foreach($feed->entries as $entry) {
    print $i ." ". $entry->title->text . "\n";
    $i++;
  }
}

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

以下代码段演示了如何从 Feed 中提取博客 ID。您需要使用博客 ID 对博文和评论执行创建、更新和删除操作。$index 变量表示用户博客信息流中正在使用哪个博客。id 字段采用 tag:blogger.com,1999:user-userID.blog-blogID 格式，因此 '-' 字符上的 split 会将博客 ID 放置在生成的数组的最后一个元素中。

$idText = split('-', $feed->entries[$index]->id->text);
$blogID = $idText[2];

创建帖子

您可以使用 Blogger Data API 创建和发布新的博客条目，以及创建条目草稿。

注意：目前不支持为帖子设置自定义作者。所有新帖子都会显示为它们是由当前经过身份验证的用户创建的。

发布博文

您可以使用 PHP 客户端库发布新的博客条目。

首先，创建一个条目实例来表示博文。然后，您可以设置博文的标题、内容和其他属性。最后，调用 insertEntry 方法插入博文。通过新的 Zend_Gdata_Entry、Zend_Gdata_App_Extension_Title 和 Zend_Gdata_App_Extension_Content 对象，您可以看到此处的神奇工厂实例化。

function createPublishedPost($title='Hello, world!', $content='I am blogging on the internet.')
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/posts/default';
  $entry = $gdClient->newEntry();
  $entry->title = $gdClient->newTitle($title);
  $entry->content = $gdClient->newContent($content);
  $entry->content->setType('text');

  $createdPost = $gdClient->insertEntry($entry, $uri);
  $idText = split('-', $createdPost->id->text);
  $newPostID = $idText[2];

  return $newPostID;
}

创建博文草稿

草稿帖子的创建方式与公开帖子相同，但您需要设置条目对象的草稿属性。您可以通过添加突出显示的行，以草稿的形式创建上述博文：

function createDraftPost($title='Salutations, world!', $content='Hmm ... not quite right, must rework the title later.')
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/posts/default';
  $entry = $gdClient->newEntry();

  $entry->title = $gdClient->newTitle(trim($title));
  $entry->content = $gdClient->newContent($content);
  $entry->content->setType('text');

  $control = $gdClient->newControl();
  $draft = $gdClient->newDraft('yes');
  $control->setDraft($draft);
  $entry->control = $control;

  $createdPost = $gdClient->insertEntry($entry, $uri);
  $idText = split('-', $createdPost->id->text);
  return $idText[2];
}

与创建新的帖子标题或内容的方式大致相同，您可以创建新的 Zend_Gdata_App_Extension_Control 和 Zend_Gdata_App_Extension_Draft 对象，并将其分配给条目的控件属性。

您可以将现有的博文草稿检索到，将草稿属性设为 no，然后更新该博文，从而将其转换为已发布的博文。我们将在后面两部分介绍如何检索和更新帖子。

检索帖子

以下部分介绍了如何检索带查询参数和不带查询参数的博文列表。

您可以在不进行身份验证的情况下查询 Blogger 公开 Feed。因此，在从公开博客检索博文之前，无需设置凭据或执行 AuthSub 身份验证。

检索所有博文

如需检索用户的帖子，请调用与检索博客元 Feed 相同的 getFeed 方法，但这次要发送博文 Feed 网址：

function printAllPosts($gdClient, $blogID)
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/posts/default');
  $feed = $gdClient->getFeed($query);
  printFeed($feed);
}

使用查询参数检索帖子

借助 Blogger Data API，您可以请求符合指定条件的一组条目，例如请求在指定日期范围内发布或更新的博文。为此，您需要创建一个查询对象并将其传递给 getFeed 方法。

例如，如需发送日期范围查询，请设置查询对象的 published-min 和 published-max 参数。以下代码段会输出在指定的开始时间和结束时间之间发布的每篇博文的标题和内容：

function printPostsInDateRange($gdClient, $blogID, $startDate='2007-04-01', $endDate='2007-04-25')
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/posts/default');
  $query->setParam('published-min', $startDate);
  $query->setParam('published-max', $endDate);

  $feed = $gdClient->getFeed($query);
  printFeed($feed);
}

Zend_Gdata_Query 类的实用调试方法是 getQueryUrl()，它会向您显示已构建的编码网址。

注意：published-min 和 published-max 查询参数目前没有魔法 setter。不过，您可以使用 setStartIndex 和 setMaxResults。

Blogger 数据 API 支持以下查询参数：

类别

指定类别（也称为标签）以过滤 Feed 结果。例如，http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie 会返回带有 Fritz 和 Laurie 标签的条目。

max-results

要返回的条目数上限。

publish-min、publish-max

条目发布日期的边界。

start-index

要检索的第一个结果的索引（从 1 开始，用于分页）。

如需详细了解查询参数，请参阅 Blogger Data API 参考指南和 Google Data API 参考指南。

正在更新帖子

如需更新现有博文，请先检索要更新的条目，接着修改该条目，然后使用 save 方法将其发送到 Blogger。以下代码段修改了博客条目的标题和内容（假设您已从服务器中检索了该条目）。

public function updatePost($postID, $updatedTitle='Hello, World?',
                           $updatedContent='UPDATE: Still blogging',
                           $isDraft=False)
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/posts/default/' . $postID);
  $postToUpdate = $dClient->getEntry($query);
  $postToUpdate->title->text = $this->gdClient->newTitle($updatedTitle);
  $postToUpdate->content->text = $this->gdClient->newContent($updatedContent);

  if ($isDraft) {
    $draft = $gdClient->newDraft('yes');
  } else {
    $draft = $gdClient->newDraft('no');
  }

  $control = $gdClient->newControl();
  $control->setDraft($draft);
  $postToUpdate->control = $control;

  $updatedPost = $postToUpdate->save();
  return $updatedPost;
}

注意：目前不支持修改与帖子相关联的作者数据。

删除帖子

要删除帖子，请将帖子的修改网址传递给 $gdClient 对象的 delete 方法，如下所示：

public function deletePost($gdClient, $blogID, $postID)
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/posts/default/' . $postID;
  $gdClient->delete($uri);
}

备注

Blogger Data API 允许创建、检索和删除评论。 不支持更新评论（也不支持网页界面）。

创建评论

要发布评论，请创建一个条目对象并将其插入，如下所示：

function createComment($gdClient, $blogID, $postID, $commentText)
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/' . $postID . '/comments/default';

  $newComment = $gdClient->newEntry();
  $newComment->content = $gdClient->newContent($commentText);
  $newComment->content->setType('text');
  $createdComment = $gdClient->insertEntry($newComment, $uri);

  $editLink = split('/', $createdComment->getEditLink()->href);
  $newCommentID = $editLink[8];

  return $newCommentID; 
}

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

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

检索评论

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

public function printPostComments($gdClient, $blogID, $postID)
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/' . $postID . '/comments/default');
  $feed = $gdClient->getFeed($query);
  $printFeed($feed);
}

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

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

删除评论

要删除注释，请将注释的修改网址传递给 $gdClient 对象的 delete 方法，如下所示：

public function deleteComment($gdClient, $blogID, $postID, $commentID)
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/' . $postID . '/comments/default/' . $commentID;
  $gdClient->delete($uri);
}

返回页首