Sheets.spreadsheets.developer Metadata.search

Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.

POST/v4/spreadsheets/{spreadsheetId}/developerMetadata:search

Use it in a workflow

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

Request

Path parameters

spreadsheetIdstringrequired

The ID of the spreadsheet to retrieve metadata from.

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").

Request body

Enter the body as JSON in the step's Body field.

dataFiltersarray<object>

The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response.

a1Rangestring

Selects data that matches the specified A1 range.

developerMetadataLookupobject7 fields

Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified.

gridRangeobject5 fields

A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.

json

{
  "dataFilters": [
    {
      "a1Range": "string",
      "developerMetadataLookup": {
        "locationMatchingStrategy": "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
        "locationType": "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
        "metadataId": 0,
        "metadataKey": "string",
        "metadataLocation": {
          "dimensionRange": {
            "dimension": "DIMENSION_UNSPECIFIED",
            "endIndex": 0,
            "sheetId": 0,
            "startIndex": 0
          },
          "locationType": "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
          "sheetId": 0,
          "spreadsheet": false
        },
        "metadataValue": "string",
        "visibility": "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED"
      },
      "gridRange": {
        "endColumnIndex": 0,
        "endRowIndex": 0,
        "sheetId": 0,
        "startColumnIndex": 0,
        "startRowIndex": 0
      }
    }
  ]
}

Response

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

matchedDeveloperMetadataarray<object>

The metadata matching the criteria of the search request.

dataFiltersarray<object>3 fields

All filters matching the returned developer metadata.

developerMetadataobject5 fields

Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.

json

{
  "matchedDeveloperMetadata": [
    {
      "dataFilters": [
        {
          "a1Range": "string",
          "developerMetadataLookup": {
            "locationMatchingStrategy": "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
            "locationType": "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
            "metadataId": 0,
            "metadataKey": "string",
            "metadataLocation": {
              "dimensionRange": null,
              "locationType": null,
              "sheetId": null,
              "spreadsheet": null
            },
            "metadataValue": "string",
            "visibility": "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED"
          },
          "gridRange": {
            "endColumnIndex": 0,
            "endRowIndex": 0,
            "sheetId": 0,
            "startColumnIndex": 0,
            "startRowIndex": 0
          }
        }
      ],
      "developerMetadata": {
        "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?