Class Beacon
Details of a beacon device.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Proximitybeacon.v1beta1.Data
Assembly: Google.Apis.Proximitybeacon.v1beta1.dll
Syntax
public class Beacon : IDirectResponseSchema
Properties
AdvertisedId
The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates.
When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
Declaration
[JsonProperty("advertisedId")]
public virtual AdvertisedId AdvertisedId { get; set; }
Property Value
Type | Description |
---|---|
AdvertisedId |
BeaconName
Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId
is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are 3
for
Eddystone, 1
for iBeacon, or 5
for AltBeacon.
This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
Declaration
[JsonProperty("beaconName")]
public virtual string BeaconName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Description
Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EphemeralIdRegistration
Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID)
format. This information will not be populated in API responses. When submitting this data, the
advertised_id
field must contain an ID of type Eddystone-UID. Any other ID type will result in an
error.
Declaration
[JsonProperty("ephemeralIdRegistration")]
public virtual EphemeralIdRegistration EphemeralIdRegistration { get; set; }
Property Value
Type | Description |
---|---|
EphemeralIdRegistration |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ExpectedStability
Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
Declaration
[JsonProperty("expectedStability")]
public virtual string ExpectedStability { get; set; }
Property Value
Type | Description |
---|---|
System.String |
IndoorLevel
The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
Declaration
[JsonProperty("indoorLevel")]
public virtual IndoorLevel IndoorLevel { get; set; }
Property Value
Type | Description |
---|---|
IndoorLevel |
LatLng
The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
Declaration
[JsonProperty("latLng")]
public virtual LatLng LatLng { get; set; }
Property Value
Type | Description |
---|---|
LatLng |
PlaceId
The Google Places API Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
Declaration
[JsonProperty("placeId")]
public virtual string PlaceId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Properties
Properties of the beacon device, for example battery type or firmware version. Optional.
Declaration
[JsonProperty("properties")]
public virtual IDictionary<string, string> Properties { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.String> |
ProvisioningKey
Some beacons may require a user to provide an authorization key before changing any of its
configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control
access to that key. This field is populated in responses to GET /v1beta1/beacons/3!beaconId
from users
with write access to the given beacon. That is to say: If the user is authorized to write the beacon's
confidential data in the service, the service considers them authorized to configure the beacon. Note that
this key grants nothing on the service, only on the beacon itself.
Declaration
[JsonProperty("provisioningKey")]
public virtual string ProvisioningKey { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Status
Current status of the beacon. Required.
Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type | Description |
---|---|
System.String |