Returns detailed information about the specified beacon.
Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project.
Requests may supply an Eddystone-EID beacon name in the form: beacons/4!beaconId
where the beaconId
is the base16 ephemeral ID broadcast by the beacon. The returned Beacon
object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.
HTTP request
GET https://proximitybeacon.googleapis.com/v1beta1/{beaconName=beacons/*}
The URL uses Google API HTTP annotation syntax.
Path parameters
Parameters | |
---|---|
beaconName |
Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are |
Query parameters
Parameters | |
---|---|
projectId |
The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Beacon
.
Authorization
Requires the following OAuth scope:
https://www.googleapis.com/auth/userlocation.beacon.registry
For more information, see the Auth Guide.