Class DeveloperMetadata

    • Developer metadata can be accessed and modified within a spreadsheet.

    • New developer metadata can be created using methods on Range, Sheet, or Spreadsheet objects.

    • Developer metadata has properties such as ID, key, location, value, and visibility.

    • Developer metadata can be moved to a different column, row, sheet, or the top-level spreadsheet.

    • Developer metadata can be removed and its key, value, or visibility can be set.
    DeveloperMetadata

    Access and modify developer metadata. To create new developer metadata use Range.addDeveloperMetadata(key) , Sheet.addDeveloperMetadata(key) , or Spreadsheet.addDeveloperMetadata(key) .

    Methods

    Method Return type Brief description
    get Id()
    		Integer Returns the unique ID associated with this developer metadata.
    get Key()
    		String Returns the key associated with this developer metadata.
    get Location()
    		Developer Metadata Location Returns the location of this developer metadata.
    get Value()
    		String Returns the value associated with this developer metadata, or null if this metadata has no value.
    get Visibility()
    		Developer Metadata Visibility Returns the visibility of this developer metadata.
    move To Column(column)
    		Developer Metadata Moves this developer metadata to the specified column.
    move To Row(row)
    		Developer Metadata Moves this developer metadata to the specified row.
    move To Sheet(sheet)
    		Developer Metadata Moves this developer metadata to the specified sheet.
    move To Spreadsheet()
    		Developer Metadata Moves this developer metadata to the top-level spreadsheet.
    remove()
    		void Deletes this metadata.
    set Key(key)
    		Developer Metadata Sets the key of this developer metadata to the specified value.
    set Value(value)
    		Developer Metadata Sets the value associated with this developer metadata to the specified value.
    set Visibility(visibility)
    		Developer Metadata Sets the visibility of this developer metadata to the specified visibility.

    Detailed documentation

    getId()

    Returns the unique ID associated with this developer metadata.

    Return

    Integer — The unique ID associated with this developer metadata.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    getKey()

    Returns the key associated with this developer metadata.

    Return

    String — The key associated with this developer metadata.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    getLocation()

    Returns the location of this developer metadata.

    Return

    DeveloperMetadataLocation — The location of this developer metadata.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    getValue()

    Returns the value associated with this developer metadata, or null if this metadata has no value.

    Return

    String — The value associated with this developer metadata, or null if this metadata has no value.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    getVisibility()

    Returns the visibility of this developer metadata.

    Return

    DeveloperMetadataVisibility — The visibility of this developer metadata.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    moveToColumn(column)

    Moves this developer metadata to the specified column. If the specified range does not represent a single column this throws an exception.

    Parameters

    Name Type Description
    column
    		Range The range representing the column that is the new location for this developer metadata.

    Return

    DeveloperMetadata — The developer metadata, for chaining.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    moveToRow(row)

    Moves this developer metadata to the specified row. If the specified range does not represent a single row this throws an exception.

    Parameters

    Name Type Description
    row
    		Range The range representing the row that is the new location for this developer metadata.

    Return

    DeveloperMetadata — The developer metadata, for chaining.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    moveToSheet(sheet)

    Moves this developer metadata to the specified sheet.

    Parameters

    Name Type Description
    sheet
    		Sheet The sheet that is the new location for this developer metata.

    Return

    DeveloperMetadata — The developer metadata, for chaining.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    moveToSpreadsheet()

    Moves this developer metadata to the top-level spreadsheet.

    Return

    DeveloperMetadata — The developer metadata, for chaining.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    remove()

    Deletes this metadata.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    setKey(key)

    Sets the key of this developer metadata to the specified value.

    Parameters

    Name Type Description
    key
    		String The new key to set for this metadata.

    Return

    DeveloperMetadata — The developer metadata, for chaining.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    setValue(value)

    Sets the value associated with this developer metadata to the specified value.

    Parameters

    Name Type Description
    value
    		String The new value to set for this metadata.

    Return

    DeveloperMetadata — The developer metadata, for chaining.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    setVisibility(visibility)

    Sets the visibility of this developer metadata to the specified visibility.

    Parameters

    Name Type Description
    visibility
    		Developer Metadata Visibility The new visibility to set for this metadata.

    Return

    DeveloperMetadata — The developer metadata, for chaining.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.googleapis.com/auth/spreadsheets.currentonly
    • https://www.googleapis.com/auth/spreadsheets
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: