Previous Next

Google Base の使用法

Google Base データ API は、開発者が以下のことを行えるように設計されています。

  • Google Base のデータに対して問い合わせを行うアプリケーションやマッシュアップを作成する

  • Google Base のアイテムをプログラム上で登録したり管理したりする

アイテムのフィードには二種類があります。snippets フィードと customer items フィードです。 snippets フィードにはすべての Google Base のデータが含まれ、 認証なしで誰でも問い合わせることができます。 customer items フィードは特定の顧客に特化したデータの一部で、 そのカスタマー/オーナーだけがフィードにアクセスしてデータを追加、更新、削除することができます。 どちらのフィードに対しても、クエリの作成方法は同じです。

Google Base API についての詳細は » http://code.google.com/apis/base を参照ください。

Base サービスへの接続

Google Base API は、他の GData API と同様に Atom Publishing Protocol (APP) を使用しています。これは、ウェブベースのリソースを扱うための XML 形式のフォーマットです。クライアントと Booble Base サーバとの間は HTTP による通信を行い、認証済みの接続と未認証の接続の両方に対応しています。

トランザクションを実行するには、まずこの接続を作成する必要があります。 Base サーバへの接続を作成するには、次の二段階の手順を踏みます。 まずは HTTP クライアントを作成し、それから Zend_Gdata_Gbase サービスのインスタンスをそのクライアントにバインドします。

認証

Google Base API は、公開 (public) フィードと非公開 (private) フィードの両方にアクセスすることができます。 公開フィードへのアクセスには認証は不要です。 しかし読み込み専用のアクセスとなり、機能も制限されます。 非公開フィードに対してはほぼすべての機能を使用できますが、 Base サーバに対する認証済みの接続が必要となります。 Google Base がサポートする認証方式には三種類あります。

  • ClientAuth は、ユーザ名/パスワードによる認証を Base サーバに対して直接行います。 この方式では、アプリケーションが直接パスワードを扱う必要があります。 したがって、この認証方式を使うのは、他の方式が使えない場合のみにしましょう。

  • AuthSub は、Google プロキシサーバを経由した認証を行います。 ClientAuth と同じくらい簡単に使用でき、セキュリティのリスクもありません。 ウェブベースのアプリケーションでは、これが最も望ましい方式です。

Zend_Gdata ライブラリは、これら三種類の認証方式にすべて対応しています。 本章のこれ以降では、読者が認証方式についてよく知っていること、 そして認証済み接続の作成方法を知っていることを前提として説明を進めます。 詳細な情報は、Google Data クライアント認証 あるいは » Google Data API Developer's Guide の Authentication Overview を参照ください。

サービスのインスタンスの作成

Google Base に対する作業を行うために Zend_Gdata_Gbase サービスクラスが用意されています。 このクラスは Google Data および Atom Publishing Protocol に対する共通のインターフェイスを提供し、 Base サーバとの間のリクエストのやりとりを支援します。

使用する認証方式が決まったら、次に行うのは Zend_Gdata_Gbase のインスタンスを作成することです。 このクラスの引数には Zend_Http_Client のインスタンスを指定します。これが AuthSub および ClientAuth 認証へのインターフェイスとなる認証済みの HTTP クライアントです。 引数を省略した場合は、未認証の Zend_Http_Client のインスタンスを自動的に作成します。

以下の例は、ClientAuth 認証を使用した Base サービスクラスを作成するものです。



AuthSub を使用した Base サービスの作成方法も同様ですが、少し冗長になります。

 スクリプトの実行はここから始まります <-

// http://code.google.com/apis/gdata/reference.html#Queriesthat
// より、ユーザは正規のセッションを保持しています。そこで
// AuthSub セッショントークンを保存します
session_start();

// Base サービスのインスタンスを作成し、必要に応じて
// AuthSub サーバにリダイレクトします
$service = new Zend_Gdata_Gbase(getAuthSubHttpClient());

