Guides Reference Samples Support

Method: beaconinfo.getforobserved

Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the API key for the application.

HTTP request

POST https://proximitybeacon.googleapis.com/v1beta1/beaconinfo:getforobserved

The URL uses Google API HTTP annotation syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "observations": [
    {
      object(Observation)
    }
  ],
  "namespacedTypes": [
    string
  ],
}
Fields
observations[]

object(Observation)

The beacons that the client has encountered. At least one must be given.

namespacedTypes[]

string

Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format namespace/type. Accepts * to specify all types in all namespaces owned by the client. Optional.

Response body

If successful, the response body contains data with the following structure:

Information about the requested beacons, optionally including attachment data.

JSON representation 
{
  "beacons": [
    {
      object(BeaconInfo)
    }
  ],
}
Fields
beacons[]

object(BeaconInfo)

Public information about beacons. May be empty if the request matched no beacons.

Observation

Represents one beacon observed once.

JSON representation 
{
  "advertisedId": {
    object(AdvertisedId)
  },
  "telemetry": string,
  "timestampMs": string,
}
Fields
advertisedId

object(AdvertisedId)

The ID advertised by the beacon the client has encountered.

If the submitted advertisedId type is Eddystone-EID, then the client must be authorized to resolve the given beacon. Otherwise no data will be returned for that beacon. Required.
telemetry

string (bytes format)

The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally.

A base64-encoded string.
timestampMs

string (Timestamp format)

Time when the beacon was observed.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".