小工具 API

• 主页
• 文档
• 常见问题解答
• 博客
• 网上论坛
• 条款

• 提交小工具
• Google 小工具编辑器

• 小工具 API

  • API 概述
  • 小工具。* 开发人员指南
    • 使用入门
    • 编写您自己的小工具
    • 开发基础
    • 开发人员工具
    • 创建用户界面
    • 处理远程内容
    • 国际化
    • 非英语小工具
    • 发布小工具
    • XML 参考
  • 小工具。* API 参考
  • 旧版开发人员指南
    • 使用入门
    • 编写您自己的小工具
    • 开发基础
    • 开发人员工具
    • 创建用户界面
    • 处理远程内容
    • 国际化
    • 非英语小工具
    • 发布小工具
    • API 参考
  • 

    更多小工具

    • 社区准则
    • 可视化 API
    • 社交小工具
    • 桌面小工具 API
    • 浏览网页小工具

使用入门：gadgets.* API

欢迎使用小工具 API！

该开发人员指南基于小工具 JavaScript API 的 gadgets.* 版本。小工具 API 已“重命名空间”为 gadgets.* JavaScript 命名空间，以为反对和支持的程序提供更为简洁的 API。要了解有关 gadgets.* API 的详细信息，请参阅此处的参考文档。虽然该 gadgets.* API 与传统的小工具 API 有明显重叠，但也有重要的不同之处。

目前，只有某些容器（容器是运行小工具的站点或应用程序）支持 gadgets.* API。要获取支持 gadgets.* API 的容器列表，请参阅“OpenSocial 容器列表”。某些较旧的容器仅支持传统的小工具 API，所以请确保查看特定容器的文档以确定哪些 API 受支持。要了解关于小工具的不同类型及其运行环境的详细信息，请参阅“小工具 API 概述”。

所有容器都支持传统的 API，而不论它们是否支持 gadgets.* API。但是，gadgets.* API 提供了许多传统 API 中所没有的新功能，所以可以的情况下，应该使用它。

本开发人员指南主要是针对想使用小工具 API 编写小工具的人员的。小工具非常容易创建，因此如果您刚学习网络编程，编写小工具是个不错的开始。

目录

1. “Hello, World”
2. 小工具中包含什么？
3. 从此处去向何处

“Hello, World”

最简单的小工具仅有几行代码。该小工具显示消息“Hello, World!”：

请注意以下有关“Hello World”示例的内容：

• 小工具是在 XML 中指定的。第一行是 XML 文件起始的标准方式。这必须是文件的第一行。
• 标签表示该 XML 文件包含小工具。
• 标签包含有关小工具的信息，如标题、说明、作者和其他可选功能。
• 行表示小工具的 Content 类型是 HTML。
• insert HTML here... ]]> 用于在小工具的 Content 类型为 html 时装入 HTML。它告诉小工具解析器 CDATA 部分中的文本不应视为 XML。CDATA 部分通常包含 HTML 和 JavaScript。
• 标识内容部分的结束。
• 标识小工具定义的结束。

小工具中包含什么？

小工具 API 包含一些简单的组件：XML、HTML 和 JavaScript。您仅需基本了解 HTML 便可开始使用。我们将会教给您编写小工具需要了解的关于 XML 的所有内容。日后，当您编写更为复杂的小工具时，如果您还不熟悉 JavaScript，您很可能还要再了解关于它的详细信息。

XML 是常用的标记语言。它以人和计算机都能理解的方式介绍了结构化数据。

XML 是用于编写小工具规范的语言。小工具仅是一个 XML 文件，位于互联网上 Goolge 能找到的某个位置。指定小工具的 XML 文件包含有关如何处理和显示小工具的说明。XML 文件可包含小工具的所有数据和代码，以及小工具页面其他内容的 url 地址。

HTML 是用于格式化互联网上的页面的标记语言。小工具的静态内容通常是用 HTML 编写的。HTML 看起来与 XML 类似，但它用于格式化网络文档而非描述结构化数据。

JavaScript 是可用于向小工具添加动态行为的脚本语言。

从此处去向何处

运行社交小工具的每个容器的特征都略有不同。以下是可获取一些开发社交小工具的实际经验的几处地方：

• 《适用于 iGoogle 的 OpenSocial 教程》
• 《iGoogle 测试区开发人员指南》，包含有关为 iGoogle 测试区开发小工具的信息。
• 《Orkut 测试区开发人员指南》，包含有关为 Orkut 测试区开发小工具的信息。

有关常规小工具编程的详细信息，请转至“编写您自己的小工具”。从那里，您可以转至“开发基础”或返回至文档主页，以获取各个部分和主题的概述。

返回页首