firestore.projects.locations.get

GET {{baseUrl}}/v1/:name?mask.fieldPaths=<string>&mask.fieldPaths=<string>&readTime=<string>&transaction=<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>

Gets information about a location.

Request Params

KeyDatatypeRequiredDescription
mask.fieldPathsstringThe list of field paths in the mask. See Document.fields for a field path syntax reference.
mask.fieldPathsstringThe list of field paths in the mask. See Document.fields for a field path syntax reference.
readTimestringReads the version of the document at the given time. This may not be older than 270 seconds.
transactionstringReads the document in a transaction.
$.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;displayName&quot;:&quot;mollit occaecat adipisicing minim eu&quot;,&quot;labels&quot;:{},&quot;locationId&quot;:&quot;tempor occaecat aute&quot;,&quot;metadata&quot;:{},&quot;name&quot;:&quot;ullamco id ut consequat in&quot;}