Class DeveloperMetadata

    Developer Metadata

    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

    get Id()

    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

    get Key()

    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

    get Location()

    Returns the location of this developer metadata.

    Return

    Developer Metadata Location — 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

    get Value()

    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

    get Visibility()

    Returns the visibility of this developer metadata.

    Return

    Developer Metadata Visibility — 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

    move To Column(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

    Developer Metadata — 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

    move To Row(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

    Developer Metadata — 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

    move To Sheet(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

    Developer Metadata — 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

    move To Spreadsheet()

    Moves this developer metadata to the top-level spreadsheet.

    Return

    Developer Metadata — 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

    set Key(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.
    Description : The new key to set for this metadata.

    Return

    Developer Metadata — 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

    set Value(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.
    Description : The new value to set for this metadata.

    Return

    Developer Metadata — 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

    set Visibility(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

    Developer Metadata — 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
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: