×

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


Googleを追いかけろ!

.

参照ページ(Goolge)


WWW を検索 Googleを追いかけろ! を検索
class Spreadsheet : Members
memberType説明
addCollaborator共同作業者を追加する
addCollaborator共同作業者を追加する
addCollaborators指定されたユーザーのスプレッドシートへのアクセスを提供する
addMenuスプレッドシートUIの新しいメニューを作成する
deleteActiveSheetSheetアクティブなシートを削除する
duplicateActiveSheetSheetアクティブなシートの複写を作る
getActiveSheetSheetスプレッドシート内のアクティブなシートを取得する
getCollaboratorsUser [ ]共同作業者のリストを取得する
getColumnWidthintアクティブシート内の指定されたカラム幅をピクセル値で取得する
setColumnWidthsheetアクティブシート内の指定されたカラム幅をピクセル値で設定する
getFormUrlStringスプレッドシートに接続するフォームのURLを返す
getIdStringスプレッドシートの一意の識別子を取得する
getNameStringスプレッドシート名を取得する
getNumSheetsintスプレッドシート内でのシート番号を取得する
getOwnerUserスプレッドシートの所有者情報を取得する
getRangeByNameRange名前付き範囲を取得する
getSheetByNameSheet指定された名前のシートを取得する
getSheetsSheet [ ]スプレッドシート内のすべてのシートを取得する
getSpreadsheetLocaleStringスプレッドシートのロケール(地理的位置)を取得する
getSpreadsheetTimeZoneStringスプレッドシートのタイムゾーン(e.g., 'PST', 'EST')を取得する
getUrlStringスプレッドシートのURLを取得する
insertSheetSheet新規シートを作成して名前を割り当てた後スプレッドシートに挿入する
moveActiveSheetアクティブなシートをシートリストで指定された位置に移動する
removeCollaboratorスプレッドシートから共同作業者を削除する
removeCollaboratorスプレッドシートから共同作業者を削除する
renameActiveSheetスプレッドシート内のアクティブシートをリネームする
setActiveSheetSheetアクティブシートを設定する
setNamedRange範囲オブジェクトに名前を与える
setSpreadsheetLocaleスプレッドシートにロケール(地理的位置)を与える
setSpreadsheetTimeZoneスプレッドシートにタイムゾーンを与える
showUiAppで構築されたユーザーインターフェイスコンポーネントを表示する
toast指定されたタイトルとメッセージを持つポップアップウィンドウを一定時間内スプレッドシートの右下隅に表示する



method addCollaborator()

Arguments :
nameType説明
collaboratoruser 追加するユーザー


method addCollaborator()

Arguments :
nameType説明
emailString 追加するユーザーのイーメールアドレス
動作確認用サンプル :
//アクティブなワークシートの編集者として追加する
//複数人のときはカンマ区切りで

function addCollaborator(){

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.addCollaborator("someone@example.com");
}


//* 共有設定で共有解除を実行してもエラー(2010/10/13)

20101013


method addCollaborators(collaborators, optAdvancedArgs)

  • 指定されたユーザーのスプレッドシートへのアクセスを提供する
    オプション引数'editorAccess'はfalse、'emailInvitations'はtrueが初期値。 ある種のドメインはそのメンバーである共同編集者を制限する
    ( 参考 :removeCollaborator,getCollaborators )
Arguments :
nameType説明
emailString カンマ区切りにした追加すべき共同作業者のイーメールアドレス
optAdvancedArgsObject 未定義
Advanced Arguments* :
nameType説明
editorAccessbool true : 新規共同作業者はこのスプレッドシートにおいて閲覧可から編集可の状態になる
emailInvitationsbool true : このスプレッドシートにおいて新しい共同編集者にスプレッドシートの編集/表示を招待するメールを送信する
サンプル :
// The code below will add mike@example.com and bob@example.com
// as editors to the active workbook.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.addCollaborators("mike@example.com,bob@example.com", {editorAccess:true, emailInvitations:false});


method addMenu(menuName, menuEntries)

  • スプレッドシートUIの新しいメニューを作成する
    各メニューエントリーはユーザー定義関数を実行する。メニューはonOpen関数から呼び出せばスプレッドシートがロードされるたびに自動的に作成される。
Arguments :
nameType説明
menuNameString メニューの名前
menuEntriesArray "name"と"functionName"(両方文字列)のフィールドを持つオブジェクトがメニューオプションを表示する。ヌルは、行の区切りを表す。
サンプル :
// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {  
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});
}
ss.addMenu("addMenuExample", menuEntries);


method deleteActiveSheet()

  • アクティブなシートを削除する
