1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="proximitybeacon_v1beta1.html">Proximity Beacon API</a> . <a href="proximitybeacon_v1beta1.beacons.html">beacons</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="proximitybeacon_v1beta1.beacons.attachments.html">attachments()</a></code> 79</p> 80<p class="firstline">Returns the attachments Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="proximitybeacon_v1beta1.beacons.diagnostics.html">diagnostics()</a></code> 84</p> 85<p class="firstline">Returns the diagnostics Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#activate">activate(beaconName, projectId=None, x__xgafv=None)</a></code></p> 89<p class="firstline">Activates a beacon. A beacon that is active will return information</p> 90<p class="toc_element"> 91 <code><a href="#deactivate">deactivate(beaconName, projectId=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Deactivates a beacon. Once deactivated, the API will not return</p> 93<p class="toc_element"> 94 <code><a href="#decommission">decommission(beaconName, projectId=None, x__xgafv=None)</a></code></p> 95<p class="firstline">Decommissions the specified beacon in the service. This beacon will no</p> 96<p class="toc_element"> 97 <code><a href="#delete">delete(beaconName, projectId=None, x__xgafv=None)</a></code></p> 98<p class="firstline">Deletes the specified beacon including all diagnostics data for the beacon</p> 99<p class="toc_element"> 100 <code><a href="#get">get(beaconName, projectId=None, x__xgafv=None)</a></code></p> 101<p class="firstline">Returns detailed information about the specified beacon.</p> 102<p class="toc_element"> 103 <code><a href="#list">list(pageSize=None, pageToken=None, projectId=None, q=None, syntax=None, x__xgafv=None)</a></code></p> 104<p class="firstline">Searches the beacon registry for beacons that match the given search</p> 105<p class="toc_element"> 106 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 107<p class="firstline">Retrieves the next page of results.</p> 108<p class="toc_element"> 109 <code><a href="#register">register(body, projectId=None, x__xgafv=None)</a></code></p> 110<p class="firstline">Registers a previously unregistered beacon given its `advertisedId`.</p> 111<p class="toc_element"> 112 <code><a href="#update">update(beaconName, body, projectId=None, x__xgafv=None)</a></code></p> 113<p class="firstline">Updates the information about the specified beacon. **Any field that you do</p> 114<h3>Method Details</h3> 115<div class="method"> 116 <code class="details" id="activate">activate(beaconName, projectId=None, x__xgafv=None)</code> 117 <pre>Activates a beacon. A beacon that is active will return information 118and attachment data when queried via `beaconinfo.getforobserved`. 119Calling this method on an already active beacon will do nothing (but 120will return a successful response code). 121 122Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 123from a signed-in user with **Is owner** or **Can edit** permissions in the 124Google Developers Console project. 125 126Args: 127 beaconName: string, Beacon that should be activated. A beacon name has the format 128"beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 129the beacon and N is a code for the beacon's type. Possible values are 130`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` 131for AltBeacon. For Eddystone-EID beacons, you may use either the 132current EID or the beacon's "stable" UID. 133Required. (required) 134 projectId: string, The project id of the beacon to activate. If the project id is not 135specified then the project making the request is used. The project id 136must match the project that owns the beacon. 137Optional. 138 x__xgafv: string, V1 error format. 139 Allowed values 140 1 - v1 error format 141 2 - v2 error format 142 143Returns: 144 An object of the form: 145 146 { # A generic empty message that you can re-use to avoid defining duplicated 147 # empty messages in your APIs. A typical example is to use it as the request 148 # or the response type of an API method. For instance: 149 # 150 # service Foo { 151 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 152 # } 153 # 154 # The JSON representation for `Empty` is empty JSON object `{}`. 155 }</pre> 156</div> 157 158<div class="method"> 159 <code class="details" id="deactivate">deactivate(beaconName, projectId=None, x__xgafv=None)</code> 160 <pre>Deactivates a beacon. Once deactivated, the API will not return 161information nor attachment data for the beacon when queried via 162`beaconinfo.getforobserved`. Calling this method on an already inactive 163beacon will do nothing (but will return a successful response code). 164 165Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 166from a signed-in user with **Is owner** or **Can edit** permissions in the 167Google Developers Console project. 168 169Args: 170 beaconName: string, Beacon that should be deactivated. A beacon name has the format 171"beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 172the beacon and N is a code for the beacon's type. Possible values are 173`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` 174for AltBeacon. For Eddystone-EID beacons, you may use either the 175current EID or the beacon's "stable" UID. 176Required. (required) 177 projectId: string, The project id of the beacon to deactivate. If the project id is not 178specified then the project making the request is used. The project id must 179match the project that owns the beacon. 180Optional. 181 x__xgafv: string, V1 error format. 182 Allowed values 183 1 - v1 error format 184 2 - v2 error format 185 186Returns: 187 An object of the form: 188 189 { # A generic empty message that you can re-use to avoid defining duplicated 190 # empty messages in your APIs. A typical example is to use it as the request 191 # or the response type of an API method. For instance: 192 # 193 # service Foo { 194 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 195 # } 196 # 197 # The JSON representation for `Empty` is empty JSON object `{}`. 198 }</pre> 199</div> 200 201<div class="method"> 202 <code class="details" id="decommission">decommission(beaconName, projectId=None, x__xgafv=None)</code> 203 <pre>Decommissions the specified beacon in the service. This beacon will no 204longer be returned from `beaconinfo.getforobserved`. This operation is 205permanent -- you will not be able to re-register a beacon with this ID 206again. 207 208Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 209from a signed-in user with **Is owner** or **Can edit** permissions in the 210Google Developers Console project. 211 212Args: 213 beaconName: string, Beacon that should be decommissioned. A beacon name has the format 214"beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 215the beacon and N is a code for the beacon's type. Possible values are 216`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` 217for AltBeacon. For Eddystone-EID beacons, you may use either the 218current EID of the beacon's "stable" UID. 219Required. (required) 220 projectId: string, The project id of the beacon to decommission. If the project id is not 221specified then the project making the request is used. The project id 222must match the project that owns the beacon. 223Optional. 224 x__xgafv: string, V1 error format. 225 Allowed values 226 1 - v1 error format 227 2 - v2 error format 228 229Returns: 230 An object of the form: 231 232 { # A generic empty message that you can re-use to avoid defining duplicated 233 # empty messages in your APIs. A typical example is to use it as the request 234 # or the response type of an API method. For instance: 235 # 236 # service Foo { 237 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 238 # } 239 # 240 # The JSON representation for `Empty` is empty JSON object `{}`. 241 }</pre> 242</div> 243 244<div class="method"> 245 <code class="details" id="delete">delete(beaconName, projectId=None, x__xgafv=None)</code> 246 <pre>Deletes the specified beacon including all diagnostics data for the beacon 247as well as any attachments on the beacon (including those belonging to 248other projects). This operation cannot be undone. 249 250Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 251from a signed-in user with **Is owner** or **Can edit** permissions in the 252Google Developers Console project. 253 254Args: 255 beaconName: string, Beacon that should be deleted. A beacon name has the format 256"beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 257the beacon and N is a code for the beacon's type. Possible values are 258`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` 259for AltBeacon. For Eddystone-EID beacons, you may use either the 260current EID or the beacon's "stable" UID. 261Required. (required) 262 projectId: string, The project id of the beacon to delete. If not provided, the project 263that is making the request is used. 264Optional. 265 x__xgafv: string, V1 error format. 266 Allowed values 267 1 - v1 error format 268 2 - v2 error format 269 270Returns: 271 An object of the form: 272 273 { # A generic empty message that you can re-use to avoid defining duplicated 274 # empty messages in your APIs. A typical example is to use it as the request 275 # or the response type of an API method. For instance: 276 # 277 # service Foo { 278 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 279 # } 280 # 281 # The JSON representation for `Empty` is empty JSON object `{}`. 282 }</pre> 283</div> 284 285<div class="method"> 286 <code class="details" id="get">get(beaconName, projectId=None, x__xgafv=None)</code> 287 <pre>Returns detailed information about the specified beacon. 288 289Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 290from a signed-in user with **viewer**, **Is owner** or **Can edit** 291permissions in the Google Developers Console project. 292 293Requests may supply an Eddystone-EID beacon name in the form: 294`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID 295broadcast by the beacon. The returned `Beacon` object will contain the 296beacon's stable Eddystone-UID. Clients not authorized to resolve the 297beacon's ephemeral Eddystone-EID broadcast will receive an error. 298 299Args: 300 beaconName: string, Resource name of this beacon. A beacon name has the format 301"beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 302the beacon and N is a code for the beacon's type. Possible values are 303`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` 304for AltBeacon. For Eddystone-EID beacons, you may use either the 305current EID or the beacon's "stable" UID. 306Required. (required) 307 projectId: string, The project id of the beacon to request. If the project id is not specified 308then the project making the request is used. The project id must match the 309project that owns the beacon. 310Optional. 311 x__xgafv: string, V1 error format. 312 Allowed values 313 1 - v1 error format 314 2 - v2 error format 315 316Returns: 317 An object of the form: 318 319 { # Details of a beacon device. 320 "status": "A String", # Current status of the beacon. 321 # Required. 322 "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 323 # characters. 324 # Optional. 325 "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, # The indoor level information for this beacon, if known. As returned by the 326 # Google Maps API. 327 # Optional. 328 # useful to indicate which floor of a building a beacon is located on. 329 "name": "A String", # The name of this level. 330 }, 331 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The location of the beacon, expressed as a latitude and longitude pair. 332 # This location is given when the beacon is registered or updated. It does 333 # not necessarily indicate the actual current location of the beacon. 334 # Optional. 335 # of doubles representing degrees latitude and degrees longitude. Unless 336 # specified otherwise, this must conform to the 337 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 338 # standard</a>. Values must be within normalized ranges. 339 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. 340 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 341 }, 342 "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where 343 # the beacon is deployed. This is given when the beacon is registered or 344 # updated, not automatically detected in any way. 345 # Optional. 346 "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. # Write-only registration parameters for beacons using Eddystone-EID 347 # (remotely resolved ephemeral ID) format. This information will not be 348 # populated in API responses. When submitting this data, the `advertised_id` 349 # field must contain an ID of type Eddystone-UID. Any other ID type will 350 # result in an error. 351 # Two ways of securely registering an Eddystone-EID beacon with the service 352 # are supported: 353 # 354 # 1. Perform an ECDH key exchange via this API, including a previous call 355 # to `GET /v1beta1/eidparams`. In this case the fields 356 # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be 357 # populated and `beacon_identity_key` should not be populated. This 358 # method ensures that only the two parties in the ECDH key exchange can 359 # compute the identity key, which becomes a secret between them. 360 # 2. Derive or obtain the beacon's identity key via other secure means 361 # (perhaps an ECDH key exchange between the beacon and a mobile device 362 # or any other secure method), and then submit the resulting identity key 363 # to the service. In this case `beacon_identity_key` field should be 364 # populated, and neither of `beacon_ecdh_public_key` nor 365 # `service_ecdh_public_key` fields should be. The security of this method 366 # depends on how securely the parties involved (in particular the 367 # bluetooth client) handle the identity key, and obviously on how 368 # securely the identity key was generated. 369 # 370 # See [the Eddystone 371 # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) 372 # at GitHub. 373 "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's 374 # ephemeral ID. "Nominal" because the beacon should randomize the 375 # actual interval. See [the spec at 376 # github](https://github.com/google/eddystone/tree/master/eddystone-eid) 377 # for details. This value corresponds to a power-of-two scaler on the 378 # beacon's clock: when the scaler value is K, the beacon will begin 379 # broadcasting a new ephemeral ID on average every 2^K seconds. 380 "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have 381 # begun counting at this value immediately prior to transmitting this 382 # value to the resolving service. Significant delay in transmitting this 383 # value to the service risks registration or resolution failures. If a 384 # value is not provided, the default is zero. 385 "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman 386 # key exchange. When this field is populated, `service_ecdh_public_key` 387 # must also be populated, and `beacon_identity_key` must not be. 388 "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as 389 # `initial_clock_value`, and the secret key generated by the 390 # Diffie-Hellman key exchange using `service_ecdh_public_key` and 391 # `service_ecdh_public_key`. This initial EID value will be used by the 392 # service to confirm that the key exchange process was successful. 393 "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman 394 # key exchange. When this field is populated, `beacon_ecdh_public_key` 395 # must also be populated, and `beacon_identity_key` must not be. 396 "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, 397 # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be 398 # populated. 399 }, 400 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be 401 # populated when registering. It may be empty when updating a beacon 402 # record because it is ignored in updates. 403 # 404 # When registering a beacon that broadcasts Eddystone-EID, this field 405 # should contain a "stable" Eddystone-UID that identifies the beacon and 406 # links it to its attachments. The stable Eddystone-UID is only used for 407 # administering the beacon. 408 "type": "A String", # Specifies the identifier type. 409 # Required. 410 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be 411 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP 412 # requests, and will be so encoded (with padding) in responses. The base64 413 # encoding should be of the binary byte-stream and not any textual (such as 414 # hex) representation thereof. 415 # Required. 416 }, 417 "beaconName": "A String", # Resource name of this beacon. A beacon name has the format 418 # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 419 # the beacon and N is a code for the beacon's type. Possible values are 420 # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. 421 # 422 # This field must be left empty when registering. After reading a beacon, 423 # clients can use the name for future operations. 424 "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or 425 # updated, not automatically detected in any way. 426 # Optional. 427 "properties": { # Properties of the beacon device, for example battery type or firmware 428 # version. 429 # Optional. 430 "a_key": "A String", 431 }, 432 "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before 433 # changing any of its configuration (e.g. broadcast frames, transmit power). 434 # This field provides a place to store and control access to that key. 435 # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` 436 # from users with write access to the given beacon. That is to say: If the 437 # user is authorized to write the beacon's confidential data in the service, 438 # the service considers them authorized to configure the beacon. Note 439 # that this key grants nothing on the service, only on the beacon itself. 440 }</pre> 441</div> 442 443<div class="method"> 444 <code class="details" id="list">list(pageSize=None, pageToken=None, projectId=None, q=None, syntax=None, x__xgafv=None)</code> 445 <pre>Searches the beacon registry for beacons that match the given search 446criteria. Only those beacons that the client has permission to list 447will be returned. 448 449Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 450from a signed-in user with **viewer**, **Is owner** or **Can edit** 451permissions in the Google Developers Console project. 452 453Args: 454 pageSize: integer, The maximum number of records to return for this request, up to a 455server-defined upper limit. 456 pageToken: string, A pagination token obtained from a previous request to list beacons. 457 projectId: string, The project id to list beacons under. If not present then the project 458credential that made the request is used as the project. 459Optional. 460 q: string, Filter query string that supports the following field filters: 461 462* **description:`"<string>"`** 463 For example: **description:"Room 3"** 464 Returns beacons whose description matches tokens in the string "Room 3" 465 (not necessarily that exact string). 466 The string must be double-quoted. 467* **status:`<enum>`** 468 For example: **status:active** 469 Returns beacons whose status matches the given value. Values must be 470 one of the Beacon.Status enum values (case insensitive). Accepts 471 multiple filters which will be combined with OR logic. 472* **stability:`<enum>`** 473 For example: **stability:mobile** 474 Returns beacons whose expected stability matches the given value. 475 Values must be one of the Beacon.Stability enum values (case 476 insensitive). Accepts multiple filters which will be combined with 477 OR logic. 478* **place\_id:`"<string>"`** 479 For example: **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="** 480 Returns beacons explicitly registered at the given place, expressed as 481 a Place ID obtained from [Google Places API](/places/place-id). Does not 482 match places inside the given place. Does not consider the beacon's 483 actual location (which may be different from its registered place). 484 Accepts multiple filters that will be combined with OR logic. The place 485 ID must be double-quoted. 486* **registration\_time`[<|>|<=|>=]<integer>`** 487 For example: **registration\_time>=1433116800** 488 Returns beacons whose registration time matches the given filter. 489 Supports the operators: <, >, <=, and >=. Timestamp must be expressed as 490 an integer number of seconds since midnight January 1, 1970 UTC. Accepts 491 at most two filters that will be combined with AND logic, to support 492 "between" semantics. If more than two are supplied, the latter ones are 493 ignored. 494* **lat:`<double> lng:<double> radius:<integer>`** 495 For example: **lat:51.1232343 lng:-1.093852 radius:1000** 496 Returns beacons whose registered location is within the given circle. 497 When any of these fields are given, all are required. Latitude and 498 longitude must be decimal degrees between -90.0 and 90.0 and between 499 -180.0 and 180.0 respectively. Radius must be an integer number of 500 meters between 10 and 1,000,000 (1000 km). 501* **property:`"<string>=<string>"`** 502 For example: **property:"battery-type=CR2032"** 503 Returns beacons which have a property of the given name and value. 504 Supports multiple filters which will be combined with OR logic. 505 The entire name=value string must be double-quoted as one string. 506* **attachment\_type:`"<string>"`** 507 For example: **attachment_type:"my-namespace/my-type"** 508 Returns beacons having at least one attachment of the given namespaced 509 type. Supports "any within this namespace" via the partial wildcard 510 syntax: "my-namespace/*". Supports multiple filters which will be 511 combined with OR logic. The string must be double-quoted. 512* **indoor\_level:`"<string>"`** 513 For example: **indoor\_level:"1"** 514 Returns beacons which are located on the given indoor level. Accepts 515 multiple filters that will be combined with OR logic. 516 517Multiple filters on the same field are combined with OR logic (except 518registration_time which is combined with AND logic). 519Multiple filters on different fields are combined with AND logic. 520Filters should be separated by spaces. 521 522As with any HTTP query string parameter, the whole filter expression must 523be URL-encoded. 524 525Example REST request: 526`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000` 527 x__xgafv: string, V1 error format. 528 Allowed values 529 1 - v1 error format 530 2 - v2 error format 531 532Returns: 533 An object of the form: 534 535 { # Response that contains list beacon results and pagination help. 536 "nextPageToken": "A String", # An opaque pagination token that the client may provide in their next 537 # request to retrieve the next page of results. 538 "beacons": [ # The beacons that matched the search criteria. 539 { # Details of a beacon device. 540 "status": "A String", # Current status of the beacon. 541 # Required. 542 "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 543 # characters. 544 # Optional. 545 "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, # The indoor level information for this beacon, if known. As returned by the 546 # Google Maps API. 547 # Optional. 548 # useful to indicate which floor of a building a beacon is located on. 549 "name": "A String", # The name of this level. 550 }, 551 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The location of the beacon, expressed as a latitude and longitude pair. 552 # This location is given when the beacon is registered or updated. It does 553 # not necessarily indicate the actual current location of the beacon. 554 # Optional. 555 # of doubles representing degrees latitude and degrees longitude. Unless 556 # specified otherwise, this must conform to the 557 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 558 # standard</a>. Values must be within normalized ranges. 559 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. 560 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 561 }, 562 "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where 563 # the beacon is deployed. This is given when the beacon is registered or 564 # updated, not automatically detected in any way. 565 # Optional. 566 "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. # Write-only registration parameters for beacons using Eddystone-EID 567 # (remotely resolved ephemeral ID) format. This information will not be 568 # populated in API responses. When submitting this data, the `advertised_id` 569 # field must contain an ID of type Eddystone-UID. Any other ID type will 570 # result in an error. 571 # Two ways of securely registering an Eddystone-EID beacon with the service 572 # are supported: 573 # 574 # 1. Perform an ECDH key exchange via this API, including a previous call 575 # to `GET /v1beta1/eidparams`. In this case the fields 576 # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be 577 # populated and `beacon_identity_key` should not be populated. This 578 # method ensures that only the two parties in the ECDH key exchange can 579 # compute the identity key, which becomes a secret between them. 580 # 2. Derive or obtain the beacon's identity key via other secure means 581 # (perhaps an ECDH key exchange between the beacon and a mobile device 582 # or any other secure method), and then submit the resulting identity key 583 # to the service. In this case `beacon_identity_key` field should be 584 # populated, and neither of `beacon_ecdh_public_key` nor 585 # `service_ecdh_public_key` fields should be. The security of this method 586 # depends on how securely the parties involved (in particular the 587 # bluetooth client) handle the identity key, and obviously on how 588 # securely the identity key was generated. 589 # 590 # See [the Eddystone 591 # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) 592 # at GitHub. 593 "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's 594 # ephemeral ID. "Nominal" because the beacon should randomize the 595 # actual interval. See [the spec at 596 # github](https://github.com/google/eddystone/tree/master/eddystone-eid) 597 # for details. This value corresponds to a power-of-two scaler on the 598 # beacon's clock: when the scaler value is K, the beacon will begin 599 # broadcasting a new ephemeral ID on average every 2^K seconds. 600 "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have 601 # begun counting at this value immediately prior to transmitting this 602 # value to the resolving service. Significant delay in transmitting this 603 # value to the service risks registration or resolution failures. If a 604 # value is not provided, the default is zero. 605 "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman 606 # key exchange. When this field is populated, `service_ecdh_public_key` 607 # must also be populated, and `beacon_identity_key` must not be. 608 "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as 609 # `initial_clock_value`, and the secret key generated by the 610 # Diffie-Hellman key exchange using `service_ecdh_public_key` and 611 # `service_ecdh_public_key`. This initial EID value will be used by the 612 # service to confirm that the key exchange process was successful. 613 "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman 614 # key exchange. When this field is populated, `beacon_ecdh_public_key` 615 # must also be populated, and `beacon_identity_key` must not be. 616 "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, 617 # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be 618 # populated. 619 }, 620 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be 621 # populated when registering. It may be empty when updating a beacon 622 # record because it is ignored in updates. 623 # 624 # When registering a beacon that broadcasts Eddystone-EID, this field 625 # should contain a "stable" Eddystone-UID that identifies the beacon and 626 # links it to its attachments. The stable Eddystone-UID is only used for 627 # administering the beacon. 628 "type": "A String", # Specifies the identifier type. 629 # Required. 630 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be 631 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP 632 # requests, and will be so encoded (with padding) in responses. The base64 633 # encoding should be of the binary byte-stream and not any textual (such as 634 # hex) representation thereof. 635 # Required. 636 }, 637 "beaconName": "A String", # Resource name of this beacon. A beacon name has the format 638 # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 639 # the beacon and N is a code for the beacon's type. Possible values are 640 # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. 641 # 642 # This field must be left empty when registering. After reading a beacon, 643 # clients can use the name for future operations. 644 "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or 645 # updated, not automatically detected in any way. 646 # Optional. 647 "properties": { # Properties of the beacon device, for example battery type or firmware 648 # version. 649 # Optional. 650 "a_key": "A String", 651 }, 652 "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before 653 # changing any of its configuration (e.g. broadcast frames, transmit power). 654 # This field provides a place to store and control access to that key. 655 # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` 656 # from users with write access to the given beacon. That is to say: If the 657 # user is authorized to write the beacon's confidential data in the service, 658 # the service considers them authorized to configure the beacon. Note 659 # that this key grants nothing on the service, only on the beacon itself. 660 }, 661 ], 662 "totalCount": "A String", # Estimate of the total number of beacons matched by the query. Higher 663 # values may be less accurate. 664 }</pre> 665</div> 666 667<div class="method"> 668 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 669 <pre>Retrieves the next page of results. 670 671Args: 672 previous_request: The request for the previous page. (required) 673 previous_response: The response from the request for the previous page. (required) 674 675Returns: 676 A request object that you can call 'execute()' on to request the next 677 page. Returns None if there are no more items in the collection. 678 </pre> 679</div> 680 681<div class="method"> 682 <code class="details" id="register">register(body, projectId=None, x__xgafv=None)</code> 683 <pre>Registers a previously unregistered beacon given its `advertisedId`. 684These IDs are unique within the system. An ID can be registered only once. 685 686Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 687from a signed-in user with **Is owner** or **Can edit** permissions in the 688Google Developers Console project. 689 690Args: 691 body: object, The request body. (required) 692 The object takes the form of: 693 694{ # Details of a beacon device. 695 "status": "A String", # Current status of the beacon. 696 # Required. 697 "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 698 # characters. 699 # Optional. 700 "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, # The indoor level information for this beacon, if known. As returned by the 701 # Google Maps API. 702 # Optional. 703 # useful to indicate which floor of a building a beacon is located on. 704 "name": "A String", # The name of this level. 705 }, 706 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The location of the beacon, expressed as a latitude and longitude pair. 707 # This location is given when the beacon is registered or updated. It does 708 # not necessarily indicate the actual current location of the beacon. 709 # Optional. 710 # of doubles representing degrees latitude and degrees longitude. Unless 711 # specified otherwise, this must conform to the 712 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 713 # standard</a>. Values must be within normalized ranges. 714 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. 715 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 716 }, 717 "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where 718 # the beacon is deployed. This is given when the beacon is registered or 719 # updated, not automatically detected in any way. 720 # Optional. 721 "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. # Write-only registration parameters for beacons using Eddystone-EID 722 # (remotely resolved ephemeral ID) format. This information will not be 723 # populated in API responses. When submitting this data, the `advertised_id` 724 # field must contain an ID of type Eddystone-UID. Any other ID type will 725 # result in an error. 726 # Two ways of securely registering an Eddystone-EID beacon with the service 727 # are supported: 728 # 729 # 1. Perform an ECDH key exchange via this API, including a previous call 730 # to `GET /v1beta1/eidparams`. In this case the fields 731 # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be 732 # populated and `beacon_identity_key` should not be populated. This 733 # method ensures that only the two parties in the ECDH key exchange can 734 # compute the identity key, which becomes a secret between them. 735 # 2. Derive or obtain the beacon's identity key via other secure means 736 # (perhaps an ECDH key exchange between the beacon and a mobile device 737 # or any other secure method), and then submit the resulting identity key 738 # to the service. In this case `beacon_identity_key` field should be 739 # populated, and neither of `beacon_ecdh_public_key` nor 740 # `service_ecdh_public_key` fields should be. The security of this method 741 # depends on how securely the parties involved (in particular the 742 # bluetooth client) handle the identity key, and obviously on how 743 # securely the identity key was generated. 744 # 745 # See [the Eddystone 746 # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) 747 # at GitHub. 748 "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's 749 # ephemeral ID. "Nominal" because the beacon should randomize the 750 # actual interval. See [the spec at 751 # github](https://github.com/google/eddystone/tree/master/eddystone-eid) 752 # for details. This value corresponds to a power-of-two scaler on the 753 # beacon's clock: when the scaler value is K, the beacon will begin 754 # broadcasting a new ephemeral ID on average every 2^K seconds. 755 "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have 756 # begun counting at this value immediately prior to transmitting this 757 # value to the resolving service. Significant delay in transmitting this 758 # value to the service risks registration or resolution failures. If a 759 # value is not provided, the default is zero. 760 "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman 761 # key exchange. When this field is populated, `service_ecdh_public_key` 762 # must also be populated, and `beacon_identity_key` must not be. 763 "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as 764 # `initial_clock_value`, and the secret key generated by the 765 # Diffie-Hellman key exchange using `service_ecdh_public_key` and 766 # `service_ecdh_public_key`. This initial EID value will be used by the 767 # service to confirm that the key exchange process was successful. 768 "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman 769 # key exchange. When this field is populated, `beacon_ecdh_public_key` 770 # must also be populated, and `beacon_identity_key` must not be. 771 "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, 772 # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be 773 # populated. 774 }, 775 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be 776 # populated when registering. It may be empty when updating a beacon 777 # record because it is ignored in updates. 778 # 779 # When registering a beacon that broadcasts Eddystone-EID, this field 780 # should contain a "stable" Eddystone-UID that identifies the beacon and 781 # links it to its attachments. The stable Eddystone-UID is only used for 782 # administering the beacon. 783 "type": "A String", # Specifies the identifier type. 784 # Required. 785 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be 786 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP 787 # requests, and will be so encoded (with padding) in responses. The base64 788 # encoding should be of the binary byte-stream and not any textual (such as 789 # hex) representation thereof. 790 # Required. 791 }, 792 "beaconName": "A String", # Resource name of this beacon. A beacon name has the format 793 # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 794 # the beacon and N is a code for the beacon's type. Possible values are 795 # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. 796 # 797 # This field must be left empty when registering. After reading a beacon, 798 # clients can use the name for future operations. 799 "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or 800 # updated, not automatically detected in any way. 801 # Optional. 802 "properties": { # Properties of the beacon device, for example battery type or firmware 803 # version. 804 # Optional. 805 "a_key": "A String", 806 }, 807 "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before 808 # changing any of its configuration (e.g. broadcast frames, transmit power). 809 # This field provides a place to store and control access to that key. 810 # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` 811 # from users with write access to the given beacon. That is to say: If the 812 # user is authorized to write the beacon's confidential data in the service, 813 # the service considers them authorized to configure the beacon. Note 814 # that this key grants nothing on the service, only on the beacon itself. 815} 816 817 projectId: string, The project id of the project the beacon will be registered to. If 818the project id is not specified then the project making the request 819is used. 820Optional. 821 x__xgafv: string, V1 error format. 822 Allowed values 823 1 - v1 error format 824 2 - v2 error format 825 826Returns: 827 An object of the form: 828 829 { # Details of a beacon device. 830 "status": "A String", # Current status of the beacon. 831 # Required. 832 "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 833 # characters. 834 # Optional. 835 "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, # The indoor level information for this beacon, if known. As returned by the 836 # Google Maps API. 837 # Optional. 838 # useful to indicate which floor of a building a beacon is located on. 839 "name": "A String", # The name of this level. 840 }, 841 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The location of the beacon, expressed as a latitude and longitude pair. 842 # This location is given when the beacon is registered or updated. It does 843 # not necessarily indicate the actual current location of the beacon. 844 # Optional. 845 # of doubles representing degrees latitude and degrees longitude. Unless 846 # specified otherwise, this must conform to the 847 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 848 # standard</a>. Values must be within normalized ranges. 849 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. 850 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 851 }, 852 "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where 853 # the beacon is deployed. This is given when the beacon is registered or 854 # updated, not automatically detected in any way. 855 # Optional. 856 "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. # Write-only registration parameters for beacons using Eddystone-EID 857 # (remotely resolved ephemeral ID) format. This information will not be 858 # populated in API responses. When submitting this data, the `advertised_id` 859 # field must contain an ID of type Eddystone-UID. Any other ID type will 860 # result in an error. 861 # Two ways of securely registering an Eddystone-EID beacon with the service 862 # are supported: 863 # 864 # 1. Perform an ECDH key exchange via this API, including a previous call 865 # to `GET /v1beta1/eidparams`. In this case the fields 866 # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be 867 # populated and `beacon_identity_key` should not be populated. This 868 # method ensures that only the two parties in the ECDH key exchange can 869 # compute the identity key, which becomes a secret between them. 870 # 2. Derive or obtain the beacon's identity key via other secure means 871 # (perhaps an ECDH key exchange between the beacon and a mobile device 872 # or any other secure method), and then submit the resulting identity key 873 # to the service. In this case `beacon_identity_key` field should be 874 # populated, and neither of `beacon_ecdh_public_key` nor 875 # `service_ecdh_public_key` fields should be. The security of this method 876 # depends on how securely the parties involved (in particular the 877 # bluetooth client) handle the identity key, and obviously on how 878 # securely the identity key was generated. 879 # 880 # See [the Eddystone 881 # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) 882 # at GitHub. 883 "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's 884 # ephemeral ID. "Nominal" because the beacon should randomize the 885 # actual interval. See [the spec at 886 # github](https://github.com/google/eddystone/tree/master/eddystone-eid) 887 # for details. This value corresponds to a power-of-two scaler on the 888 # beacon's clock: when the scaler value is K, the beacon will begin 889 # broadcasting a new ephemeral ID on average every 2^K seconds. 890 "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have 891 # begun counting at this value immediately prior to transmitting this 892 # value to the resolving service. Significant delay in transmitting this 893 # value to the service risks registration or resolution failures. If a 894 # value is not provided, the default is zero. 895 "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman 896 # key exchange. When this field is populated, `service_ecdh_public_key` 897 # must also be populated, and `beacon_identity_key` must not be. 898 "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as 899 # `initial_clock_value`, and the secret key generated by the 900 # Diffie-Hellman key exchange using `service_ecdh_public_key` and 901 # `service_ecdh_public_key`. This initial EID value will be used by the 902 # service to confirm that the key exchange process was successful. 903 "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman 904 # key exchange. When this field is populated, `beacon_ecdh_public_key` 905 # must also be populated, and `beacon_identity_key` must not be. 906 "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, 907 # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be 908 # populated. 909 }, 910 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be 911 # populated when registering. It may be empty when updating a beacon 912 # record because it is ignored in updates. 913 # 914 # When registering a beacon that broadcasts Eddystone-EID, this field 915 # should contain a "stable" Eddystone-UID that identifies the beacon and 916 # links it to its attachments. The stable Eddystone-UID is only used for 917 # administering the beacon. 918 "type": "A String", # Specifies the identifier type. 919 # Required. 920 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be 921 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP 922 # requests, and will be so encoded (with padding) in responses. The base64 923 # encoding should be of the binary byte-stream and not any textual (such as 924 # hex) representation thereof. 925 # Required. 926 }, 927 "beaconName": "A String", # Resource name of this beacon. A beacon name has the format 928 # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 929 # the beacon and N is a code for the beacon's type. Possible values are 930 # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. 931 # 932 # This field must be left empty when registering. After reading a beacon, 933 # clients can use the name for future operations. 934 "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or 935 # updated, not automatically detected in any way. 936 # Optional. 937 "properties": { # Properties of the beacon device, for example battery type or firmware 938 # version. 939 # Optional. 940 "a_key": "A String", 941 }, 942 "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before 943 # changing any of its configuration (e.g. broadcast frames, transmit power). 944 # This field provides a place to store and control access to that key. 945 # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` 946 # from users with write access to the given beacon. That is to say: If the 947 # user is authorized to write the beacon's confidential data in the service, 948 # the service considers them authorized to configure the beacon. Note 949 # that this key grants nothing on the service, only on the beacon itself. 950 }</pre> 951</div> 952 953<div class="method"> 954 <code class="details" id="update">update(beaconName, body, projectId=None, x__xgafv=None)</code> 955 <pre>Updates the information about the specified beacon. **Any field that you do 956not populate in the submitted beacon will be permanently erased**, so you 957should follow the "read, modify, write" pattern to avoid inadvertently 958destroying data. 959 960Changes to the beacon status via this method will be silently ignored. 961To update beacon status, use the separate methods on this API for 962activation, deactivation, and decommissioning. 963Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) 964from a signed-in user with **Is owner** or **Can edit** permissions in the 965Google Developers Console project. 966 967Args: 968 beaconName: string, Resource name of this beacon. A beacon name has the format 969"beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 970the beacon and N is a code for the beacon's type. Possible values are 971`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. 972 973This field must be left empty when registering. After reading a beacon, 974clients can use the name for future operations. (required) 975 body: object, The request body. (required) 976 The object takes the form of: 977 978{ # Details of a beacon device. 979 "status": "A String", # Current status of the beacon. 980 # Required. 981 "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 982 # characters. 983 # Optional. 984 "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, # The indoor level information for this beacon, if known. As returned by the 985 # Google Maps API. 986 # Optional. 987 # useful to indicate which floor of a building a beacon is located on. 988 "name": "A String", # The name of this level. 989 }, 990 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The location of the beacon, expressed as a latitude and longitude pair. 991 # This location is given when the beacon is registered or updated. It does 992 # not necessarily indicate the actual current location of the beacon. 993 # Optional. 994 # of doubles representing degrees latitude and degrees longitude. Unless 995 # specified otherwise, this must conform to the 996 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 997 # standard</a>. Values must be within normalized ranges. 998 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. 999 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 1000 }, 1001 "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where 1002 # the beacon is deployed. This is given when the beacon is registered or 1003 # updated, not automatically detected in any way. 1004 # Optional. 1005 "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. # Write-only registration parameters for beacons using Eddystone-EID 1006 # (remotely resolved ephemeral ID) format. This information will not be 1007 # populated in API responses. When submitting this data, the `advertised_id` 1008 # field must contain an ID of type Eddystone-UID. Any other ID type will 1009 # result in an error. 1010 # Two ways of securely registering an Eddystone-EID beacon with the service 1011 # are supported: 1012 # 1013 # 1. Perform an ECDH key exchange via this API, including a previous call 1014 # to `GET /v1beta1/eidparams`. In this case the fields 1015 # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be 1016 # populated and `beacon_identity_key` should not be populated. This 1017 # method ensures that only the two parties in the ECDH key exchange can 1018 # compute the identity key, which becomes a secret between them. 1019 # 2. Derive or obtain the beacon's identity key via other secure means 1020 # (perhaps an ECDH key exchange between the beacon and a mobile device 1021 # or any other secure method), and then submit the resulting identity key 1022 # to the service. In this case `beacon_identity_key` field should be 1023 # populated, and neither of `beacon_ecdh_public_key` nor 1024 # `service_ecdh_public_key` fields should be. The security of this method 1025 # depends on how securely the parties involved (in particular the 1026 # bluetooth client) handle the identity key, and obviously on how 1027 # securely the identity key was generated. 1028 # 1029 # See [the Eddystone 1030 # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) 1031 # at GitHub. 1032 "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's 1033 # ephemeral ID. "Nominal" because the beacon should randomize the 1034 # actual interval. See [the spec at 1035 # github](https://github.com/google/eddystone/tree/master/eddystone-eid) 1036 # for details. This value corresponds to a power-of-two scaler on the 1037 # beacon's clock: when the scaler value is K, the beacon will begin 1038 # broadcasting a new ephemeral ID on average every 2^K seconds. 1039 "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have 1040 # begun counting at this value immediately prior to transmitting this 1041 # value to the resolving service. Significant delay in transmitting this 1042 # value to the service risks registration or resolution failures. If a 1043 # value is not provided, the default is zero. 1044 "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman 1045 # key exchange. When this field is populated, `service_ecdh_public_key` 1046 # must also be populated, and `beacon_identity_key` must not be. 1047 "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as 1048 # `initial_clock_value`, and the secret key generated by the 1049 # Diffie-Hellman key exchange using `service_ecdh_public_key` and 1050 # `service_ecdh_public_key`. This initial EID value will be used by the 1051 # service to confirm that the key exchange process was successful. 1052 "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman 1053 # key exchange. When this field is populated, `beacon_ecdh_public_key` 1054 # must also be populated, and `beacon_identity_key` must not be. 1055 "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, 1056 # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be 1057 # populated. 1058 }, 1059 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be 1060 # populated when registering. It may be empty when updating a beacon 1061 # record because it is ignored in updates. 1062 # 1063 # When registering a beacon that broadcasts Eddystone-EID, this field 1064 # should contain a "stable" Eddystone-UID that identifies the beacon and 1065 # links it to its attachments. The stable Eddystone-UID is only used for 1066 # administering the beacon. 1067 "type": "A String", # Specifies the identifier type. 1068 # Required. 1069 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be 1070 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP 1071 # requests, and will be so encoded (with padding) in responses. The base64 1072 # encoding should be of the binary byte-stream and not any textual (such as 1073 # hex) representation thereof. 1074 # Required. 1075 }, 1076 "beaconName": "A String", # Resource name of this beacon. A beacon name has the format 1077 # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 1078 # the beacon and N is a code for the beacon's type. Possible values are 1079 # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. 1080 # 1081 # This field must be left empty when registering. After reading a beacon, 1082 # clients can use the name for future operations. 1083 "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or 1084 # updated, not automatically detected in any way. 1085 # Optional. 1086 "properties": { # Properties of the beacon device, for example battery type or firmware 1087 # version. 1088 # Optional. 1089 "a_key": "A String", 1090 }, 1091 "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before 1092 # changing any of its configuration (e.g. broadcast frames, transmit power). 1093 # This field provides a place to store and control access to that key. 1094 # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` 1095 # from users with write access to the given beacon. That is to say: If the 1096 # user is authorized to write the beacon's confidential data in the service, 1097 # the service considers them authorized to configure the beacon. Note 1098 # that this key grants nothing on the service, only on the beacon itself. 1099} 1100 1101 projectId: string, The project id of the beacon to update. If the project id is not 1102specified then the project making the request is used. The project id 1103must match the project that owns the beacon. 1104Optional. 1105 x__xgafv: string, V1 error format. 1106 Allowed values 1107 1 - v1 error format 1108 2 - v2 error format 1109 1110Returns: 1111 An object of the form: 1112 1113 { # Details of a beacon device. 1114 "status": "A String", # Current status of the beacon. 1115 # Required. 1116 "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 1117 # characters. 1118 # Optional. 1119 "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, # The indoor level information for this beacon, if known. As returned by the 1120 # Google Maps API. 1121 # Optional. 1122 # useful to indicate which floor of a building a beacon is located on. 1123 "name": "A String", # The name of this level. 1124 }, 1125 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The location of the beacon, expressed as a latitude and longitude pair. 1126 # This location is given when the beacon is registered or updated. It does 1127 # not necessarily indicate the actual current location of the beacon. 1128 # Optional. 1129 # of doubles representing degrees latitude and degrees longitude. Unless 1130 # specified otherwise, this must conform to the 1131 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 1132 # standard</a>. Values must be within normalized ranges. 1133 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. 1134 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 1135 }, 1136 "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where 1137 # the beacon is deployed. This is given when the beacon is registered or 1138 # updated, not automatically detected in any way. 1139 # Optional. 1140 "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. # Write-only registration parameters for beacons using Eddystone-EID 1141 # (remotely resolved ephemeral ID) format. This information will not be 1142 # populated in API responses. When submitting this data, the `advertised_id` 1143 # field must contain an ID of type Eddystone-UID. Any other ID type will 1144 # result in an error. 1145 # Two ways of securely registering an Eddystone-EID beacon with the service 1146 # are supported: 1147 # 1148 # 1. Perform an ECDH key exchange via this API, including a previous call 1149 # to `GET /v1beta1/eidparams`. In this case the fields 1150 # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be 1151 # populated and `beacon_identity_key` should not be populated. This 1152 # method ensures that only the two parties in the ECDH key exchange can 1153 # compute the identity key, which becomes a secret between them. 1154 # 2. Derive or obtain the beacon's identity key via other secure means 1155 # (perhaps an ECDH key exchange between the beacon and a mobile device 1156 # or any other secure method), and then submit the resulting identity key 1157 # to the service. In this case `beacon_identity_key` field should be 1158 # populated, and neither of `beacon_ecdh_public_key` nor 1159 # `service_ecdh_public_key` fields should be. The security of this method 1160 # depends on how securely the parties involved (in particular the 1161 # bluetooth client) handle the identity key, and obviously on how 1162 # securely the identity key was generated. 1163 # 1164 # See [the Eddystone 1165 # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) 1166 # at GitHub. 1167 "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's 1168 # ephemeral ID. "Nominal" because the beacon should randomize the 1169 # actual interval. See [the spec at 1170 # github](https://github.com/google/eddystone/tree/master/eddystone-eid) 1171 # for details. This value corresponds to a power-of-two scaler on the 1172 # beacon's clock: when the scaler value is K, the beacon will begin 1173 # broadcasting a new ephemeral ID on average every 2^K seconds. 1174 "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have 1175 # begun counting at this value immediately prior to transmitting this 1176 # value to the resolving service. Significant delay in transmitting this 1177 # value to the service risks registration or resolution failures. If a 1178 # value is not provided, the default is zero. 1179 "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman 1180 # key exchange. When this field is populated, `service_ecdh_public_key` 1181 # must also be populated, and `beacon_identity_key` must not be. 1182 "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as 1183 # `initial_clock_value`, and the secret key generated by the 1184 # Diffie-Hellman key exchange using `service_ecdh_public_key` and 1185 # `service_ecdh_public_key`. This initial EID value will be used by the 1186 # service to confirm that the key exchange process was successful. 1187 "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman 1188 # key exchange. When this field is populated, `beacon_ecdh_public_key` 1189 # must also be populated, and `beacon_identity_key` must not be. 1190 "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, 1191 # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be 1192 # populated. 1193 }, 1194 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be 1195 # populated when registering. It may be empty when updating a beacon 1196 # record because it is ignored in updates. 1197 # 1198 # When registering a beacon that broadcasts Eddystone-EID, this field 1199 # should contain a "stable" Eddystone-UID that identifies the beacon and 1200 # links it to its attachments. The stable Eddystone-UID is only used for 1201 # administering the beacon. 1202 "type": "A String", # Specifies the identifier type. 1203 # Required. 1204 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be 1205 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP 1206 # requests, and will be so encoded (with padding) in responses. The base64 1207 # encoding should be of the binary byte-stream and not any textual (such as 1208 # hex) representation thereof. 1209 # Required. 1210 }, 1211 "beaconName": "A String", # Resource name of this beacon. A beacon name has the format 1212 # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by 1213 # the beacon and N is a code for the beacon's type. Possible values are 1214 # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. 1215 # 1216 # This field must be left empty when registering. After reading a beacon, 1217 # clients can use the name for future operations. 1218 "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or 1219 # updated, not automatically detected in any way. 1220 # Optional. 1221 "properties": { # Properties of the beacon device, for example battery type or firmware 1222 # version. 1223 # Optional. 1224 "a_key": "A String", 1225 }, 1226 "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before 1227 # changing any of its configuration (e.g. broadcast frames, transmit power). 1228 # This field provides a place to store and control access to that key. 1229 # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` 1230 # from users with write access to the given beacon. That is to say: If the 1231 # user is authorized to write the beacon's confidential data in the service, 1232 # the service considers them authorized to configure the beacon. Note 1233 # that this key grants nothing on the service, only on the beacon itself. 1234 }</pre> 1235</div> 1236 1237</body></html>