Sheets.spreadsheets.developer Metadata.get

Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.

GET/v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}

Use it in a workflow

Add a step and choose the Google Sheets connector.
Pick the Sheets.spreadsheets.developer Metadata.get action (under spreadsheets).
Fill in the fields below, then reference the result from later steps as {{sheetsSpreadsheetsDeveloperMetadataGet.response.data}}.

Request

Path parameters

spreadsheetIdstringrequired

The ID of the spreadsheet to retrieve metadata from.

metadataIdintegerrequired

The ID of the developer metadata to retrieve.

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

Response

Returns 200 with an object. Read it in later steps with {{sheetsSpreadsheetsDeveloperMetadataGet.response.data.<field>}}.

locationobject

A location where metadata may be associated in a spreadsheet.

dimensionRangeobject4 fields

A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.

locationTypestring

The type of location this object represents. This field is read-only.

One ofDEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIEDROWCOLUMNSHEETSPREADSHEET

sheetIdinteger (int32)

The ID of the sheet when metadata is associated with an entire sheet.

spreadsheetboolean

True when metadata is associated with an entire spreadsheet.

metadataIdinteger (int32)

The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.

metadataKeystring

The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.

metadataValuestring

Data associated with the metadata's key.

visibilitystring

The metadata visibility. Developer metadata must always have a visibility specified.

One ofDEVELOPER_METADATA_VISIBILITY_UNSPECIFIEDDOCUMENTPROJECT

json

{
  "location": {
    "dimensionRange": {
      "dimension": "DIMENSION_UNSPECIFIED",
      "endIndex": 0,
      "sheetId": 0,
      "startIndex": 0
    },
    "locationType": "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
    "sheetId": 0,
    "spreadsheet": false
  },
  "metadataId": 0,
  "metadataKey": "string",
  "metadataValue": "string",
  "visibility": "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED"
}

Need more? See the Google Sheets guide for connection setup and behaviour shared by every action.

Was this page helpful?