Google Diacritize APIのドキュメント(RESTの使い方)

前回、前々回に続いて、Google Diacritize APIのドキュメントの翻訳です。


Google Diacritize APIとは、
ネイティブでない人向けに

テキストに対応する発音記号を返す

GoogleのAPI(Application Programin Interface)です。

Google Language API Familyに含まれます。
現在のステータスはLabsになっていますので、
今後変更もありえます。


今回は、Google Diacritize APIのRESTの使い方です。


Developer's Guide (v1): Using REST

重要:このバージョンのGoogle Diacritize APIはin Labsの状態で、この機能は次の段階に進むまでに予告なしに変更される場合があります。

このドキュメントはGoogle Diacritize API v1でRESTfulな呼び出しのスタイルを利用する上での共通機能の使い方を説明しています。

Contents
･Introduction
･Working with results
･Query parameter reference

Introduction
このドキュメントは、Google Diacritize APIと相互に機能するアプリケーションを書きたい開発者向けです。Google Tashkeel(またはDiacritize)で、ウェブページやアプリケーションのテキストに発音記号を付加することができます。

Google Diacritizeのコンセプトについては、コーディングを行う前にGetting Started(翻訳)をお読みください。

重要:Google Diacritize APIはGoogle APIs consoleから取得できるAPI keyの使用が必須です。

Diacritize APIにリクエストを送った結果は、シンプルなJSONオブジェクトとして返されます。

Working with results
特定のURIへのHTTP GETリクエストを送ると、文字列に対する発音記号が付加されたテキストを取得することができます。リクエストを送るURIは、以下のフォーマットである必要があります:

https://www.googleapis.com/language/diacritize/v1?parameters


3つのクエリのパラメータが、それぞれの翻訳リクエストについて必要です:
･API key　あなたのアプリケーションを識別する、keyクエリパラメータを使用します。
･Language　提供する文字列の言語を識別する、langクエリパラメータを使用します。現在、ar(Arabic)が唯一の有効な言語です。
･Source text string　発音記号と共に返される文字列を識別する、messageクエリパラメータを使用します。

その他の全てのクエリパラメータは、オプションです。

これがサンプルです:

GET  https://www.googleapis.com/language/diacritize/v1?key=INSERT-YOUR-KEY&lang=ar&message=%D9%85%D8%AB%D8%A7%D9%84%20%D9%84%D8%AA%D8%B4%D9%83%D9%8A%D9%84&last_letter=false


リクエストが成功すると、サーバーはHTTP 200 OKステータスコードとデータプロパティを返します:
JSON

200 OK

{
 "data": {
  "diacritized_text": "مِثَال لِتَشْكِيل"
 }
}


Query parameter reference
カスタムサーチAPIで利用できるクエリパラメータは、以下の表に要約されています。全てのパラメータの値はURLエンコードを必要とします。

パラメータ名	意味	説明
callback	レスポンスを受け取った時点で実行されるJavaScript関数	･純粋なクライアントサイドの実装においてクエリの結果を扱うJavaScript関数を指定することができます。 ･<script>タグ内にAPIクエリを埋め込む ･<script>タグ内のコールバックメソッドを識別する ･Getting StratedドキュメントのREST from JavaScriptにサンプルがあります。
key	あなたのAPIキー	･このAPIは、全てのリクエストに識別キーが必要です。 ･Google API consoleからキーを取得してください。
lang	言語	･メッセージの言語名です。現在では、ar(Arabic)のみが使用可能な言語です。
last_letter	発音記号を最後の文字にする	それぞれの単語の最後の文字の後に発音記号を付加するかどうか、指定することができます。有効な値はtrue(記号を付加する)またはfalse(最後の文字の後に記号を付加しない)の2つです。 ･デフォルトの値はlast_letter=trueです。
message	クエリ	･発音記号を付加するテキストです。
prettyprint	レスポンスの改行と字下げ	･prettyprint=trueの場合、サーバーによって、人間に読めるような形に変換して(pretty printed)結果が返されます。 ･デフォルトの値は、prettyprint=falseです。

---

アラビア語しか使えないのか･･･。


インストール不要･無料のKaede翻訳ツール：
http://kaedetrans.appspot.com/