【Script Propertiesの魅力】簡単な使い方と実用的なサンプルコードでスクリプト管理を効率化！

2024年9月26日

Script Properties の基本的な機能と構文

おおきに、みんな！今日はGoogle Apps Script（GAS）で「Script Properties」についてお話しするで！これ、あんまり使ったことないかもしれんけど、めっちゃ便利やねん。まず、Script Propertiesは、スクリプトの中で使う設定情報やデータを保存するための場所や。たとえば、APIのキーとか、特定の設定値を保存しておくのに使えるんやで。

基本的な機能

データの保存: スクリプト実行中に必要な情報を簡単に保存できる。
データの取得: 保存したデータをいつでも取り出せる。
データの削除: もういらんデータは簡単に消せる。

構文と必要なパラメータ

Script Propertiesを使うには、以下のような構文を使うんや。基本的に、次のメソッドを使うことが多いで。

setProperty(key, value): 指定したキーに対して値を設定する。
getProperty(key): 指定したキーから値を取得する。
deleteProperty(key): 指定したキーの値を削除する。
getProperties(): 全てのプロパティをオブジェクトとして取得する。

サンプルコード

それじゃ、実際に使ってみよか！以下のサンプルコードを見てみてな。

function sampleScriptProperties() {
  const scriptProperties = PropertiesService.getScriptProperties();

  // データを設定する
  scriptProperties.setProperty('API_KEY', '12345-ABCDE');

  // データを取得する
  const apiKey = scriptProperties.getProperty('API_KEY');
  Logger.log('取得したAPIキー: ' + apiKey);

  // データを削除する
  scriptProperties.deleteProperty('API_KEY');
  Logger.log('APIキーを削除しました。');

  // 全てのプロパティを取得する
  const allProperties = scriptProperties.getProperties();
  Logger.log('全てのプロパティ: ' + JSON.stringify(allProperties));
}

このコードを実行すると、APIキーを設定して、取得して、削除するって流れがわかるで！Logger.logを使ってるから、実行結果は「ログ」を見て確認してな。

これでScript Propertiesの基本はバッチリや！次はもっと面白い使い方を探していこうや！

Script Properties コードのサンプル事例

さあ、みんな！今度はScript Propertiesの具体的な使い方を見ていくで！単純な例から、ちょっと複雑な例、さらには他のメソッドとの組み合わせも紹介するから、しっかりついてきてな！

単純な使用例

まずは、シンプルな例や。APIキーを保存して、それを取得するだけの例やで。

function simpleScriptPropertiesExample() {
  const scriptProperties = PropertiesService.getScriptProperties();

  // APIキーを設定する
  scriptProperties.setProperty('API_KEY', 'abcdef123456');

  // APIキーを取得する
  const apiKey = scriptProperties.getProperty('API_KEY');
  Logger.log('保存したAPIキー: ' + apiKey);
}

このコードを実行すると、APIキーが保存されて、ログに表示されるで。ほんまにシンプルやけど、これが基本の使い方やな。

より複雑な使用例

次は、複数のパラメータを保存して、全部を取得する例や。例えば、ユーザーの設定情報を保存するんや。

function complexScriptPropertiesExample() {
  const scriptProperties = PropertiesService.getScriptProperties();

  // ユーザー設定を設定する
  scriptProperties.setProperty('userName', 'たろう');
  scriptProperties.setProperty('userEmail', 'taro@example.com');
  scriptProperties.setProperty('userLanguage', 'ja');

  // 全ての設定を取得する
  const userName = scriptProperties.getProperty('userName');
  const userEmail = scriptProperties.getProperty('userEmail');
  const userLanguage = scriptProperties.getProperty('userLanguage');

  Logger.log('ユーザー名: ' + userName);
  Logger.log('ユーザーメール: ' + userEmail);
  Logger.log('ユーザー言語: ' + userLanguage);
}

この例では、ユーザー名、メールアドレス、言語をそれぞれ保存して、取得してログに表示してるんや。複数のパラメータを扱うときは、こんな感じでそれぞれ設定していくんやで。

他のメソッドと組み合わせた活用例

