Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned.
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.
HTTP request
GET https://proximitybeacon.googleapis.com/v1beta1/beacons
The URL uses Google API HTTP annotation syntax.
Query parameters
Parameters | |
---|---|
q |
Filter query string that supports the following field filters:
Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces. As with any HTTP query string parameter, the whole filter expression must be URL-encoded. Example REST request: |
pageToken |
A pagination token obtained from a previous request to list beacons. |
pageSize |
The maximum number of records to return for this request, up to a server-defined upper limit. |
projectId |
The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response that contains list beacon results and pagination help.
JSON representation | |
---|---|
{
"beacons": [
{
object( |
Fields | |
---|---|
beacons[] |
The beacons that matched the search criteria. |
nextPageToken |
An opaque pagination token that the client may provide in their next request to retrieve the next page of results. |
totalCount |
Estimate of the total number of beacons matched by the query. Higher values may be less accurate. |
Authorization
Requires the following OAuth scope:
https://www.googleapis.com/auth/userlocation.beacon.registry
For more information, see the Auth Guide.