DataAPI SDK japanese MT.DataAPI Constructor

コンストラクタ

パラメータ

パラメータ名	タイプ	必須	説明
options	Object	*	オプション
options.clientId	String	*	クライアントID アルファベット、(_)アンダースコア、(-)ダッシュ、で構成された任意の文字列を指定できます
options.baseUrl	String	*	DataAPIのCGIへの絶対パス (例: http://example.com/mt/mt-data-api.cgi)
options.format	String		データをシリアライズするフォーマット
options.sessionStore	String		セッション情報の保存方法 デフォルトでは、ブラウザではクッキーが利用されます
options.sessionDomain	String		セッションのドメイン クッキーを利用する場合、クッキーのドメインとして利用されます
options.sessionPath	String		セッションのパス クッキーを利用する場合、クッキーのパスとして利用されます
options.async	String		真の場合、非同期でHTTPリクエストを送信します デフォルト値は真です
options.timeout	Number		HTTPリクエストのタイムアウトまでの時間をミリ秒で指定します デフォルト値は設定されておらず、指定しない場合にはブラウザのデフォルトが利用されます
options.withoutAuthorization	Boolean		真の場合、アクセストークンを取得済みでも認証用ヘッダをHTTPリクエストに含めず、未認証の状態でリクエストを行います デフォルト値は偽です
options.loadPluginEndpoints	Boolean		真の場合、オブジェクトのインスタンスを作成する際にData APIへリクエストを発行し、プラグインで拡張されたエンドポイントへアクセスするためのメソッドを自動で追加します デフォルト値は真です (このオプションに偽を指定した場合にも、Data APIのコアで定義されているエンドポイントへアクセスするためのメソッドは利用できます)
options.suppressResponseCodes	Boolean		真の場合、全てのHTTPリクエストに"suppressResponseCodes"パラメータを付加し、HTTPのレスポンスコードが200になるようにData APIに要求します デフォルト値は設定されていません。指定しない場合にはXMLHttpRequestかIFRAMEで送信される場合には偽、XDomainRequestで送信される場合には真としてリクエストが送信されます
options.crossOrigin	Boolean		真の場合、クロスオリジン向けの設定でHTTPリクエストが送信されます デフォルト値は設定されておらず、指定しない場合には現在のドキュメントのURLとbaseUrlから自動的に設定されます
options.cache	String		偽の場合、HTTPリクエストにキャッシュを回避するためのパラメータ"_"が自動で付加されます デフォルト値は真です
options.disableFormData	String		偽の場合、ブラウザに実装されていればHTTPリクエストの送信時にFormDataオブジェクトを利用します デフォルト値は偽です

例

最小限のオプションを指定

var api = new MT.DataAPI({
  clientId: "your-client-id",
  baseUrl:  "https://your-host/mt/mt-data-api.cgi"
});

全てのオプションを指定

var api = new MT.DataAPI({
  clientId: "your-client-id",
  baseUrl:  "https://your-host/mt/mt-data-api.cgi",
  format: "json",
  sessionStore: "cookie",
  sessionDomain: "your-host",
  sessionPath: "/client-app/",
  async: true,
  timeout: 1000,
  withoutAuthorization: false,
  loadPluginEndpoints: true,
  suppressResponseCodes: false,
  crossOrigin: false,
  cache: true,
  disableFormData: false
});

Node.js で利用する場合の指定

var api = new MT.DataAPI({
  clientId: "your-client-id",
  baseUrl:  "https://your-host/mt/mt-data-api.cgi",
  sessionStore: "fs",
  sessionPath: "/home/your-login/.mt-data-api.json"
});