最後に、snippets フィード用の未認証のサーバを作成する方法を示します。



        

アイテムの取得

customer items フィードや snippets フィードに問い合わせて、 アイテムを取得することができます。 これは、まずクエリを送信して 返ってきたフィードを順に取得するという二段階の手順で行います。

構造化クエリの送信

構造化クエリを送信することで、あなた自身の customer items フィードや公開 snippets フィードの内容を問い合わせることができます。

Base API でデータを取得する際には、特別な構造のクエリ URL を使用してどんなイベントがほしいのかを指定します。 Zend_Gdata_Gbase_ItemQuery および Zend_Gdata_Gbase_SnippetQuery クラスのおかげで、この作業が簡単にできるようになります。 パラメータを指定すると、これらのクラスがクエリ URL を作成してくれるのです。

Customer Items フィードに対する問い合わせ

customer items フィードに対するクエリを実行するには newItemQuery() メソッドおよび getGbaseItemFeed() メソッドを実行します。

newItemQuery();
$query->setBq('[title:Programming]');
$query->setOrderBy('modification_time');
$query->setSortOrder('descending');
$query->setMaxResults('5');
$feed = $service->getGbaseItemFeed($query);

使用できるパラメータの一覧は、Customer Items フィードのドキュメントにある »  クエリパラメータのセクション を参照ください。

Snippets フィードに対する問い合わせ

公開 snippets フィードに対するクエリを実行するには newSnippetQuery() メソッドおよび getGbaseSnippetFeed() メソッドを実行します。

newSnippetQuery();
$query->setBq('[title:Programming]');
$query->setOrderBy('modification_time');
$query->setSortOrder('descending');
$query->setMaxResults('5');
$feed = $service->getGbaseSnippetFeed($query);

使用できるパラメータの一覧は、Snippets フィードのドキュメントにある »  クエリパラメータのセクション を参照ください。

アイテムに対する順次処理

Google Base のアイテムには、<g:main_ingredient><g:weight> といったアイテム固有の属性が含まれています。

指定したアイテムのすべての属性を順に処理するには、 getGbaseAttributes() を実行してその結果を処理します。

