Translation API のクラス リファレンス

目次

グローバル メソッド

結果オブジェクト

翻訳結果

• <result>
  • error?
    フィードのロード エラーがあった場合に存在します。
    • code
      HTTP スタイルのエラー コード。
    • message
      人間が読めるエラー説明の文字列。
  • translation
    翻訳済みテキスト。
  • detectedSourceLanguage? ^New!
    翻訳元言語が自動特定された場合は、ここに返されます。

言語検出結果

• <result>
  • error?
    フィードのロード エラーがあった場合に存在します。
    • code
      HTTP スタイルのエラー コード。
    • message
      人間が読めるエラー説明の文字列。
  • language
    指定されたテキストに関連付けられている言語コードです。例については、Language 列挙を参照してください。
  • isReliable
    検出間隔にとって、指定されたテキストの言語コードが信頼できるかどうかを表すブール値です。
  • confidence
    指定されたテキストの言語コードの信頼レベルを表す 0～1.0 の数値です。

Languages 列挙New Languages!

google.language.Languages 列挙は、google.language.translate への srcLang 引数と destLang 引数および google.language.detect の result.language 結果として使用する名前定数から言語コードへのマッピングを提供します。これらは、Google 翻訳で使用されるコードと同じです。

var google.language.Languages = {
  'AFRIKAANS' : 'af',
  'ALBANIAN' : 'sq',
  'AMHARIC' : 'am',
  'ARABIC' : 'ar',
  'ARMENIAN' : 'hy',
  'AZERBAIJANI' : 'az',
  'BASQUE' : 'eu',
  'BELARUSIAN' : 'be',
  'BENGALI' : 'bn',
  'BIHARI' : 'bh',
  'BULGARIAN' : 'bg',
  'BURMESE' : 'my',
  'CATALAN' : 'ca',
  'CHEROKEE' : 'chr',
  'CHINESE' : 'zh',
  'CHINESE_SIMPLIFIED' : 'zh-CN',
  'CHINESE_TRADITIONAL' : 'zh-TW',
  'CROATIAN' : 'hr',
  'CZECH' : 'cs',
  'DANISH' : 'da',
  'DHIVEHI' : 'dv',
  'DUTCH': 'nl',  
  'ENGLISH' : 'en',
  'ESPERANTO' : 'eo',
  'ESTONIAN' : 'et',
  'FILIPINO' : 'tl',
  'FINNISH' : 'fi',
  'FRENCH' : 'fr',
  'GALICIAN' : 'gl',
  'GEORGIAN' : 'ka',
  'GERMAN' : 'de',
  'GREEK' : 'el',
  'GUARANI' : 'gn',
  'GUJARATI' : 'gu',
  'HEBREW' : 'iw',
  'HINDI' : 'hi',
  'HUNGARIAN' : 'hu',
  'ICELANDIC' : 'is',
  'INDONESIAN' : 'id',
  'INUKTITUT' : 'iu',
  'ITALIAN' : 'it',
  'JAPANESE' : 'ja',
  'KANNADA' : 'kn',
  'KAZAKH' : 'kk',
  'KHMER' : 'km',
  'KOREAN' : 'ko',
  'KURDISH': 'ku',
  'KYRGYZ': 'ky',
  'LAOTHIAN': 'lo',
  'LATVIAN' : 'lv',
  'LITHUANIAN' : 'lt',
  'MACEDONIAN' : 'mk',
  'MALAY' : 'ms',
  'MALAYALAM' : 'ml',
  'MALTESE' : 'mt',
  'MARATHI' : 'mr',
  'MONGOLIAN' : 'mn',
  'NEPALI' : 'ne',
  'NORWEGIAN' : 'no',
  'ORIYA' : 'or',
  'PASHTO' : 'ps',
  'PERSIAN' : 'fa',
  'POLISH' : 'pl',
  'PORTUGUESE' : 'pt-PT',
  'PUNJABI' : 'pa',
  'ROMANIAN' : 'ro',
  'RUSSIAN' : 'ru',
  'SANSKRIT' : 'sa',
  'SERBIAN' : 'sr',
  'SINDHI' : 'sd',
  'SINHALESE' : 'si',
  'SLOVAK' : 'sk',
  'SLOVENIAN' : 'sl',
  'SPANISH' : 'es',
  'SWAHILI' : 'sw',
  'SWEDISH' : 'sv',
  'TAJIK' : 'tg',
  'TAMIL' : 'ta',
  'TAGALOG' : 'tl',
  'TELUGU' : 'te',
  'THAI' : 'th',
  'TIBETAN' : 'bo',
  'TURKISH' : 'tr',
  'UKRAINIAN' : 'uk',
  'URDU' : 'ur',
  'UZBEK' : 'uz',
  'UIGHUR' : 'ug',
  'VIETNAMESE' : 'vi',
  'UNKNOWN' : ''
};

Languages ContentType 列挙 ^New!

google.language.ContentType 列挙は、翻訳テキストのコンテンツ タイプが受け取ることができるタイプ値を提供します。デフォルトでは、翻訳対象テキストは HTML として扱われ、適切なマークアップは翻訳結果に保存されます。

var google.language.ContentType = {
  'TEXT' : 'text',
  'HTML' : 'html'
};

Font Rendering Status 列挙 ^New!

google.language.FontRenderingStatus 列挙は、名前定数からフォント検出のサポートが存在するかどうかを示す値へのマッピングを提供します。「UNKNOWN」値は、フォント レンダリングのサポート検出 API が指定された言語をサポートしていないことを示します。

var google.language.FontRenderingStatus = {
  UNSUPPORTED: 0,
  SUPPORTED: 1,
  UNKNOWN: 2
};

