Google

Proximity Beacon API

Registers, manages, indexes, and searches beacons.

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Registers, manages, indexes, and searches beacons.

Endpoints 17

beaconinfo

  • POSTproximitybeacon.beaconinfo.getforobserved/v1beta1/beaconinfo:getforobserved?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=stringGiven one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the API key for the…

beacons

  • GETproximitybeacon.beacons.list/v1beta1/beacons?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&pageSize=0&pageToken=string&projectId=string&q=stringSearches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned.…
  • POSTproximitybeacon.beacons.register/v1beta1/beacons:register?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringRegisters a previously unregistered beacon given its advertisedId. These IDs are unique within the system. An ID can be registered only once. Authenticate…
  • DELETEproximitybeacon.beacons.attachments.delete/v1beta1/:attachmentName?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringDeletes the specified attachment for the given beacon. Each attachment has a unique attachment name (attachmentName) which is returned when you fetch the…
  • GETproximitybeacon.beacons.get/v1beta1/:beaconName?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringReturns detailed information about the specified beacon. Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit…
  • PUTproximitybeacon.beacons.update/v1beta1/:beaconName?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringUpdates the information about the specified beacon. Any field that you do not populate in the submitted beacon will be permanently erased, so you should…
  • DELETEproximitybeacon.beacons.delete/v1beta1/:beaconName?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringDeletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the beacon (including those belonging to other…
  • GETproximitybeacon.beacons.attachments.list/v1beta1/:beaconName/attachments?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&namespacedType=string&projectId=stringReturns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the…
  • POSTproximitybeacon.beacons.attachments.create/v1beta1/:beaconName/attachments?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringAssociates the given data with the specified beacon. Attachment data must contain two parts: - A namespaced type. - The actual attachment data itself. The…
  • POSTproximitybeacon.beacons.attachments.batchDelete/v1beta1/:beaconName/attachments:batchDelete?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&namespacedType=string&projectId=stringDeletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify namespacedType to choose which…
  • GETproximitybeacon.beacons.diagnostics.list/v1beta1/:beaconName/diagnostics?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&alertFilter=ALERT_UNSPECIFIED&pageSize=0&pageToken=string&projectId=stringList the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the…
  • POSTproximitybeacon.beacons.activate/v1beta1/:beaconName:activate?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringActivates a beacon. A beacon that is active will return information and attachment data when queried via beaconinfo.getforobserved. Calling this method on an…
  • POSTproximitybeacon.beacons.deactivate/v1beta1/:beaconName:deactivate?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringDeactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via beaconinfo.getforobserved.…
  • POSTproximitybeacon.beacons.decommission/v1beta1/:beaconName:decommission?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringDecommissions the specified beacon in the service. This beacon will no longer be returned from beaconinfo.getforobserved. This operation is permanent -- you…

namespaces

  • GETproximitybeacon.namespaces.list/v1beta1/namespaces?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringLists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and…
  • PUTproximitybeacon.namespaces.update/v1beta1/:namespaceName?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string&projectId=stringUpdates the information about the specified namespace. Only the namespace visibility can be updated.

v1beta1

  • GETproximitybeacon.getEidparams/v1beta1/eidparams?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=stringGets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon…

API details

Base URL
https://proximitybeacon.googleapis.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
OAuth 2.0 (authorization code flow) with 1 scope
Operations
17 operations on 14 pathsPOST 7GET 6PUT 2DELETE 2
Main resources
beacons 13namespaces 2beaconinfo 1v1beta1 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v1beta1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Proximity Beacon API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Proximity Beacon API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “proximitybeacon.beaconinfo.getforobserved” (POST /v1beta1/beaconinfo:getforobserved?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&upload_protocol=string&uploadType=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Proximity Beacon API?

Registers, manages, indexes, and searches beacons. It is listed under Developer tools and has 17 endpoints.

Who publishes the Proximity Beacon API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Proximity Beacon API?

Requests go to https://proximitybeacon.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Proximity Beacon API?

It accepts 2 methods: OAuth 2.0 (implicit flow) with 1 scope; OAuth 2.0 (authorization code flow) with 1 scope.

How many endpoints does the Proximity Beacon API have?

17 operations on 14 paths (7 POST, 6 GET, 2 PUT, 2 DELETE). The largest groups are beacons, namespaces, beaconinfo, v1beta1.

Is forking the Proximity Beacon API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.