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

POST

spreadsheets

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://sheets.googleapis.com//v4/spreadsheets//developerMetadata:search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dataFilters": [
        {
            "a1Range": "string",
            "developerMetadataLookup": {},
            "gridRange": {}
        }
    ]
}'

Response Example

{
    "matchedDeveloperMetadata": [
        {
            "dataFilters": [
                {
                    "a1Range": "string",
                    "developerMetadataLookup": {},
                    "gridRange": {}
                }
            ],
            "developerMetadata": {}
        }
    ]
}

Request

Path Params

spreadsheetId

string

required

The ID of the spreadsheet to retrieve metadata from.

Body Params application/json

A request to retrieve all developer metadata matching the set of specified criteria.

dataFilters

array[object (DataFilter) {3}]

optional

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.

a1Range

string

optional

Selects data that matches the specified A1 range.

developerMetadataLookup

object

optional

gridRange

object

optional

Examples

Responses

🟢200Successful response

application/json

Body

A reply to a developer metadata search request.

matchedDeveloperMetadata

array[object (MatchedDeveloperMetadata) {2}]

optional

The metadata matching the criteria of the search request.

dataFilters

array[object (DataFilter) {3}]

optional

All filters matching the returned developer metadata.

developerMetadata

object

optional

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

/v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo