类参考

目录

类

类 google.feeds.Feed

google.feeds.Feed 类的实例可以下载一个供稿网址。

构造函数

方法

类 google.feeds.FeedControl

google.feeds.FeedControl 类的实例旨在下载和显示多个供稿。该类与 AJAX 搜索 API 的搜索控件层 GSearchControl 非常类似。

构造函数

方法

feedControl.draw(
  document.getElementById("feedControl"),
  {
    drawMode : google.feeds.FeedControl.DRAW_MODE_TABBED
  });
    

CSS 结构

FeedControl 显示具有准确类注释的 HTML 标记。这些类旨在使您可以轻松设置控件和每个条目 HTML 的样式。如果您熟悉 CSS，则可以相对轻松地设计 FeedControl 的样式以满足您的需要。要了解的关键之处在于：基本 CSS 样式在 http://www.google.com/uds/css/gfeed.css 中进行定义，系统会自动载入该网址。接下来，您便可以定义特定样式覆盖以实现所需的效果。大体的 CSS 结构如下所示。使用基于 Firefox 的 FireBug 或 DOM 检查程序也很有用。

<!-- The Feed Control Class (Note: Linear Mode is Shown) -->
<div class="gfc-control">

  <!-- Per Feed Container -->
  <div class="gfc-resultsRoot">

    <!-- Per Feed Header -->
    <!-- .gfc-title holds Feed's Label -->
    <div class="gfc-resultsHeader">
      <div class="gfc-title"></div>
    </div>

    <!-- Collection of Entries -->
    <div class="gfc-results">

      <!-- One .gfc-result per entry -->
      <div class="gfc-result">

        <!-- One .gf-result per entry -->
        <div class="gf-result">

          <!-- Hyperlinked Entry Title -->
          <div class="gf-title">
            <a class="gf-title"></a>
          </div>

          <!-- Author (Only if entry.author is present -->
          <div class="gf-author"></div>

          <!-- Published Date (Only if entry.publishedDate is present -->
          <div class="gf-relativePublishedDate"></div>

          <!-- Snippet entry.contentSnippet -->
          <div class="gf-snippet"></div>

        </div>
      </div>
      ...
      <div class="gfc-result"></div>
    </div>
  </div>
  ...
  <div class="gfc-resultsRoot"></div>

</div>

为了帮助您明确方向，我们提供了 sidebar.html 示例。此示例非常简单，它使用一些非常简单的样式规则抑制某些属性的显示，更改某些默认边界以及调整字体大小和宽度。净结果是一个非常紧凑的表单，非常适合在典型的侧边栏中显示一组博客样式集合的链接。设计样式的重要组成部分为：

<style type="text/css">
  /**
   * Set a very small font size for the control and constrain
   * it's width to 225px
   *
   * Note: the page has a single FeedControl that
   * is drawn in the <div> element whose id is "feedControl".
   */
  #feedControl {
    font-size: 10px;
    width : 225px;
  }

  /**
   * Suppress everything except for title
   */
  #feedControl .gf-snippet,
  #feedControl .gf-author,
  #feedControl .gf-spacer,
  #feedControl .gf-relativePublishedDate {
    display : none;
  }

  /**
   * 1em Padding at the bottom of each collection of entries
   */
  #feedControl .gfc-results {
    padding-bottom : 1em;
  }

  /**
   * no padding between entries
   */
  #feedControl .gfc-result {
    margin-bottom : 0px;
  }

  /**
   * Use a larger font size for section titles
   */
  #feedControl .gfc-resultsHeader .gfc-title {
    font-size : 110%;
  }
</style>

全局方法

结果格式

load() 方法在供稿下载完成时将会调用具有单个结果的函数参数。结果具有以下结构：

• <根>
  • error?
    载入供稿出错时显示
    • code
      HTTP 样式的错误代码
    • message
      用户可读的错误字符串说明
  • xmlDocument?
    供稿 XML 文档。表示 XML_FORMAT 和 MIXED_FORMAT 结果格式。请参考下面的 XML 文档
  • feed?
    供稿的 JSON 表示。表示 JSON_FORMAT 和 MIXED_FORMAT 结果格式。请参考下面的 JSON 文档

JSON 结果格式

如果您请求 google.feeds.Feed.JSON_FORMAT 结果格式，则将在feed供稿结果中显示 属性。feed 属性具有以下结构：

• feed
  • title
    供稿标题。对应于 Atom 中的 <title> 元素和 RSS 中的 <title> 元素。
  • link
    供稿的 HTML 版本的网址。对应于 Atom 中的 <link> 元素和 RSS 中的 <link> 元素。
  • description
    供稿说明。对应于 Atom 中的 <description> 元素和 RSS 中的 <subtitle> 元素。
  • author
    供稿作者。对应于 Atom 中该作者的 <name> 元素。
  • entries[]
    供稿中所有条目的列表。对应于 Atom 中的 <item> 元素和 RSS 中的 <entry> 元素。
    • title
      条目标题。对应于 Atom 中的 <title> 元素和 RSS 中的 <title> 元素。
    • link
      条目的 HTML 版本的网址。对应于 Atom 中的 <link> 元素和 RSS 中的 <link> 元素。
    • content
      条目的正文，包括 HTML 标签。由于该值可以包含 HTML 标签，因此您应使用 elem.innerHTML = entry.content（而不是使用 document.createTextNode）显示该值。对应于 Atom 中的 <content> 或 <summary> 元素和 RSS 中的 <description> 元素。
    • contentSnippet
      content 属性的片断版本（小于 120 个字符）。此片断不包含任何 HTML 标签。
    • publishedDate
      发布条目的字符串日期的形式为“13 Apr 2007 12:40:07 -0700”。您可以使用 new Date(entry.date) 分析此日期。对应于 Atom 中的 <link> 元素和 RSS 中的 <link> 元素。
    • categories[]
      条目的字符串标签的列表。对应 Atom 中的 <类别> 元素和 RSS 中的 <类别> 元素的字词属性。

XML 结果格式

如果您请求 google.feeds.Feed.XML_FORMAT 结果格式，则将在xmlDocument供稿结果中显示 属性。xmlDocument 属性是此供稿的完全解析的 XML 文档 节点。可以使用浏览器中内置的 XML 功能（例如 getElementsByTagName）访问此文档。

混合结果格式

如果您请求 google.feeds.Feed.MIXED_FORMAT 结果格式，则会在feed供稿结果xmlDocument中显示 JSON 属性和 XML DOM 属性。有关详细信息，请参见上面的 JSON 文档和 XML 文档。

除了这些属性之外，JSON 结果数组中的每个 entry 均将具有一个附加的 xmlNode 属性。该属性是指向 XML 元素的指针，表示供稿 XML 文档中的条目。对于 Atom 供稿，xmlNode 指向此条目的 元素。对于 RSS 供稿，xmlNode 指向此条目的 元素。

FindResult 格式

findFeeds() 方法在供稿查询完成时将会调用具有单个结果的回调函数参数。结果具有以下结构：

• <根>
  • error?
    载入供稿出错时显示
    • code
      HTTP 样式的错误代码
    • message
      用户可读的错误字符串说明
  • entries[]
    匹配给定的查询字符串的供稿列表（最多有 10 供稿）。
    • title
      供稿标题。
    • link
      供稿的 HTML 版本的网址。
    • contentSnippet
      内容的片断版本（小于 120 个字符）。
    • url
      实际供稿的网址。

LookupResult 格式

lookupFeed() 方法在供稿查找完成时将会调用具有单个结果的回调函数参数。结果具有以下结构：

• <根>
  • error?
    载入供稿出错时显示
    • code
      HTTP 样式的错误代码
    • message
      用户可读的错误字符串说明
  • url
    关联供稿的网址（如果存在）。

Flash 和其他非 Javascript 环境^新增！

对于 Flash 开发人员以及需要从其他非 Javascript 环境中访问 Google AJAX 供稿 API 的开发人员，该 API 提供了一个简单的 RESTful 界面。在所有情况下，支持的方法均为 GET，响应格式为 JSON 已编码结果（具有嵌入的状态代码）。使用此界面的应用程序必须遵守所有现有的使用条款。需要特别注意的是要在您的请求中正确标识自己。应用程序必须始终在其请求中包含一个有效且准确的 http 参考标头。此外，我们要求（但不命令）每个请求包含一个有效的 API 密钥。通过提供密钥，您的应用程序可以向我们提供辅助的识别机制，这在我们需要联系您以纠正问题时会很有用。请阅读有关 API 密钥的作用的详细信息

与核心 Javascript 界面一样，通过包含标准 CGI 参数和方法特定的 CGI 参数的统一网址显示此界面。您的应用程序可以使用其选择的 http 堆栈。唯一的要求是您必须能够使用所有 CGI 参数构建一个结构正确的网址，发送一个可以准确标识您应用程序的 http 参考标头以及能够处理经过 JSON 编码的响应。

