| Anchor | ||||
|---|---|---|---|---|
|
Overview
When new functionality is added to the Javascript API, the version number will be increased. Clients can include a version number in an API request. As long as the server supports the requested version, it will return a response that the client can understand.
Minor version changes are intended to be backwards compatible, and the server may respond with a later version than the client requests. For example, if the client requests version 2.0, the server may send a response with the version set to 2.1.
Any major API changes will be reflected by a major version number change. The server will always send back a response using the same major version number that the client requested. If the server cannot sent a response using the same major version number, an error will be returned.
...
Version
...
概要
Javascript APIに新しい機能が追加されると、バージョン番号が上がります。クライアントはAPIリクエストにバージョン番号を含めることができます。サーバーは、リクエストされたバージョンをサポートする限り、クライアントが理解できる応答を返します。
マイナーバージョンの変更は下位互換性を意図しているため、サーバーはクライアントがリクエストしたよりも後のバージョンで応答する可能性があります。たとえば、クライアントがバージョン2.0をリクエストしている場合に、サーバーがバージョンを2.1に設定して応答を送信することがあります。
APIの大幅な変更は、メジャーバージョン番号を変更することで反映されます。サーバーは、常にクライアントがリクエストしたのと同じメジャーバージョン番号を使用して応答を返します。サーバーが同じメジャーバージョン番号を使用して応答を送信できない場合は、エラーが返されます。
バージョン | 説明 |
|---|---|
1.0Initial | Release of the Javascript API. Includes support for unsecure reports only, with no user authentication. |
1.1Update to | include user authentication. |
2.0Major | updates to the Javascript API. Includes support for embedding dashboards, enhanced filtering on reports and dashboards, and a lot of usability and UI enhancements. |
2.1Update to support loading | reports and filters by universal identifiers. |