最後に、Script Propertiesを他のメソッドと組み合わせて使う例を見てみよう！例えば、スプレッドシートのデータを使って設定を保存する場合や。

function combinedExample() {
  const scriptProperties = PropertiesService.getScriptProperties();
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

  // スプレッドシートのA1セルからデータを取得して設定する
  const valueFromSheet = sheet.getRange('A1').getValue();
  scriptProperties.setProperty('sheetValue', valueFromSheet);

  // 設定した値を取得してログに表示する
  const savedValue = scriptProperties.getProperty('sheetValue');
  Logger.log('スプレッドシートから取得した値: ' + savedValue);
}

この例では、スプレッドシートのA1セルの値をScript Propertiesに保存して、保存した値を取得してログに表示してるんや。こうすることで、他のデータソースと連携しながら設定情報を管理できるんやで！

これでScript Propertiesの使い方がいろいろわかったかな？みんなも自分のプロジェクトに役立ててみてな！

Script Propertiesの実際の使用シナリオ

おおきに！さて、ここからはScript Propertiesがどんな具体的なシーンで役立つのかを見ていくで！業務での利用や、個人のプロジェクトでもめっちゃ便利やから、ぜひ参考にしてな。

業務での利用シーン

APIキーの管理
例えば、外部のAPIを使う業務プロセスがあったとするやろ？そのAPIにアクセスするためのキーをScript Propertiesに保存しとけば、スクリプトを更新するたびにコードを変更せんでも済む。セキュリティ的にも、コードの中に直接書かん方が安心やしな。
ユーザー設定の保存
社内のツールで、各ユーザーが好みの設定を持つ場合、ユーザーごとに設定をScript Propertiesに保存しておくことで、次回アクセスしたときにすぐにその設定を適用できる。たとえば、通知のオンオフや表示言語なども簡単に管理できるで。
データ管理の自動化
定期的に実行されるスクリプトで、前回の実行日時や処理したデータのIDをScript Propertiesに保存しておけば、次回実行時にその情報をもとに処理を続けられる。これで、業務の効率がグッと上がるやろ！

個人利用のシーン

日記やメモの管理
自分の日記やメモをGASで自動化したいとき、最近のエントリーのタイトルや日付をScript Propertiesに保存しておけば、次回スクリプトを実行するときにそのデータを使える。これで、自分の書いた内容を簡単に振り返れるで。
個人のタスク管理
タスク管理のためのスクリプトを作成して、各タスクの進捗状況や優先度をScript Propertiesに保存しとけば、次回の実行時にすぐにその情報を取得して処理できる。タスクの管理がもっとスムーズになるで！
設定やカスタマイズの保存
自分専用のGASスクリプトで、特定の設定（たとえば、出力先のフォルダIDや、フィルタ条件など）をScript Propertiesに保存しておくことで、毎回設定を見直さなくても済む。これで、使い勝手がめっちゃ良くなるやろ！

実際のプロジェクトでの応用例

例えば、ある企業が定期的に顧客データを収集するスクリプトを作成したとするやろ。このスクリプトでは、APIからデータを取得するためのAPIキーや、最後に取得したデータの日時をScript Propertiesに保存しておく。

function fetchCustomerData() {
  const scriptProperties = PropertiesService.getScriptProperties();

  // APIキーを取得
  const apiKey = scriptProperties.getProperty('API_KEY');

  // 最後に取得した日時を取得
  const lastFetchTime = scriptProperties.getProperty('lastFetchTime');

  // APIからデータを取得（仮の関数）
  const newData = fetchDataFromAPI(apiKey, lastFetchTime);

  // データを処理...

  // 現在の日時を保存
  scriptProperties.setProperty('lastFetchTime', new Date().toISOString());
}

このように、Script Propertiesを使うことで、業務のフローを効率化しつつ、情報の管理も簡単にできるんや。みんなも自分のプロジェクトに活かしてみてな！

Script Propertiesを例えるなら

さあ、みんな！今回はScript Propertiesを日常生活の例えでわかりやすく説明するで。これを聞けば、メソッドの動作や役割がもっと直感的に感じられるはずや！

例え：冷蔵庫の収納

