×

[PR]この広告は3ヶ月以上更新がないため表示されています。
ホームページを更新後24時間以内に表示されなくなります。



>> ユーザーガイド >> 開発環境 >> プロジェクトの管理 | 共同開発者 | ライブラリーの管理 | バージョンの管理


ライブラリーの管理

ライブラリーはその機能を利用できるような、あなたや他の開発者を含めることのできるプロジェクトのことです。 適切なライブラリーの書き方、取り込み方、使用方法については、以下のセクションを参照してください。


WWW GoogleStyle


ライブラリーの管理

・ ライブラリーへのアクセス権の取得とプロジェクトへの取り込み ------

  1. プロジェクト内にライブラリーを取り込むには、少なくとも読み取りレベルのアクセス権を持っている必要があります。目的のライブラリーの作成者でない場合は、作者に連絡してアクセス権の付与をリクエストする必要があります。
  2. 取り込む場合にはライブラリーのプロジェクトキーが必要になります。ライブラリーへのアクセス権を持っているならば、File > Project Properties...とたどればプロジェクトキーを見つけることができます。 アクセス権がないときは、ライブラリの作成者にプロジェクトキーを付与してくれるように依頼する必要があります。
  3. Resources > Manage Libraries...と選択してください。

  4. 利用したいライブラリーのプロジェクトキーをFind a Libraryのテキストボックスへ貼り付けます。
  5. Selectをクリックします。

  6. 認証エラーが発生したら、取り込もうとしているプロジェクトに対して少なくとも読み取りレベルのアクセス権を持っていることを確認してください。

  7. ライブラリーはプロジェクトのライブラリーリストに追加されます。
  8. ドロップダウンのVersions(バージョン)をクリックして、使用したいこのライブラリのバージョンを選択します。

  9. デフォルトの識別子名がこのライブラリで使用したいものであるかどうかをチェックします。これはオートコンプリートで表示される名前です。 たとえば、もしTESTという名前で設定したならばTest.libraryMethodとしてライブラリーのメソッドを呼び出すことができます。

  10. 注意!!設定しようとする名前がすでにUiAppや既に存在しているサービスの名前、または以前に追加したライブラリーであった場合、既存のサービス/ライブラリーが直近で追加しようとしているライブラリーによって上書きされます。

  11. 選択したバージョンを上書きする場合は、Development Mode(開発モード)を有効にします。詳細はテストとデバッグを見てください。
  12. 追加したライブラリーを保存するためにSaveをクリックしてダイアログボックスを閉じます。

・ ライブラリーの利用 ----------------------------------------------

取り込まれたライブラリーはデフォルトのサービスを利用するときと同じように使用することができます。
たとえば、ライブラリーのTESTという識別子を選択した場合、しばらくの間、TESTと打ち込むとライブラリーのメソッドリストのオートコンプリート情報が表示されます。

取り込んだライブラリーのリファレンスドキュメントは次の手順で開くことができます。

  1. Resources > Manage Libraries...を選択します。
  2. 取り込んだライブラリーの名前は、そのライブラリーのリファレンスドキュメントを新規のブラウザタブで開くリンクになっています。

・ ライブラリーの削除 ----------------------------------------------

  1. Resources > Manage Libraries...を選択します。
  2. 削除用のライブラリーの右にある"×"ボタンをクリックします。
  3. 変更を有効にするためにSaveをクリックします。
ライブラリーが作成者によって削除された場合は、取り込んだライブラリーの一覧からそれを削除する必要があります。


ライブラリーの作成

・ ライブラリーの共有 ----------------------------------------------

ライブラリーの共有には3つのことが必要になります。第一に、すべての潜在的なユーザーのためにプロジェクトに少なくとも読み取りレベルのアクセス権を付与する必要があります。 第二に、File > Project Properties...にあるライブラリーのプロジェクトキーを提供します。最後に、保存されたスクリプトのバージョンを少なくともひとつ所持しなければいけません。 詳細はCreating a versionを参照してください。

・ ライブラリーを書くためのベストプラクティス ----------------------

