Collection: beaconinfo

Resource: BeaconInfo

A subset of beacon information served via the beaconinfo.getforobserved method, which you call when users of your app encounter your beacons.

JSON representation
{
  "advertisedId": {
    object(AdvertisedId)
  },
  "beaconName": string,
  "attachments": [
    {
      object(AttachmentInfo)
    }
  ],
}
Fields
advertisedId

object(AdvertisedId)

The ID advertised by the beacon.

beaconName

string

The name under which the beacon is registered.

attachments[]

object(AttachmentInfo)

Attachments matching the type(s) requested. May be empty if no attachment types were requested.

AttachmentInfo

A subset of attachment information served via the beaconinfo.getforobserved method, used when your users encounter your beacons.

JSON representation
{
  "namespacedType": string,
  "data": string,
}
Fields
namespacedType

string

Specifies what kind of attachment this is. Tells a client how to interpret the data field. Format is namespace/type, for example scrupulous-wombat-12345/welcome-message

data

string (bytes format)

An opaque data container for client-provided data.

A base64-encoded string.

Methods

getforobserved

Given one or more beacon observations, returns any beacon information and attachments accessible to your application.