想像してみてな。あなたの家に冷蔵庫があるとするやろ？冷蔵庫の中には、食材や飲み物が入ってる。この冷蔵庫が、Script Propertiesの役割を果たしてるんや。

冷蔵庫 = Script Properties
ここに保存することで、必要な情報（食材）を簡単に取り出せる便利な場所や。
食材 = 保存したデータ
食材をそれぞれの場所に収納する感じで、APIキーやユーザー設定をScript Propertiesに保存しておく。必要なときにすぐに取り出せるから、コードの中に直接書かんでもええ。
冷蔵庫を開ける = データを取得する
お腹が空いたときに冷蔵庫を開けて食材を探すように、スクリプトの実行中にScript Propertiesから必要なデータを取得する。これで、スムーズに作業を続けられるんや。
食材の追加や削除 = データの設定や削除
冷蔵庫に新しい食材を追加したり、古い食材を捨てたりするように、Script Propertiesでも新しいデータを設定したり、もういらんデータを削除することができる。これで、常に必要な情報だけを管理しておけるんや。

このように、Script Propertiesは冷蔵庫のように、必要な情報を効率よく保存・管理できる場所なんや。冷蔵庫をうまく使って、料理をスムーズに進めるように、Script Propertiesを使ってスクリプトの運用を楽にしていこう！これで、みんなもScript Propertiesの重要性がわかったかな？

便利なシーンでの事例

おおきに！さあ、ここからはScript Properties（スクリプトプロパティ）がどんなシーンで役立つのか、ビジネスや学業での具体的なケーススタディを見ていくで。これを知ったら、タイムセーブや効率向上に役立つこと間違いなしや！

ビジネスでの実用的なケーススタディ

定期的なレポート作成
ある企業が毎週、売上報告を自動で生成するスクリプトを作成したとする。このスクリプトでは、APIから売上データを取得するためのAPIキーをScript Propertiesに保存しておく。毎週の実行時に、スクリプトはこのAPIキーを使ってデータを取得し、レポートを生成する。これにより、手動でデータを入力する手間が省けて、時間を大幅に節約できる。

“`javascript function generateWeeklyReport() { const scriptProperties = PropertiesService.getScriptProperties(); const apiKey = scriptProperties.getProperty(‘API_KEY’);

 // APIからデータを取得
 const salesData = fetchSalesData(apiKey);

 // レポートを生成...

} “`

顧客管理システムの構築
企業が顧客の情報を管理するためのスクリプトを作成し、各顧客の設定をScript Propertiesに保存する。例えば、顧客の優先度や連絡先情報を保存しておくことで、顧客サポートの際にすぐに参照できる。これによりレスポンスが速くなり、顧客満足度が向上する。

“`javascript function getCustomerInfo(customerId) { const scriptProperties = PropertiesService.getScriptProperties(); const customerInfo = scriptProperties.getProperties();

 Logger.log('顧客情報: ' + JSON.stringify(customerInfo[customerId]));

} “`

学業での実用的なケーススタディ

課題提出の自動化
学生が複数の課題を管理するためのスクリプトを作成。各課題の提出期限や進捗状況をScript Propertiesに保存しておけば、次回スクリプトを実行したときに、どの課題が未提出か簡単に確認できる。これにより、課題提出の漏れを防いで、効率的に学習を進められる。

“`javascript function checkAssignments() { const scriptProperties = PropertiesService.getScriptProperties(); const assignments = scriptProperties.getProperties();

 Logger.log('未提出の課題: ' + JSON.stringify(assignments));

} “`

研究データの管理
研究者がデータ収集を行うためのスクリプトを作成し、収集したデータの最新の日時や状態をScript Propertiesに保存しておく。これにより、次回データ収集を行う際に、前回の結果を参照して新しいデータのみを取得することができる。これが効率的な研究活動につながる。

“`javascript function collectResearchData() { const scriptProperties = PropertiesService.getScriptProperties(); const lastCollectionDate = scriptProperties.getProperty(‘lastCollectionDate’);

 // 新しいデータを収集...
 scriptProperties.setProperty('lastCollectionDate', new Date().toISOString());

} “`

Script Properties関数によるタイムセーブや効率向上の具体的な例