标准网址基本地址

每个供稿 API 方法均通过一个标准网址进行访问。下表列出了用于访问每个方法的网址。

标准网址参数

每个请求均包含标准网址参数以及一组可选的方法特定的参数。本节介绍了在所有方法中都一致并且向每个方法传递几乎相同的语义信息的标准参数。在某些情况下，参数是可选的。通过参数名称后的 ? 指示。在所有情况下，必须对 CGI 参数的值进行正确转义（例如，通过具有等效功能的 Javascript encodeURIComponent() 方法）。

下表列出了标准的网址参数。下面显示的其他部分着重介绍了方法特定的参数。

callbackFunction({
  "responseData" : {
    "feed" : {}
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
})
      

callbackFunction(
  contextValue,    // the context arg value
  responseObject,  // the method result
  responseStatus,  // 200 on success, non-200 on failure
  errorDetails)    // error string for non-200 response
      

标准响应格式

如以上章节中的简述，响应格式中有两种主要的形式。未提供 callback 和 context 参数时，响应格式是简单的 JSON 对象（与如下所示的三个代码段类似）：

载入供稿的 JSON 响应

{
  "responseData" : {
    "feed" : {}
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
}

查找供稿的 JSON 响应

{
  "responseData" : {
    "query" : query-string,
    "entries" : []
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
}

检查供稿的 JSON 响应

{
  "responseData" : {
    "query" : query-value -e.g.- original-url,
    "url" : primary-url-for-that-page
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
}

在上面的 JSON 片段中，请注意 responseData 属性包含一个 feed 对象，或者一个 query 属性和 entries 数组，或者一个 query 属性和 url 属性。此属性中返回的内容是要访问的供稿 API 方法的函数。有关其他信息，请查看结果格式讨论。请注意，在本部分文档中，介绍了一个可选的 error 对象。使用基于网址的协议时，error 属性不再可用。而是改为使用 responseStatus 和 responseDetails 属性。responseStatus 属性在成功时包含值 200，在失败时包含一个非 200 http 错误状态代码。如果失败，则 responseDetails 包含一个诊断字符串。

如果应用程序提供了 callback 参数而未指定 context 参数，那么，该应用程序将能够接收相同的对象，但前提是将其作为第一个参数传递到应用程序指定的回调中。

callbackFunction({
  "responseData" : {
    "query" : query-value -e.g.- original-url,
    "url" : primary-url-for-that-page
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
})

如果应用程序提供了 callback 和 context 参数，那么，该响应将作为 JavaScript 程序调用进行编码。在此操作模式下，callback 的值将变为程序调用目标，context 的值作为第一个参数传递，上面介绍的 responseData 的值作为第二个参数传递，响应状态作为第三个参数传递，最后一个参数为 null 或诊断字符串。

foo('bar', {
 "feed": {
  "title": "Digg",
  "link": "http://digg.com/",
  "author": "",
  "description": "Digg",
  "type": "rss20",
  "entries": [
   {
    "title": "The Pirate Bay Moves Servers to Egypt Due to Copyright Laws",
    "link": "http://digg.com/tech_news/The_Pirate_Bay_Moves_Servers_to_Egypt_Due_to_Copyright_Laws",
    "author": "",
    "publishedDate": "Mon, 31 Mar 2008 23:13:33 -0700",
    "contentSnippet": "Due to the new copyright legislation that are going ...",
    "content": "Due to the new copyright legislation that are going to take...",
    "categories": [
    ]
   },
   {
    "title": "Millions Dead/Dying in Recent Mass-Rick-Rolling by YouTube.",
    "link": "http://digg.com/comedy/Millions_Dead_Dying_in_Recent_Mass_Rick_Rolling_by_YouTube",
    "author": "",
    "publishedDate": "Mon, 31 Mar 2008 22:53:30 -0700",
    "contentSnippet": "Click on any \u0022Featured Videos\u0022. When will the insanity stop?",
    "content": "Click on any \u0022Featured Videos\u0022. When will the insanity stop?",
    "categories": [
    ]
   },
   ...
  ]
 }
}
, 200, null)

载入供稿特定的参数

载入供稿方法支持许多可选参数，如下所示：

查找供稿特定的参数

查找供稿方法没有附加参数。所有参数均在上面列出。

检查供稿特定的参数

检查供稿方法没有附加参数。所有参数均在上面列出。