The Google beacon platform is deprecated as of December 7, 2020. The platform will shut down on April 1, 2021.

Method: beacons.register

Registers a previously unregistered beacon given its advertisedId. These IDs are unique within the system. An ID can be registered only once.

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


The URL uses Google API HTTP annotation syntax.

Query parameters



The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used. Optional.

Request body

The request body contains an instance of Beacon.

Response body

If successful, the response body contains an instance of Beacon.


Requires the following OAuth scope:


For more information, see the Auth Guide.