戻り値 :
Type説明
Sheet 新規のアクティブシート
サンプル :
 The code below deletes the currently active sheet and stores the new active sheet in a variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();


method duplicateActiveSheet()

  • アクティブなシートの複写を作る
戻り値 :
Type説明
Sheet 新規のシート
Googleのサンプル :
// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();
動作確認用サンプル :
// openByIdを利用してターゲットのスプレッドシートをアクティブにする
//ターゲットのスプレッドシートの一枚目のシートのコピーを(ターゲットのスプレッドシート内に)作成

function duplicateActiveSheet(){

var ss = SpreadsheetApp.openById("ターゲットのスプレッドシートのID")
ss.duplicateActiveSheet();

}

//もちろんターゲットのスプレッドシート外からの実行が可能
//サーバーサイドでアクティブになるので実際の振る舞いが見えるわけではない
//該当のスプレッドシートを開いて確認する

20101119


method getActiveSheet()

  • スプレッドシート内のアクティブなシートを取得する
    アクティブなシートとはspreadsheet UI.によって表示されているシート
    ( 参考 :setActiveSheet )
戻り値 :
Type説明
Sheet アクティブなシート
サンプル :
// The code below will show the name of the active sheet.
Browser.msgBox(SpreadsheetApp.getActiveSpreadsheet().getActiveSheet().getName());


method getCollaborators()

戻り値 :
Type説明
User[ ] 利用者の配列


method getColumnWidth(column)

  • アクティブシート内の指定されたカラム幅をピクセル値で取得する
Arguments :
nameType説明
columnint 取得すべき幅を持つカラム
戻り値 :
Type説明
int カラムの幅のピクセル値


method setColumnWidth(column, width)

  • アクティブシート内の指定されたカラム幅をピクセル値で取得する
Arguments :
nameType説明
columnint 設定すべき幅を持つカラム
widthint 新しい幅を持つカラムのピクセル値
戻り値 :
Type説明
sheet 連結に有効なシートオブジェクト


method getFormUrl()

  • スプレッドシートに接続するフォームのURL(FormKey)を返す
戻り値 :
Type説明
String URL
Googleのサンプル :
var url = doc.getFormUrl();
動作確認用サンプル :
// フォーム作成後に公開設定をしたときの公開コードと同じものが返る

function getFormUrl() {

  var url = SpreadsheetApp.getActiveSpreadsheet().getFormUrl();
  Browser.msgBox(url);

}

* 下のリンクで実際のフォーム(サンプル)の確認ができます。(よろしかったらアンケートにお答えください。)
下はgetFormUrl()で取得したフォームの埋め込み用コード

<iframe> src="https://spreadsheets.google.com/embeddedform?formkey=dENTOUY5RkxNam9IWmlwWG9UcjVmbEE6MQ"
 width="760" height="450" frameborder="0" marginheight="0" marginwidth="0">読み込み中...</iframe>


* フォームのサンプル

20101108


method getId()

  • スプレッドシートの一意の識別子を取得する
    スプレッドシートのIDはスプレッドシートのURLから抽出する。たとえばURLがURL https://spreadsheets.google.com/a/yourdomain.com/ccc?key=abc1234567 の スプレッドシートのIDは"abc1234567"となる。
    ( 参考 :getName )
戻り値 :
Type説明
String スプレッドシートの一意の識別子(またはキー)
Googleのサンプル :
// The code below gets the ID for the active spreadsheet.
Browser.msgBox(SpreadsheetApp.getActiveSpreadsheet().getId());
動作確認用サンプル :
function getSS() {

  var ss = SpreadsheetApp.getActiveSpreadsheet();
  Browser.msgBox(ss.getId());
  Browser.msgBox(ss.getName());
  Browser.msgBox(ss.getNumSheets());

}

20101117


method getName()

  • スプレッドシート名を取得する
    ( 参考 :getId )
戻り値 :
Type説明
String スプレッドシートの名前
Googleのサンプル :
// The code below gets the name for the active spreadsheet.
Browser.msgBox(SpreadsheetApp.getActiveSpreadsheet().getName());
動作確認用サンプル :
function getSS() {

  var ss = SpreadsheetApp.getActiveSpreadsheet();
  Browser.msgBox(ss.getId());
  Browser.msgBox(ss.getName());
  Browser.msgBox(ss.getNumSheets());

}

20101117


method getNumSheets()

  • スプレッドシート内でのシート番号を取得する