タイムセーブ: スクリプトを実行するたびにAPIキーや設定を手動で入力せんでも、Script Propertiesに保存しておくことで、毎回の手間を省ける。これが時間の節約につながる。
効率向上: スクリプトが必要な情報を即座に取得できるため、プロジェクトの進行がスムーズになる。特に、ビジネスや学業でのデータ管理の際には、迅速な情報アクセスが大きなアドバンテージになるんや。

これで、Script Propertiesがどれだけ便利か、どんなシーンで役立つかがわかったかな？ぜひ、自分のプロジェクトで活かしてみてな！

Script Propertiesの注意点とベストプラクティス

おおきに！さて、ここからはScript Propertiesを使うときの注意点やベストプラクティスについてお話しするで。これを知っておくと、より効率的に安全に使えるようになるから、しっかりメモしといてな！

使用する際の制限事項や注意点

ストレージの制限
Script Propertiesには保存できるデータ量に制限があるで。1つのプロパティのサイズは最大で500KB、全体では最大で20MBまでや。これを超えるとエラーが発生するから、保存するデータのサイズには注意せなあかん。
データの永続性
Script Propertiesに保存したデータは、スクリプトが削除されたり、プロジェクトが無効になったりすると失われることがある。重要なデータは別の場所にバックアップしておくと安心やで。
競合の可能性
同時に複数のスクリプトがScript Propertiesにアクセスすると、データの競合が発生することがある。特に、同じキーに対して同時に書き込みを行う場合は注意が必要や。

効率的で安全な使用方法のアドバイス

データ管理を明確にする
保存するデータのキーを分かりやすく命名して、何を保存しているのか明確にすることが大切や。これで、後で見返したときにもすぐに理解できるようになるで。
エラーハンドリングを実装する
Script Propertiesにアクセスする際には、エラーハンドリングを行うことで、問題発生時に適切に対応できるようにしておく。例えば、プロパティが存在しない場合の処理を追加することが大切や。
セキュリティに留意する
APIキーや個人情報をScript Propertiesに保存する場合、セキュリティに十分に注意すること。公開されるリポジトリや他のユーザーにアクセス権を与える場合は、特に気をつけてな。

Script Propertiesよくあるエラーとその解決方法

「Quota exceeded」エラー
原因: ストレージの制限を超えた場合。
解決方法: 不要なプロパティを削除して、使用量を減らす。また、データサイズを見直して、必要最低限のデータだけを保存するように心がけることが大切や。
「Property not found」エラー
原因: 指定したプロパティが存在しない場合。
解決方法: プロパティ名が正しいかどうかを確認し、必要に応じてデフォルト値を設定することをおすすめするで。
「Cannot overwrite a property that is being used by another script」エラー
原因: 他のスクリプトが同じプロパティを使用している場合。
解決方法: 同時にアクセスしないようにスクリプトの実行を調整する。または、プロパティ名を変更して、競合を避けるようにすることが重要や。

これで、Script Propertiesを使うときの注意点やベストプラクティス、よくあるエラーの解決方法がわかったかな？しっかり押さえて、安全に活用していこうな！

【Script Propertiesの魅力】簡単な使い方と実用的なサンプルコードでスクリプト管理を効率化！

この記事を書いた人

mjflash

【Script Propertiesの魅力】簡単な使い方と実用的なサンプルコードでスクリプト管理を効率化！

Script Properties の基本的な機能と構文

基本的な機能

構文と必要なパラメータ

サンプルコード

Script Properties コードのサンプル事例

単純な使用例

より複雑な使用例

他のメソッドと組み合わせた活用例

Script Propertiesの実際の使用シナリオ

業務での利用シーン

個人利用のシーン

実際のプロジェクトでの応用例

Script Propertiesを例えるなら

例え：冷蔵庫の収納

便利なシーンでの事例

ビジネスでの実用的なケーススタディ

学業での実用的なケーススタディ

Script Properties関数によるタイムセーブや効率向上の具体的な例

Script Propertiesの注意点とベストプラクティス

使用する際の制限事項や注意点

効率的で安全な使用方法のアドバイス

Script Propertiesよくあるエラーとその解決方法

関連

この記事を書いた人

関連記事