entries as $entry) {
  // すべての属性を取得し、各属性について名前とテキスト値を表示します
  $baseAttributes = $entry->getGbaseAttributes();
  foreach ($baseAttributes as $attr) {
    echo "属性 " . $attr->name . " : " . $attr->text . "
"; } }

あるいは、特定の属性の名前を指定してそれにマッチする結果を取得することもできます。

entries as $entry) {
  // すべての主原料  を表示します
  $baseAttributes = $entry->getGbaseAttribute("main_ingredient");
  foreach ($baseAttributes as $attr) {
    echo "主原料: " . $attr->text . "
"; } }

Customer Items の追加、更新、削除

カスタマー/オーナーは、自分自身の Customer Items フィードに対する追加、更新あるいは削除を行うことができます。 これらの操作は、公開 snippets フィードに対して行うことはできません。

実際に処理を行う前に、どのような操作が行われるのかを確かめることができます。 その場合は dry-run フラグ ($dryRun) を true に設定します。期待通りの結果が得られることを確認したら、このフラグを false にして実際の操作を行います。

アイテムの追加

アイテムを追加するには、Base サービスの insertGbaseItem() メソッドを使用します。

newItemEntry();

// タイトルを追加します
$title = "PHP Developer Handbook";
$newEntry->title = $service->newTitle(trim($title));

// コンテンツを追加します
$content = "Essential handbook for PHP developers.";
$newEntry->content = $service->newContent($content);
$newEntry->content->type = 'text';

// 製品の型を定義します
$itemType = "Products";
$newEntry->itemType = $itemType;

// アイテム固有の属性を追加します
$newEntry->addGbaseAttribute("product_type", "book", "text");
$newEntry->addGbaseAttribute("price", "12.99 USD", "floatUnit");
$newEntry->addGbaseAttribute("quantity", "10", "int");
$newEntry->addGbaseAttribute("weight", "2.2 lbs", "numberUnit");
$newEntry->addGbaseAttribute("condition", "New", "text");
$newEntry->addGbaseAttribute("author", "John Doe", "text");
$newEntry->addGbaseAttribute("edition", "First Edition", "text");
$newEntry->addGbaseAttribute("pages", "253", "number");
$newEntry->addGbaseAttribute("publisher", "My Press", "text");
$newEntry->addGbaseAttribute("year", "2007", "number");
$newEntry->addGbaseAttribute("payment_accepted", "Google Checkout", "text");

$dryRun = true;
$createdEntry = $service->insertGbaseItem($newEntry, $dryRun);

アイテムの変更

アイテムの各属性要素の値を変更することができます。

title = $service->newTitle($newTitle);

//  属性を探し、価格を更新します
$baseAttributes = $entry->getGbaseAttribute("price");
if (is_object($baseAttributes[0])) {
  $newPrice = "16.99 USD";
  $baseAttributes[0]->text = $newPrice;
}

//  属性を探し、ページ数を更新します
$baseAttributes = $entry->getGbaseAttribute("pages");
if (is_object($baseAttributes[0])) {
  $newPages = "278";
  $baseAttributes[0]->text = $newPages;

  // 属性の型を "number" から "int" に変更します
  if ($baseAttributes[0]->type == "number") {
    $newType = "int";
    $baseAttributes[0]->type = $newType;
  }
}

//  属性を削除します
$baseAttributes = $entry->getGbaseAttribute("label");
foreach ($baseAttributes as $note) {
  $entry->removeGbaseAttribute($note);
}

// 新たな属性を追加します
$entry->addGbaseAttribute("note", "PHP 5", "text");
$entry->addGbaseAttribute("note", "Web Programming", "text");

// エントリオブジェクトの save() を実行して変更内容を保存します
$dryRun = true;
$entry->save($dryRun);

// あるいは、サービスオブジェクトの updateGbaseItem() をコールして変更を保存します
// $dryRun = true;
// $service->updateGbaseItem($entry, $dryRun);

変更した後は、Zend_Gdata_Gbase_ItemEntry オブジェクトの save($dryRun) メソッドを実行するか Zend_Gdata_Gbase オブジェクトの updateGbaseItem($entry, $dryRun) メソッドをコールしてその内容を保存する必要があります。

アイテムの削除

アイテムを削除するには、deleteGbaseItem() メソッドをコールします。

deleteGbaseItem($entry, $dryRun);

あるいは、Zend_Gdata_Gbase_ItemEntry オブジェクトの delete() を実行することもできます。

delete($dryRun);
Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
Introduction
Captcha Operation
Captcha Adapters
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Console_Getopt
Getopt について
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ: Zend_Controller_Router_Rewrite
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
以前のバージョンからの移行
Zend_Currency
Zend_Currency について
通貨の操作方法
以前のバージョンからの移行
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Debug
変数の出力
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helpers
Dojo Form Elements and Decorators
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Validators for Zend_File_Transfer
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
Gdata について
AuthSub による認証
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
YouTube Data API の使用法
Picasa Web Albums の使用法
Gdata の例外処理
Zend_Http
Zend_Http_Client - 導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
JSON オブジェクト
XML から JSON への変換
Zend_Json_Server - JSON-RPC server
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
ロケールがサポートする言語
ロケールがサポートする地域
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
Introduction
Usage
Configuration
Advanced usage
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ドキュメントのページ
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery. Introduction
Class autodiscovering.
Functions autodiscovering.
Autodiscovering. Datatypes.
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework のシステム要件
PHP のバージョン
PHP の拡張モジュール
Zend Framework のコンポーネント
Zend Framework の依存性
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
著作権に関する情報