ライブラリーを作成するときのためのガイドラインを示します。

  1. ライブラリーが他のユーザーに取り込まれるとデフォルトの識別子として利用されるので、プロジェクトのネーミングを分かりやすいものにします。
  2. ライブラリーの利用ユーザーに対して、ひとつもしくはそれ以上のスクリプトのメソッドを非表示(利用不可)にしたいのなら、下線付きメソッド名を利用してください。 たとえば、myPrivateMethod_()などのようにです。
  3. ユーザーに対して、スクリプトエディタのオートコンプリート機能や自動的に生成されたドキュメントを利用させるときは、すべての関数にJSDocスタイルのドキュメントにする必要があります。 次に例を示します。

    
    
    /** * Raises a number to the given power, and returns the result. * * @param {number} base the number we're raising to a power * @param {number} exp the exponent we're raising the base to * @return {number} the result of the exponential calculation */
    function power(base, exp) { ... }

@paramと@returnタグは現在サポートされている唯一のものです。

・ リソースのスコープ ----------------------------------------------

ライブラリーを利用しているときのリソースには共有と非共有の二つのタイプがあります。

共有リソースの意味するところは、ライブラリーと取り込んだスクリプトのどちらも同一のリソースのインスタンスへのビルトイン・アクセスができることです。 ユーザー・プロパティの例を使用して共有リソースを図示すると次のようになります。

非共有リソースの場合は、ライブラリーと取り込んだスクリプトのどちらもそれぞれのリソースのインスタンスへのビルトイン・アクセスしかできません。。 しかし、ライブラリーはそれらを操作する明示的な関数を持つことによって非共有リソースへのアクセスを提供できます。 ライブラリーに取り込まれている関数のプロパティを表示する例は次のようになります。


function
getLibraryProperty(key) {
return
ScriptProperties.
getProperty(key); }

スクリプトプロパティの例を利用して非共有リソースを図示すると次のようになります。

参照のために共有および、非共有のリソースを表に示します。

リソース共有非共有ノート
Lockライブラリー内でスクリプトが作成されたとき、すべての取り込みスクリプトに対して同一インスタンスは可視化
Script Propertiesライブラリー内でスクリプトが作成されたとき、すべての取り込みスクリプトに対して同一インスタンスは可視化
Cacheライブラリー内でスクリプトが作成されたとき、すべての取り込みスクリプトに対して同一インスタンスは可視化
GUI Builderライブラリー内でスクリプトが作成されたとき、すべての取り込みスクリプトに対して同一インスタンスは可視化
Triggersライブラリー内で作成された単純なトリガーは取り込みスクリプトではトリガーされない
ScriptApp
UiApp
User Properties
Logger and execution transcript
Sites, Spreadsheets and other containersgetActive()への呼び出しは取り込まれたスクリプトのコンテナを返す
MailApp and GmailApp
[共有]; ライブラリーそれ自身は機能/リソースの独自のインスタンスを持っていないので、代わりに呼び出されたスクリプトによって作成されたものを使用しています。

[非共有]; ライブラリーそれ自身が機能/リソースの独自のインスタンスを持っており、ライブラリーを利用するすべてのスクリプトは共有されて同一インスタンスへのアクセスを持っています。

・ テストとデバッグ ----------------------------------------------

取り込んだライブラリーのあるプロジェクト内でデバッガを使用している場合、ライブラリの関数にステップインすることができます。 デバッガーに表示されるコードは読み取り専用モードの正当なバージョンです。現在のところライブラリーの内部でブレークポイントを設定することはできません。

ライブラリーを書いてテストするときはDevelopment Modeでなければいけません。開発モードがオンになったら正しくは次のようになります。

  1. スクリプトへの編集レベルのアクセス権を持つ人は、スクリプトがバージョンとして保存されていない場合でもライブラリープロジェクト内のファイルに最新の変更を加えます。
  2. オートコンプリートは選択されたバージョンに基づいて生成されます。
  3. スクリプトへの読み取りレベルのアクセス権を持つ人はだれでも開発モードのオン・オフに関係なく選択したバージョンを使用できます。
少なくともライブラリーの1つのバージョンが保存されていることが必要です。

2012-10-14


pageTOP