スタート ガイド: gadgets.* API

Gadgets API にようこそ。

このデベロッパー ガイドは、ガジェット JavaScript API の gadgets.* バージョンに基づいています。プログラミングとサポートの際にわかりやすい API を提供するため、Gadgets API は gadgets.* JavaScript 名前空間に再編成されました。gadgets.* API について詳しくは、こちらの Gadgets API リファレンスをご覧ください。gadgets.* API は、レガシー Gadgets API と大幅に重複していますが、重要な違いもいくつかあります。

現在、コンテナ (ガジェットを実行するサイトやアプリケーション) の一部だけが gadgets.* API をサポートしています。gadgets.* API をサポートしているコンテナの一覧は、OpenSocial コンテナのリストをご覧ください。一部の古いコンテナでは、レガシー Gadgets API しかサポートされていないので、使用する特定のコンテナのドキュメントで、サポートされている API を必ず確認してください。ガジェットのさまざまなタイプと、その実行場所について詳しくは、Gadgets API 概要をご覧ください。

すべてのコンテナは、gadgets.* API をサポートするかどうかに関係なく、レガシー API をサポートします。ただし、gadgets.* API はレガシー API に含まれない多くの新しい機能を提供するため、可能な限りこれを使用する必要があります。

このデベロッパー ガイドは、Gadgets API を使用してガジェットを作成するデベロッパーの方を対象としています。ガジェットは簡単に作成できるので、ウェブ プログラミングの学習を始める良い出発点となります。

目次

  1. 「Hello, World」
  2. ガジェットでできること
  3. さらに詳しく

「Hello, World」

最も簡単なガジェットは、数行のコードで作成できます。次のガジェットは「Hello, world!」というメッセージを表示します。

<?xml version="1.0" encoding="UTF-8" ?> 
<Module>
<ModulePrefs title="hello world example" />
<Content type="html">
<![CDATA[ Hello, world! ]]> </Content>
</Module>

「Hello World」の例の詳細は次のとおりです。

  • ガジェットは XML で指定します。最初の行は、XML ファイルを始める標準の方法です。この行は、ファイル内の最初の行である必要があります。
  • <Module> タグは、この XML ファイルにガジェットが含まれていることを示します。
  • <ModulePrefs> タグには、ガジェットのタイトル、説明、作者、その他のオプション機能など、ガジェットに関する情報が含まれます。
  • <Content type="html"> という行は、ガジェットのコンテンツ タイプが HTML であることを示します。
  • <![CDATA[ ...insert HTML here... ]]> は、ガジェットのコンテンツ タイプが html の場合に HTML を囲むために使用します。これによって、CDATA 内のテキストを XML として処理しないように、ガジェットのパーサーに指示します。CDATA セクションには通常、HTML と JavaScript が含まれます。
  • </Content> は、コンテンツ セクションの末尾を示します。
  • </Module> は、ガジェット定義の末尾を示します。

ガジェットでできること

Gadgets API は、XML、HTML、JavaScript という少数の基本的要素で構成されています。作成を始めるのに必要なのは、HTML についての基本的な知識だけです。ガジェットを作成するのに必要な XML についての知識は、すべてここで説明します。JavaScript の知識がまだない場合は、後でより高度なガジェットを作成するときに、少しずつ学ぶことができます。

XML は汎用のマークアップ言語です。XML により、人間とコンピュータの両方が読み書きできる表現で構造化データを記述します。

XML はガジェットの仕様の記述に使用する言語です。ガジェットは、Google がアクセスできるインターネット上に配置された XML ファイルそのものです。ガジェットを規定する XML ファイルには、ガジェットを処理し、表示する方法を記載します。この XML ファイルに、ガジェットのデータとコードをすべて含めることも、別の場所にある一部の要素への参照 (URL) を含めることもできます。

HTML とは、インターネット上のページのフォーマット指定に使用するマークアップ言語です。ガジェットの静的コンテンツは、通常 HTML で記述します。HTML は XML に似ていますが、構造化データの記述よりも、ウェブ ドキュメントのフォーマット指定に使用されます。

JavaScript は、ガジェットの動的な動作を追加するために使用できるスクリプト言語です。

さらに詳しく

ソーシャル ガジェットを実行するコンテナには、それぞれ少しずつ異なる特性があります。ソーシャル ガジェットを開発する演習を始めるためのサイトをいくつか紹介します。

一般的なガジェットのプログラミングについて詳しくは、オリジナルのガジェットを作成をご覧ください。上記のサイトから、開発の基礎にアクセスするか、ドキュメントのホームページに戻って、セクションやトピックの概要をご覧ください。

トップへ戻る