Activates a beacon. A beacon that is active will return information and attachment data when queried via beaconinfo.getforobserved
. Calling this method on an already active beacon will do nothing (but will return a successful response code).
Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.
HTTP request
POST https://proximitybeacon.googleapis.com/v1beta1/{beaconName=beacons/*}:activate
The URL uses Google API HTTP annotation syntax.
Path parameters
Parameters | |
---|---|
beaconName |
Beacon that should be activated. 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 activate. 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 will be empty.
Authorization
Requires the following OAuth scope:
https://www.googleapis.com/auth/userlocation.beacon.registry
For more information, see the Auth Guide.