Flash やその他 JavaScript を使用しない環境 ^New!

Flash のデベロッパーや、JavaScript を使用しない環境で AJAX Language API にアクセスする必要のあるデベロッパーに対して、API ではシンプルな RESTful インターフェースを公開しています。どの場合でも、サポートされるメソッドは GET で、応答の形式は、ステータスコードが埋め込まれた JSON エンコードされた結果です。このインターフェースを使用するアプリケーションは、既存のすべての利用規約に従うものとします。特に注意する必要があるのは、要求において自身を正しく識別することに関連する部分です。アプリケーションでは、有効かつ正確な HTTP referer ヘッダーを常に要求に含める必要があります。さらに、必須ではありませんが、それぞれの要求に有効な API キーを組み込んでください。キーを提供することで、アプリケーションにより二次的な識別構造が提供され、問題が発生した場合のコンタクトに使用できます。

コア Javascript インターフェースと同様に、このインターフェースは、標準 CGI 引数と、メソッド固有の CGI 引数の両方が混合したものを含む統一 URL を介して表示されます。アプリケーションは、自由な http スタックを使うことができます。必要な条件は、すべての必要な CGI 引数が指定された、正しい構築の URL を構築すること、使用しているアプリケーションを正確に識別する http referer ヘッダーを送信すること、および JSON エンコードされたレスポンスを処理できることだけです。

標準 URL 基本アドレス

各 Language API メソッドには、標準 URL を介してアクセスします。次の表に、各メソッドにアクセスするために使われる URL を示します。

標準 URL 引数

各リクエストには、標準 URL 引数と、メソッド固有の引数 (省略可能) が含まれます。このセクションでは、すべてのメソッドを通じて統一されている標準引数について説明します。この引数は、すべてのメソッドに対して実質的に同一の意味を持つ情報を伝達します。引数を省略できる場合もあります。その場合は、引数名の後に ? をつけて示します。すべての場合において、CGI 引数の値は正しくエスケープする必要があります（たとえば Javascript の encodeURIComponent() メソッドのような機能を使用します）。

次の表に、標準 URL 引数を示します。その次に、メソッド固有の引数を強調する追加のセクションがあります。

callbackFunction(
  {"responseData" : {
    "translatedText" : the-translated-text,
    "detectedSourceLanguage"? : the-source-language
  },
  "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
      

標準の応答形式

前のセクションで少し触れたように、応答形式には 2 つの主要なバリエーションがあります。callback 引数と context 引数を指定しない場合は、応答形式は以下に示すスニペットのようなシンプルな JSON オブジェクトになります。

Translate Language の JSON 応答

{
  "responseData" : {
    "translatedText" : the-translated-text,
    "detectedSourceLanguage"? : the-source-language
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
}

Detect Language の JSON 応答

{
  "responseData" : {
    "language" : the-detected-language,
    "isReliable" : the-reliability-of-the-detect,
    "confidence" : the-confidence-level-of-the-detect
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
}

上の JSON 断片では、responseData プロパティに JavaScript のバインドで使用できるプロパティと同じメソッド固有のプロパティが含まれていることに注意してください。詳細情報は、結果オブジェクトの説明を参照してください。ドキュメントのこの部分では、省略可能な error オブジェクトが説明されていることに注意してください。URL ベースのプロトコルを使う場合、error プロパティは決して存在しません。代わりに、responseStatus プロパティと responseDetails プロパティが使われます。responseStatus プロパティは、成功した場合は 200 の値を含み、失敗した場合は 200 以外の http エラー ステータス コードを含みます。障害があった場合、responseDetails に診断文字列が含まれます。

callback引数を使用することによって、アプリケーションは次のように容易に JavaScript コールバックを要求できます。

callbackFunction(
  {"responseData" : {
    "language" : the-detected-language,
    "isReliable" : the-reliability-of-the-detect,
    "confidence" : the-confidence-level-of-the-detect
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
})

アプリケーションが callback 引数と context 引数の両方を指定すると、レスポンスは JavaScript プロシージャ呼び出しとしてエンコードされます。この動作モードでは、callback の値はプロシージャ呼び出しのターゲットになり、context の値が最初の引数として渡され、responseData の値が 2 番目の引数として上から渡され、レスポンス ステータスが 3 番目の引数として渡され、最後の引数は null または診断文字列です。

foo('bar',{"translatedText":"Ciao mondo","detectedSourceLanguage":"en"},
    200, null)

Translate Language 固有の引数

Translate メソッドは、次の表に示すいくつかの省略可能な引数をサポートします。

Detect Language 固有の引数

Detect Language メソッドに追加の引数はありません。すべての引数が上の表に記載されています。

バッチ インターフェース ^New!

RESTful フレームワークのみで使用できるバッチ インターフェースでは、q 引数または langpair 引数、あるいはその両方を使用して、単一の呼び出しで複数の翻訳を実行できます。応答は、次の例のように responsData の配列で構成されます。バッチ呼び出しには、次の 3 つの有効な組み合わせがあります。

1. すべて同じ翻訳元言語の文字列をいくつか同じ翻訳先言語に翻訳します。これは、複数の q 引数を使用して行います。次に例を挙げます。
   
   2 つの文字列の翻訳
   
   
2. 1 つの文字列を複数の言語に翻訳します。これは、複数の langpair 引数を使用して行います。次に例を挙げます。
   
   2 つの言語への翻訳
   
   
3. いくつかの文字列を異なる言語で翻訳します。この場合、順番にペアになった langpair 引数と同じ数の q 引数が必要です。
   
   2 つの文字列の翻訳（それぞれを個別の言語に）