戻り値 :
Type説明
int スプレッドシート内でのシート番号
Googleのサンプル :
// The code below gets the number of sheets in the active spreadsheet.
Browser.msgBox(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());
動作確認用サンプル :
function getSS() {

  var ss = SpreadsheetApp.getActiveSpreadsheet();
  Browser.msgBox(ss.getId());
  Browser.msgBox(ss.getName());
  Browser.msgBox(ss.getNumSheets());

}

20101117


method getOwner()

  • スプレッドシートの所有者情報を取得する
戻り値 :
Type説明
User スプレッドシートの所有者情報を含むオブジェクト
サンプル :
// The code below gets the name of the owner for the active spreadsheet.
Browser.msgBox(SpreadsheetApp.getActiveSpreadsheet().getOwner().getEmail());


method getRangeByName(name)

  • 名前付き範囲を取得する
    指定の名前付き範囲が見つからない場合はnullを返す
    ( 参考 :setNamedRange )
Arguments :
nameType説明
nameString 取得すべき範囲の名前
戻り値 :
Type説明
Rnge 指定された名前を持つセル範囲
Googleのサンプル :
// The code below will get the number of columns for the range named "TaxRates"
// in the active spreadsheet
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName("TaxRates");
if (range != null) {
  Browser.msgBox(range.getNumColumns());
}
動作確認用サンプル :

// 指定した名前付きの範囲を取得する(setNamedRange()実行後!)
// メッセージボックスに取得を表示し、範囲の背景色を青色に設定

function getRangeByName(){
var namedrange = SpreadsheetApp.getActiveSpreadsheet().getRangeByName("準備");
if (namedrange != null) {
  Browser.msgBox("C1:D4-準備-の範囲を取得");
  namedrange.activate().setBackgroundColor("blue");
}
}

20101002


method getSheetByName(name)

  • 指定された名前のシートを取得する
    複数のシートが同じ名前を持つ場合は、左端の1つが返される。指定された名前を持つシートが無い場合はnullが返される。
    ( 参考 :getSheets )
Arguments :
nameType説明
nameString 取得すべきシートの名前
戻り値 :
Type説明
Sheet 指定された名前を持つシート
サンプル :
// The code below will get the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Browser.msgBox(sheet.getIndex());
}


method getSheets()

  • スプレッドシート内のすべてのシートを取得する
    ( 参考 :getSheetByName )
戻り値 :
Type説明
Sheet [ ] スプレッドシート内のすべてのシート
Googleのサンプル :
// The code below will get the name of the 2nd sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Browser.msgBox(sheets[1].getName());
}
動作確認用サンプル :
//2枚目のシート名”2枚目のシート”を取得
function getSheets(){
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Browser.msgBox(sheets[1].getName());
  }
}

20110101


method getSpreadsheetLocale()

  • スプレッドシートのロケール(地理的位置)を取得する
    ( 参考 :setSpreadsheetLocale )
戻り値 :
Type説明
String スプレッドシートのロケール


method getSpreadsheetTimeZone()

  • スプレッドシートのタイムゾーン(e.g., 'PST', 'EST')を取得する
    ( 参考 :setSpreadsheetTimeZone )
戻り値 :
Type説明
String タイムゾーンのid


method getUrl()

  • スプレッドシートのURLを取得する
戻り値 :
Type説明
String スプレッドシートのURL
サンプル :
// The code below gets the URL for the active spreadsheet.
Browser.msgBox(SpreadsheetApp.getActiveSpreadsheet().getUrl());


method insertSheet(optName, optSheetIndex, optAdvancedArgs)

  • 新規シートを作成して名前を割り当てた後スプレッドシートに挿入する
    初期値では新規シートは最後の場所に挿入される。名前が指定されない場合は1が自動的に割り当てられる。
Arguments :
nameType説明
optNameString 新規シートの名前
optSheetIndexint 新しく挿入されたシートのインデックス : スプレッドシートの最初の1つ目として挿入する場合はシートを0に設定する
optAdvancedArgsObject 未定義
Advanced Arguments* :
nameType説明
templateSheet templateシートオブジェクトのすべてのデータは新規シートにコピーされる。 シートテンプレートは、スプレッドシートオブジェクトのシートのなかのひとつ
戻り値 :
Type説明
Sheet 新規シート
Googleのサンプル :
// The code below will insert a new sheet in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();
// The code below will insert a new sheet after the 1st and call it "Sales"
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet("Sales", 1);
// The code below will duplicate the sheet named "Sales" and insert it after 
// the 1st sheet and call it "Sales2"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var temp = ss.getSheetByName("Sales");
ss.insertSheet("Sales2", 1, {template:temp});
動作確認用サンプル :
//インプットボックスに指定された名前で新規シートを作成

function insertSheet() {
  var newName = Browser.inputBox("新しいシートを挿入します。名前を決めてください。");
  sS = SpreadsheetApp.getActiveSpreadsheet();
  sS.insertSheet(newName, 1);
}

* Googleサンプルの3つ目; {template:temp}のtemplateが何を指すのか、あるいは作成方法については調査中

20110214


method moveActiveSheet(position)

  • アクティブなシートをシートリストで指定された位置に移動する
Arguments :
nameType説明
positionint 新しいアクティブシートの位置:ネガティブ値やシート番号より大きな値は不可
サンプル :
// The code below will move the active sheet to the first position
SpreadsheetApp.getActiveSpreadsheet().moveActiveSheet(1);


method removeCollaborator(collaborator)

Arguments :
nameType説明
collaboratorUser 削除すべきユーザー


method removeCollaborator(email)

Arguments :
nameType説明
emailString 削除すべきユーザーのメールアドレス


method renameActiveSheet(newName)

  • スプレッドシート内のアクティブシートをリネームする
Arguments :
nameType説明
newNameString シートのための新規の名前
サンプル :
// The code below will rename the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");


method setActiveSheet()

  • スプレッドシート内のアクティブなシートを設定する
    異なるスプレッドシートに所属しない限りspreadsheet UI.によって選択されたシートが表示される
    ( 参考 :getActiveSheet )
Arguments :
nameType説明
sheetSheet アクティブにされたシート


戻り値 :
Type説明
Sheet 新規のアクティブなシート
Googleのサンプル :
// The code below will make the first sheet active in the active workbook
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setActiveSheet(ss.getSheets()[0]);
動作確認用サンプル :
// ダイアログを表示してOKならシートを移動する

function setActiveSheet(){

  var ss = SpreadsheetApp.getActiveSpreadsheet();
  Browser.msgBox("作業用シート(Sheet3)へ移動します。");
  SpreadsheetApp.setActiveSheet(ss.getSheets()[2]);
  
}

20101118


method setNamedRange(name, range)

  • 範囲オブジェクトに名前を与える
    ( 参考 :getRangeByName )
Arguments :
nameType説明
nameString 範囲名
rangeRange 名前に関連した範囲オブジェクト
Googleのサンプル :
// The code below will create a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());
// The code below will create a new named range "Expenses"
// for the range C1:D4
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getSheets()[0].getRange("C1:D4");
ss.setNamedRange("Expenses", range);
動作確認用サンプル :
//C1:D4範囲に"準備"という範囲名を付ける
//指定範囲の背景色を黄色に設定

function setNamedRange(){
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getSheets()[0].getRange("C1:D4");
ss.setNamedRange("準備", range);
range.activate().setBackgroundColor("yellow");
}

//ツールバーの"編集"から"名前の付いた範囲"で確認する

20101002


method setSpreadsheetLocale(locale)

  • スプレッドシートのロケール(地理的位置)を設定する
    ( 参考 :getSpreadsheetLocale )
Arguments :
nameType説明
localeString (e.g., 'en', 'fr', 'en_US')などを使った地理的位置コード


method setSpreadsheetTimeZone(timezone)

Arguments :
nameType説明
timezoneString (e.g., 'PST', 'EST')などを使ったタイムゾーン(時間帯)コード


method show(appInstance)

  • UiAppで構築されたユーザーインターフェイスコンポーネントを表示する
Arguments :
nameType説明
appInstanceUiInstance UiApp.createApplication()で作られたUiInstance
サンプル :
var doc = SpreadsheetApp.getActiveSpreadsheet();
var app = UiApp.createApplication().setTitle('hello');
app.add(app.createLabel('My label'));
doc.show(app);


method toast(message, optTitle, optTimeoutSeconds)

  • 指定されたタイトルとメッセージを持つポップアップウィンドウを一定時間内スプレッドシートの右下隅に表示する
    参考:class_Browser
Arguments :
nameType説明
messageString toast上に表示されるメッセージ
optTitleString toast上に表示されるタイトル
optTimeoutSecondsdouble メッセージの表示時間:これが負の場合、メッセージが却下されるまで表示される
Googleのサンプル :
// 画面右下にメッセージが出現し3秒後に隠れます

SpreadsheetApp.getActiveSpreadsheet().toast("Hello", "world?", 3);
動作確認用サンプル :

function toast(){
  // The code below shows a popup that disappears in 3 seconds
  SpreadsheetApp.getActiveSpreadsheet().toast("ここはサブタイトル用",
		 "message:optTimeoutSecondsがマイナス値の時は却下するまで表示を続けます。", -3);
}

20101010