Class DeveloperMetadata

DeveloperMetadata

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

メソッド

メソッド戻り値の型概要
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