firestore.projects.locations.list

GET {{baseUrl}}/v1/:name/locations?filter=<string>&pageSize=<integer>&pageToken=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Lists information about the supported locations for this service.

Request Params

KeyDatatypeRequiredDescription
filterstringThe standard list filter.
pageSizestringThe standard list page size.
pageTokenstringThe standard list page token.
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI 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_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable 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_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

RESPONSES

status: OK

{&quot;locations&quot;:[{&quot;displayName&quot;:&quot;ut deserunt ex labore Excepteur&quot;,&quot;labels&quot;:{},&quot;locationId&quot;:&quot;irure ea dolor ullamco&quot;,&quot;metadata&quot;:{},&quot;name&quot;:&quot;ad ex do exercitation&quot;},{&quot;displayName&quot;:&quot;sed labore&quot;,&quot;labels&quot;:{},&quot;locationId&quot;:&quot;sunt&quot;,&quot;metadata&quot;:{},&quot;name&quot;:&quot;et dolore occaecat veniam nulla&quot;}],&quot;nextPageToken&quot;:&quot;dol&quot;}