Class DeveloperMetadata

DeveloperMetadata

デベロッパー メタデータにアクセスして変更する。新しいデベロッパー メタデータを作成するには、Range.addDeveloperMetadata(key)、Sheet.addDeveloperMetadata(key)、または Spreadsheet.addDeveloperMetadata(key) を使用します。

Methods

メソッド戻り値の型概要
getId()Integerこのデベロッパー メタデータに関連付けられている一意の ID を返します。
getKey()Stringこのデベロッパー メタデータに関連付けられているキーを返します。
getLocation()DeveloperMetadataLocationこのデベロッパー メタデータの場所を返します。
getValue()Stringこのデベロッパー メタデータに関連付けられている値を返します。メタデータに値がない場合は null を返します。
getVisibility()DeveloperMetadataVisibilityこのデベロッパー メタデータの公開設定を返します。
moveToColumn(column)DeveloperMetadataこのデベロッパー メタデータを指定された列に移動します。
moveToRow(row)DeveloperMetadataこのデベロッパー メタデータを指定の行に移動します。
moveToSheet(sheet)DeveloperMetadataこのデベロッパー メタデータを指定されたシートに移動します。
moveToSpreadsheet()DeveloperMetadataこのデベロッパーのメタデータを最上位のスプレッドシートに移動します。
remove()voidこのメタデータを削除します。
setKey(key)DeveloperMetadataこのデベロッパー メタデータのキーを指定された値に設定します。
setValue(value)DeveloperMetadataこのデベロッパー メタデータに関連付けられている値を、指定された値に設定します。
setVisibility(visibility)DeveloperMetadataこのデベロッパー メタデータの公開設定を、指定された公開設定に設定します。

詳細なドキュメント

getId()

このデベロッパー メタデータに関連付けられている一意の ID を返します。

リターン

Integer - このデベロッパー メタデータに関連付けられている一意の ID。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getKey()

このデベロッパー メタデータに関連付けられているキーを返します。

リターン

String - このデベロッパー メタデータに関連付けられているキー。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLocation()

このデベロッパー メタデータの場所を返します。

リターン

DeveloperMetadataLocation - このデベロッパー メタデータの場所。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getValue()

このデベロッパー メタデータに関連付けられている値を返します。メタデータに値がない場合は null を返します。

リターン

String - このデベロッパー メタデータに関連付けられている値。このメタデータに値がない場合は null。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getVisibility()

このデベロッパー メタデータの公開設定を返します。

リターン

DeveloperMetadataVisibility - このデベロッパー メタデータの公開設定。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToColumn(column)

このデベロッパー メタデータを指定された列に移動します。指定した範囲が単一の列を表していない場合、例外がスローされます。

パラメータ

名前型説明
columnRangeこのデベロッパー メタデータの新しい場所である列を表す範囲。

リターン

DeveloperMetadata - チェーン用のデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToRow(row)

このデベロッパー メタデータを指定の行に移動します。指定した範囲が単一行を表していない場合、例外がスローされます。

パラメータ

名前型説明
rowRangeこのデベロッパー メタデータの新しい場所である行を表す範囲。

リターン

DeveloperMetadata - チェーン用のデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSheet(sheet)

このデベロッパー メタデータを指定されたシートに移動します。

パラメータ

名前型説明
sheetSheetこのデベロッパー メタタの新しい場所であるシート。

リターン

DeveloperMetadata - チェーン用のデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSpreadsheet()

このデベロッパーのメタデータを最上位のスプレッドシートに移動します。

リターン

DeveloperMetadata - チェーン用のデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

このメタデータを削除します。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setKey(key)

このデベロッパー メタデータのキーを指定された値に設定します。

パラメータ

名前型説明
keyStringこのメタデータに設定する新しいキー。

リターン

DeveloperMetadata - チェーン用のデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

このデベロッパー メタデータに関連付けられている値を、指定された値に設定します。

パラメータ

名前型説明
valueStringこのメタデータに設定する新しい値。

リターン

DeveloperMetadata - チェーン用のデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVisibility(visibility)

このデベロッパー メタデータの公開設定を、指定された公開設定に設定します。

パラメータ

名前型説明
visibilityDeveloperMetadataVisibilityこのメタデータに設定する新しい公開設定。

リターン

DeveloperMetadata - チェーン用のデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets