OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/userlocation.beacon.registry":
{ | 5 "https://www.googleapis.com/auth/userlocation.beacon.registry":
{ |
6 "description": "View and modify your beacons" | 6 "description": "View and modify your beacons" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://proximitybeacon.googleapis.com/", | 12 "baseUrl": "https://proximitybeacon.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "description": "Registers, manages, indexes, and searches beacons.", | 14 "description": "Registers, manages, indexes, and searches beacons.", |
15 "discoveryVersion": "v1", | 15 "discoveryVersion": "v1", |
16 "documentationLink": "https://developers.google.com/beacons/proximity/", | 16 "documentationLink": "https://developers.google.com/beacons/proximity/", |
17 "icons": { | 17 "icons": { |
18 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 18 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
19 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 19 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
20 }, | 20 }, |
21 "id": "proximitybeacon:v1beta1", | 21 "id": "proximitybeacon:v1beta1", |
22 "kind": "discovery#restDescription", | 22 "kind": "discovery#restDescription", |
23 "name": "proximitybeacon", | 23 "name": "proximitybeacon", |
24 "ownerDomain": "google.com", | 24 "ownerDomain": "google.com", |
25 "ownerName": "Google", | 25 "ownerName": "Google", |
26 "parameters": { | 26 "parameters": { |
27 "upload_protocol": { | |
28 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
29 "location": "query", | |
30 "type": "string" | |
31 }, | |
32 "prettyPrint": { | |
33 "default": "true", | |
34 "description": "Returns response with indentations and line breaks."
, | |
35 "location": "query", | |
36 "type": "boolean" | |
37 }, | |
38 "fields": { | |
39 "description": "Selector specifying which fields to include in a par
tial response.", | |
40 "location": "query", | |
41 "type": "string" | |
42 }, | |
43 "uploadType": { | |
44 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
45 "location": "query", | |
46 "type": "string" | |
47 }, | |
48 "callback": { | |
49 "description": "JSONP", | |
50 "location": "query", | |
51 "type": "string" | |
52 }, | |
53 "$.xgafv": { | 27 "$.xgafv": { |
54 "description": "V1 error format.", | 28 "description": "V1 error format.", |
55 "enum": [ | 29 "enum": [ |
56 "1", | 30 "1", |
57 "2" | 31 "2" |
58 ], | 32 ], |
59 "enumDescriptions": [ | 33 "enumDescriptions": [ |
60 "v1 error format", | 34 "v1 error format", |
61 "v2 error format" | 35 "v2 error format" |
62 ], | 36 ], |
63 "location": "query", | 37 "location": "query", |
64 "type": "string" | 38 "type": "string" |
65 }, | 39 }, |
| 40 "callback": { |
| 41 "description": "JSONP", |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
66 "alt": { | 45 "alt": { |
67 "default": "json", | 46 "default": "json", |
68 "description": "Data format for response.", | 47 "description": "Data format for response.", |
69 "enum": [ | 48 "enum": [ |
70 "json", | 49 "json", |
71 "media", | 50 "media", |
72 "proto" | 51 "proto" |
73 ], | 52 ], |
74 "enumDescriptions": [ | 53 "enumDescriptions": [ |
75 "Responses with Content-Type of application/json", | 54 "Responses with Content-Type of application/json", |
76 "Media download with context-dependent Content-Type", | 55 "Media download with context-dependent Content-Type", |
77 "Responses with Content-Type of application/x-protobuf" | 56 "Responses with Content-Type of application/x-protobuf" |
78 ], | 57 ], |
79 "location": "query", | 58 "location": "query", |
80 "type": "string" | 59 "type": "string" |
81 }, | 60 }, |
| 61 "access_token": { |
| 62 "description": "OAuth access token.", |
| 63 "location": "query", |
| 64 "type": "string" |
| 65 }, |
82 "key": { | 66 "key": { |
83 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 67 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
84 "location": "query", | 68 "location": "query", |
85 "type": "string" | 69 "type": "string" |
86 }, | 70 }, |
87 "access_token": { | |
88 "description": "OAuth access token.", | |
89 "location": "query", | |
90 "type": "string" | |
91 }, | |
92 "quotaUser": { | 71 "quotaUser": { |
93 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 72 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
94 "location": "query", | 73 "location": "query", |
95 "type": "string" | 74 "type": "string" |
96 }, | 75 }, |
97 "pp": { | 76 "pp": { |
98 "default": "true", | 77 "default": "true", |
99 "description": "Pretty-print response.", | 78 "description": "Pretty-print response.", |
100 "location": "query", | 79 "location": "query", |
101 "type": "boolean" | 80 "type": "boolean" |
102 }, | 81 }, |
| 82 "oauth_token": { |
| 83 "description": "OAuth 2.0 token for the current user.", |
| 84 "location": "query", |
| 85 "type": "string" |
| 86 }, |
103 "bearer_token": { | 87 "bearer_token": { |
104 "description": "OAuth bearer token.", | 88 "description": "OAuth bearer token.", |
105 "location": "query", | 89 "location": "query", |
106 "type": "string" | 90 "type": "string" |
107 }, | 91 }, |
108 "oauth_token": { | 92 "upload_protocol": { |
109 "description": "OAuth 2.0 token for the current user.", | 93 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 94 "location": "query", |
| 95 "type": "string" |
| 96 }, |
| 97 "prettyPrint": { |
| 98 "default": "true", |
| 99 "description": "Returns response with indentations and line breaks."
, |
| 100 "location": "query", |
| 101 "type": "boolean" |
| 102 }, |
| 103 "fields": { |
| 104 "description": "Selector specifying which fields to include in a par
tial response.", |
| 105 "location": "query", |
| 106 "type": "string" |
| 107 }, |
| 108 "uploadType": { |
| 109 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
110 "location": "query", | 110 "location": "query", |
111 "type": "string" | 111 "type": "string" |
112 } | 112 } |
113 }, | 113 }, |
114 "protocol": "rest", | 114 "protocol": "rest", |
115 "resources": { | 115 "resources": { |
116 "beaconinfo": { | 116 "beaconinfo": { |
117 "methods": { | 117 "methods": { |
118 "getforobserved": { | 118 "getforobserved": { |
119 "description": "Given one or more beacon observations, retur
ns any beacon information\nand attachments accessible to your application. Autho
rize by using the\n[API key](https://developers.google.com/beacons/proximity/how
-tos/authorizing#APIKey)\nfor the application.", | 119 "description": "Given one or more beacon observations, retur
ns any beacon information\nand attachments accessible to your application. Autho
rize by using the\n[API key](https://developers.google.com/beacons/proximity/get
-started#request_a_browser_api_key)\nfor the application.", |
120 "httpMethod": "POST", | 120 "httpMethod": "POST", |
121 "id": "proximitybeacon.beaconinfo.getforobserved", | 121 "id": "proximitybeacon.beaconinfo.getforobserved", |
122 "parameterOrder": [], | 122 "parameterOrder": [], |
123 "parameters": {}, | 123 "parameters": {}, |
124 "path": "v1beta1/beaconinfo:getforobserved", | 124 "path": "v1beta1/beaconinfo:getforobserved", |
125 "request": { | 125 "request": { |
126 "$ref": "GetInfoForObservedBeaconsRequest" | 126 "$ref": "GetInfoForObservedBeaconsRequest" |
127 }, | 127 }, |
128 "response": { | 128 "response": { |
129 "$ref": "GetInfoForObservedBeaconsResponse" | 129 "$ref": "GetInfoForObservedBeaconsResponse" |
(...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
200 "$ref": "EphemeralIdRegistrationParams" | 200 "$ref": "EphemeralIdRegistrationParams" |
201 }, | 201 }, |
202 "scopes": [ | 202 "scopes": [ |
203 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 203 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
204 ] | 204 ] |
205 } | 205 } |
206 } | 206 } |
207 }, | 207 }, |
208 "beacons": { | 208 "beacons": { |
209 "methods": { | 209 "methods": { |
210 "activate": { | |
211 "description": "Activates a beacon. A beacon that is active
will return information\nand attachment data when queried via `beaconinfo.getfor
observed`.\nCalling this method on an already active beacon will do nothing (but
\nwill return a successful response code).\n\nAuthenticate using an [OAuth acces
s token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed
-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers
Console project.", | |
212 "httpMethod": "POST", | |
213 "id": "proximitybeacon.beacons.activate", | |
214 "parameterOrder": [ | |
215 "beaconName" | |
216 ], | |
217 "parameters": { | |
218 "beaconName": { | |
219 "description": "Beacon that should be activated. A b
eacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base
16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible v
alues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID
or the beacon's \"stable\" UID.\nRequired.", | |
220 "location": "path", | |
221 "pattern": "^beacons/[^/]+$", | |
222 "required": true, | |
223 "type": "string" | |
224 }, | |
225 "projectId": { | |
226 "description": "The project id of the beacon to acti
vate. If the project id is not\nspecified then the project making the request is
used. The project id\nmust match the project that owns the beacon.\nOptional.", | |
227 "location": "query", | |
228 "type": "string" | |
229 } | |
230 }, | |
231 "path": "v1beta1/{+beaconName}:activate", | |
232 "response": { | |
233 "$ref": "Empty" | |
234 }, | |
235 "scopes": [ | |
236 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | |
237 ] | |
238 }, | |
239 "get": { | 210 "get": { |
240 "description": "Returns detailed information about the speci
fied beacon.\n\nAuthenticate using an [OAuth access token](https://developers.go
ogle.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is
owner** or **Can edit**\npermissions in the Google Developers Console project.\
n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!bea
conId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon.
The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. C
lients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast
will receive an error.", | 211 "description": "Returns detailed information about the speci
fied beacon.\n\nAuthenticate using an [OAuth access token](https://developers.go
ogle.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is
owner** or **Can edit**\npermissions in the Google Developers Console project.\
n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!bea
conId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon.
The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. C
lients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast
will receive an error.", |
241 "httpMethod": "GET", | 212 "httpMethod": "GET", |
242 "id": "proximitybeacon.beacons.get", | 213 "id": "proximitybeacon.beacons.get", |
243 "parameterOrder": [ | 214 "parameterOrder": [ |
244 "beaconName" | 215 "beaconName" |
245 ], | 216 ], |
246 "parameters": { | 217 "parameters": { |
247 "projectId": { | 218 "projectId": { |
248 "description": "The project id of the beacon to requ
est. If the project id is not specified\nthen the project making the request is
used. The project id must match the\nproject that owns the beacon.\nOptional.", | 219 "description": "The project id of the beacon to requ
est. If the project id is not specified\nthen the project making the request is
used. The project id must match the\nproject that owns the beacon.\nOptional.", |
(...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
319 } | 290 } |
320 }, | 291 }, |
321 "path": "v1beta1/{+beaconName}:decommission", | 292 "path": "v1beta1/{+beaconName}:decommission", |
322 "response": { | 293 "response": { |
323 "$ref": "Empty" | 294 "$ref": "Empty" |
324 }, | 295 }, |
325 "scopes": [ | 296 "scopes": [ |
326 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 297 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
327 ] | 298 ] |
328 }, | 299 }, |
329 "delete": { | 300 "deactivate": { |
330 "description": "Deletes the specified beacon including all d
iagnostics data for the beacon\nas well as any attachments on the beacon (includ
ing those belonging to\nother projects). This operation cannot be undone.\n\nAut
henticate using an [OAuth access token](https://developers.google.com/identity/p
rotocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permis
sions in the\nGoogle Developers Console project.", | 301 "description": "Deactivates a beacon. Once deactivated, the
API will not return\ninformation nor attachment data for the beacon when queried
via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nb
eacon will do nothing (but will return a successful response code).\n\nAuthentic
ate using an [OAuth access token](https://developers.google.com/identity/protoco
ls/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions
in the\nGoogle Developers Console project.", |
331 "httpMethod": "DELETE", | 302 "httpMethod": "POST", |
332 "id": "proximitybeacon.beacons.delete", | 303 "id": "proximitybeacon.beacons.deactivate", |
333 "parameterOrder": [ | 304 "parameterOrder": [ |
334 "beaconName" | 305 "beaconName" |
335 ], | 306 ], |
336 "parameters": { | 307 "parameters": { |
337 "beaconName": { | 308 "beaconName": { |
338 "description": "Beacon that should be deleted. A bea
con name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16
ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible val
ues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\n
for AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or
the beacon's \"stable\" UID.\nRequired.", | 309 "description": "Beacon that should be deactivated. A
beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the ba
se16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible
values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `
5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EI
D or the beacon's \"stable\" UID.\nRequired.", |
339 "location": "path", | 310 "location": "path", |
340 "pattern": "^beacons/[^/]+$", | 311 "pattern": "^beacons/[^/]+$", |
341 "required": true, | 312 "required": true, |
342 "type": "string" | 313 "type": "string" |
343 }, | 314 }, |
344 "projectId": { | 315 "projectId": { |
345 "description": "The project id of the beacon to dele
te. If not provided, the project\nthat is making the request is used.\nOptional.
", | 316 "description": "The project id of the beacon to deac
tivate. If the project id is not\nspecified then the project making the request
is used. The project id must\nmatch the project that owns the beacon.\nOptional.
", |
346 "location": "query", | 317 "location": "query", |
347 "type": "string" | 318 "type": "string" |
348 } | 319 } |
349 }, | 320 }, |
350 "path": "v1beta1/{+beaconName}", | 321 "path": "v1beta1/{+beaconName}:deactivate", |
351 "response": { | 322 "response": { |
352 "$ref": "Empty" | 323 "$ref": "Empty" |
353 }, | 324 }, |
354 "scopes": [ | 325 "scopes": [ |
355 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 326 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
356 ] | 327 ] |
357 }, | 328 }, |
358 "deactivate": { | 329 "delete": { |
359 "description": "Deactivates a beacon. Once deactivated, the
API will not return\ninformation nor attachment data for the beacon when queried
via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nb
eacon will do nothing (but will return a successful response code).\n\nAuthentic
ate using an [OAuth access token](https://developers.google.com/identity/protoco
ls/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions
in the\nGoogle Developers Console project.", | 330 "description": "Deletes the specified beacon including all d
iagnostics data for the beacon\nas well as any attachments on the beacon (includ
ing those belonging to\nother projects). This operation cannot be undone.\n\nAut
henticate using an [OAuth access token](https://developers.google.com/identity/p
rotocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permis
sions in the\nGoogle Developers Console project.", |
360 "httpMethod": "POST", | 331 "httpMethod": "DELETE", |
361 "id": "proximitybeacon.beacons.deactivate", | 332 "id": "proximitybeacon.beacons.delete", |
362 "parameterOrder": [ | 333 "parameterOrder": [ |
363 "beaconName" | 334 "beaconName" |
364 ], | 335 ], |
365 "parameters": { | 336 "parameters": { |
366 "beaconName": { | 337 "beaconName": { |
367 "description": "Beacon that should be deactivated. A
beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the ba
se16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible
values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `
5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EI
D or the beacon's \"stable\" UID.\nRequired.", | 338 "description": "Beacon that should be deleted. A bea
con name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16
ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible val
ues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\n
for AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or
the beacon's \"stable\" UID.\nRequired.", |
368 "location": "path", | 339 "location": "path", |
369 "pattern": "^beacons/[^/]+$", | 340 "pattern": "^beacons/[^/]+$", |
370 "required": true, | 341 "required": true, |
371 "type": "string" | 342 "type": "string" |
372 }, | 343 }, |
373 "projectId": { | 344 "projectId": { |
374 "description": "The project id of the beacon to deac
tivate. If the project id is not\nspecified then the project making the request
is used. The project id must\nmatch the project that owns the beacon.\nOptional.
", | 345 "description": "The project id of the beacon to dele
te. If not provided, the project\nthat is making the request is used.\nOptional.
", |
375 "location": "query", | 346 "location": "query", |
376 "type": "string" | 347 "type": "string" |
377 } | 348 } |
378 }, | 349 }, |
379 "path": "v1beta1/{+beaconName}:deactivate", | 350 "path": "v1beta1/{+beaconName}", |
380 "response": { | 351 "response": { |
381 "$ref": "Empty" | 352 "$ref": "Empty" |
382 }, | 353 }, |
383 "scopes": [ | 354 "scopes": [ |
384 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 355 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
385 ] | 356 ] |
386 }, | 357 }, |
387 "register": { | 358 "register": { |
388 "description": "Registers a previously unregistered beacon g
iven its `advertisedId`.\nThese IDs are unique within the system. An ID can be r
egistered only once.\n\nAuthenticate using an [OAuth access token](https://devel
opers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is own
er** or **Can edit** permissions in the\nGoogle Developers Console project.", | 359 "description": "Registers a previously unregistered beacon g
iven its `advertisedId`.\nThese IDs are unique within the system. An ID can be r
egistered only once.\n\nAuthenticate using an [OAuth access token](https://devel
opers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is own
er** or **Can edit** permissions in the\nGoogle Developers Console project.", |
389 "httpMethod": "POST", | 360 "httpMethod": "POST", |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
435 "type": "string" | 406 "type": "string" |
436 } | 407 } |
437 }, | 408 }, |
438 "path": "v1beta1/beacons", | 409 "path": "v1beta1/beacons", |
439 "response": { | 410 "response": { |
440 "$ref": "ListBeaconsResponse" | 411 "$ref": "ListBeaconsResponse" |
441 }, | 412 }, |
442 "scopes": [ | 413 "scopes": [ |
443 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 414 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
444 ] | 415 ] |
| 416 }, |
| 417 "activate": { |
| 418 "description": "Activates a beacon. A beacon that is active
will return information\nand attachment data when queried via `beaconinfo.getfor
observed`.\nCalling this method on an already active beacon will do nothing (but
\nwill return a successful response code).\n\nAuthenticate using an [OAuth acces
s token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed
-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers
Console project.", |
| 419 "httpMethod": "POST", |
| 420 "id": "proximitybeacon.beacons.activate", |
| 421 "parameterOrder": [ |
| 422 "beaconName" |
| 423 ], |
| 424 "parameters": { |
| 425 "projectId": { |
| 426 "description": "The project id of the beacon to acti
vate. If the project id is not\nspecified then the project making the request is
used. The project id\nmust match the project that owns the beacon.\nOptional.", |
| 427 "location": "query", |
| 428 "type": "string" |
| 429 }, |
| 430 "beaconName": { |
| 431 "description": "Beacon that should be activated. A b
eacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base
16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible v
alues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID
or the beacon's \"stable\" UID.\nRequired.", |
| 432 "location": "path", |
| 433 "pattern": "^beacons/[^/]+$", |
| 434 "required": true, |
| 435 "type": "string" |
| 436 } |
| 437 }, |
| 438 "path": "v1beta1/{+beaconName}:activate", |
| 439 "response": { |
| 440 "$ref": "Empty" |
| 441 }, |
| 442 "scopes": [ |
| 443 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 444 ] |
445 } | 445 } |
446 }, | 446 }, |
447 "resources": { | 447 "resources": { |
| 448 "diagnostics": { |
| 449 "methods": { |
| 450 "list": { |
| 451 "description": "List the diagnostics for a single be
acon. You can also list diagnostics for\nall the beacons owned by your Google De
velopers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate
using an [OAuth access token](https://developers.google.com/identity/protocols/O
Auth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\nper
missions in the Google Developers Console project.", |
| 452 "httpMethod": "GET", |
| 453 "id": "proximitybeacon.beacons.diagnostics.list", |
| 454 "parameterOrder": [ |
| 455 "beaconName" |
| 456 ], |
| 457 "parameters": { |
| 458 "pageSize": { |
| 459 "description": "Specifies the maximum number
of results to return. Defaults to\n10. Maximum 1000. Optional.", |
| 460 "format": "int32", |
| 461 "location": "query", |
| 462 "type": "integer" |
| 463 }, |
| 464 "alertFilter": { |
| 465 "description": "Requests only beacons that h
ave the given alert. For example, to find\nbeacons that have low batteries use `
alert_filter=LOW_BATTERY`.", |
| 466 "enum": [ |
| 467 "ALERT_UNSPECIFIED", |
| 468 "WRONG_LOCATION", |
| 469 "LOW_BATTERY" |
| 470 ], |
| 471 "location": "query", |
| 472 "type": "string" |
| 473 }, |
| 474 "projectId": { |
| 475 "description": "Requests only diagnostic rec
ords for the given project id. If not set,\nthen the project making the request
will be used for looking up\ndiagnostic records. Optional.", |
| 476 "location": "query", |
| 477 "type": "string" |
| 478 }, |
| 479 "beaconName": { |
| 480 "description": "Beacon that the diagnostics
are for.", |
| 481 "location": "path", |
| 482 "pattern": "^beacons/[^/]+$", |
| 483 "required": true, |
| 484 "type": "string" |
| 485 }, |
| 486 "pageToken": { |
| 487 "description": "Requests results that occur
after the `page_token`, obtained from the\nresponse to a previous request. Optio
nal.", |
| 488 "location": "query", |
| 489 "type": "string" |
| 490 } |
| 491 }, |
| 492 "path": "v1beta1/{+beaconName}/diagnostics", |
| 493 "response": { |
| 494 "$ref": "ListDiagnosticsResponse" |
| 495 }, |
| 496 "scopes": [ |
| 497 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 498 ] |
| 499 } |
| 500 } |
| 501 }, |
448 "attachments": { | 502 "attachments": { |
449 "methods": { | 503 "methods": { |
450 "delete": { | 504 "delete": { |
451 "description": "Deletes the specified attachment for
the given beacon. Each attachment has\na unique attachment name (`attachmentNam
e`) which is returned when you\nfetch the attachment data via this API. You spec
ify this with the delete\nrequest to control which attachment is removed. This o
peration cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https:
//developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with *
*Is owner** or **Can edit** permissions in the\nGoogle Developers Console projec
t.", | 505 "description": "Deletes the specified attachment for
the given beacon. Each attachment has\na unique attachment name (`attachmentNam
e`) which is returned when you\nfetch the attachment data via this API. You spec
ify this with the delete\nrequest to control which attachment is removed. This o
peration cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https:
//developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with *
*Is owner** or **Can edit** permissions in the\nGoogle Developers Console projec
t.", |
452 "httpMethod": "DELETE", | 506 "httpMethod": "DELETE", |
453 "id": "proximitybeacon.beacons.attachments.delete", | 507 "id": "proximitybeacon.beacons.attachments.delete", |
454 "parameterOrder": [ | 508 "parameterOrder": [ |
455 "attachmentName" | 509 "attachmentName" |
456 ], | 510 ], |
457 "parameters": { | 511 "parameters": { |
(...skipping 19 matching lines...) Expand all Loading... |
477 ] | 531 ] |
478 }, | 532 }, |
479 "list": { | 533 "list": { |
480 "description": "Returns the attachments for the spec
ified beacon that match the specified\nnamespaced-type pattern.\n\nTo control wh
ich namespaced types are returned, you add the\n`namespacedType` query parameter
to the request. You must either use\n`*/*`, to return all attachments, or the n
amespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nA
uthenticate using an [OAuth access token](https://developers.google.com/identity
/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can
edit**\npermissions in the Google Developers Console project.", | 534 "description": "Returns the attachments for the spec
ified beacon that match the specified\nnamespaced-type pattern.\n\nTo control wh
ich namespaced types are returned, you add the\n`namespacedType` query parameter
to the request. You must either use\n`*/*`, to return all attachments, or the n
amespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nA
uthenticate using an [OAuth access token](https://developers.google.com/identity
/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can
edit**\npermissions in the Google Developers Console project.", |
481 "httpMethod": "GET", | 535 "httpMethod": "GET", |
482 "id": "proximitybeacon.beacons.attachments.list", | 536 "id": "proximitybeacon.beacons.attachments.list", |
483 "parameterOrder": [ | 537 "parameterOrder": [ |
484 "beaconName" | 538 "beaconName" |
485 ], | 539 ], |
486 "parameters": { | 540 "parameters": { |
487 "projectId": { | |
488 "description": "The project id to list beaco
n attachments under. This field can be\nused when \"*\" is specified to mean all
attachment namespaces. Projects\nmay have multiple attachments with multiple na
mespaces. If \"*\" is\nspecified and the projectId string is empty, then the pro
ject\nmaking the request is used.\nOptional.", | |
489 "location": "query", | |
490 "type": "string" | |
491 }, | |
492 "namespacedType": { | 541 "namespacedType": { |
493 "description": "Specifies the namespace and
type of attachment to include in response in\n<var>namespace/type</var> format.
Accepts `*/*` to specify\n\"all types in all namespaces\".", | 542 "description": "Specifies the namespace and
type of attachment to include in response in\n<var>namespace/type</var> format.
Accepts `*/*` to specify\n\"all types in all namespaces\".", |
494 "location": "query", | 543 "location": "query", |
495 "type": "string" | 544 "type": "string" |
496 }, | 545 }, |
497 "beaconName": { | 546 "beaconName": { |
498 "description": "Beacon whose attachments sho
uld be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the b
eaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon
's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1`
for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use eithe
r the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", | 547 "description": "Beacon whose attachments sho
uld be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the b
eaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon
's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1`
for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use eithe
r the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", |
499 "location": "path", | 548 "location": "path", |
500 "pattern": "^beacons/[^/]+$", | 549 "pattern": "^beacons/[^/]+$", |
501 "required": true, | 550 "required": true, |
502 "type": "string" | 551 "type": "string" |
| 552 }, |
| 553 "projectId": { |
| 554 "description": "The project id to list beaco
n attachments under. This field can be\nused when \"*\" is specified to mean all
attachment namespaces. Projects\nmay have multiple attachments with multiple na
mespaces. If \"*\" is\nspecified and the projectId string is empty, then the pro
ject\nmaking the request is used.\nOptional.", |
| 555 "location": "query", |
| 556 "type": "string" |
503 } | 557 } |
504 }, | 558 }, |
505 "path": "v1beta1/{+beaconName}/attachments", | 559 "path": "v1beta1/{+beaconName}/attachments", |
506 "response": { | 560 "response": { |
507 "$ref": "ListBeaconAttachmentsResponse" | 561 "$ref": "ListBeaconAttachmentsResponse" |
508 }, | 562 }, |
509 "scopes": [ | 563 "scopes": [ |
510 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | 564 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
511 ] | 565 ] |
512 }, | 566 }, |
(...skipping 30 matching lines...) Expand all Loading... |
543 ] | 597 ] |
544 }, | 598 }, |
545 "batchDelete": { | 599 "batchDelete": { |
546 "description": "Deletes multiple attachments on a gi
ven beacon. This operation is\npermanent and cannot be undone.\n\nYou can option
ally specify `namespacedType` to choose which attachments\nshould be deleted. If
you do not specify `namespacedType`, all your\nattachments on the given beacon
will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthe
nticate using an [OAuth access token](https://developers.google.com/identity/pro
tocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissi
ons in the\nGoogle Developers Console project.", | 600 "description": "Deletes multiple attachments on a gi
ven beacon. This operation is\npermanent and cannot be undone.\n\nYou can option
ally specify `namespacedType` to choose which attachments\nshould be deleted. If
you do not specify `namespacedType`, all your\nattachments on the given beacon
will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthe
nticate using an [OAuth access token](https://developers.google.com/identity/pro
tocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissi
ons in the\nGoogle Developers Console project.", |
547 "httpMethod": "POST", | 601 "httpMethod": "POST", |
548 "id": "proximitybeacon.beacons.attachments.batchDele
te", | 602 "id": "proximitybeacon.beacons.attachments.batchDele
te", |
549 "parameterOrder": [ | 603 "parameterOrder": [ |
550 "beaconName" | 604 "beaconName" |
551 ], | 605 ], |
552 "parameters": { | 606 "parameters": { |
| 607 "projectId": { |
| 608 "description": "The project id to delete bea
con attachments under. This field can be\nused when \"*\" is specified to mean a
ll attachment namespaces. Projects\nmay have multiple attachments with multiple
namespaces. If \"*\" is\nspecified and the projectId string is empty, then the p
roject\nmaking the request is used.\nOptional.", |
| 609 "location": "query", |
| 610 "type": "string" |
| 611 }, |
553 "namespacedType": { | 612 "namespacedType": { |
554 "description": "Specifies the namespace and
type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to spec
ify\n\"all types in all namespaces\".\nOptional.", | 613 "description": "Specifies the namespace and
type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to spec
ify\n\"all types in all namespaces\".\nOptional.", |
555 "location": "query", | 614 "location": "query", |
556 "type": "string" | 615 "type": "string" |
557 }, | 616 }, |
558 "beaconName": { | 617 "beaconName": { |
559 "description": "The beacon whose attachments
should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where t
he beaconId is the base16 ID broadcast\nby the beacon and N is a code for the be
acon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID,
`1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use e
ither the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", | 618 "description": "The beacon whose attachments
should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where t
he beaconId is the base16 ID broadcast\nby the beacon and N is a code for the be
acon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID,
`1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use e
ither the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", |
560 "location": "path", | 619 "location": "path", |
561 "pattern": "^beacons/[^/]+$", | 620 "pattern": "^beacons/[^/]+$", |
562 "required": true, | 621 "required": true, |
563 "type": "string" | 622 "type": "string" |
564 }, | |
565 "projectId": { | |
566 "description": "The project id to delete bea
con attachments under. This field can be\nused when \"*\" is specified to mean a
ll attachment namespaces. Projects\nmay have multiple attachments with multiple
namespaces. If \"*\" is\nspecified and the projectId string is empty, then the p
roject\nmaking the request is used.\nOptional.", | |
567 "location": "query", | |
568 "type": "string" | |
569 } | 623 } |
570 }, | 624 }, |
571 "path": "v1beta1/{+beaconName}/attachments:batchDele
te", | 625 "path": "v1beta1/{+beaconName}/attachments:batchDele
te", |
572 "response": { | 626 "response": { |
573 "$ref": "DeleteAttachmentsResponse" | 627 "$ref": "DeleteAttachmentsResponse" |
574 }, | 628 }, |
575 "scopes": [ | 629 "scopes": [ |
576 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | 630 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
577 ] | |
578 } | |
579 } | |
580 }, | |
581 "diagnostics": { | |
582 "methods": { | |
583 "list": { | |
584 "description": "List the diagnostics for a single be
acon. You can also list diagnostics for\nall the beacons owned by your Google De
velopers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate
using an [OAuth access token](https://developers.google.com/identity/protocols/O
Auth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\nper
missions in the Google Developers Console project.", | |
585 "httpMethod": "GET", | |
586 "id": "proximitybeacon.beacons.diagnostics.list", | |
587 "parameterOrder": [ | |
588 "beaconName" | |
589 ], | |
590 "parameters": { | |
591 "pageSize": { | |
592 "description": "Specifies the maximum number
of results to return. Defaults to\n10. Maximum 1000. Optional.", | |
593 "format": "int32", | |
594 "location": "query", | |
595 "type": "integer" | |
596 }, | |
597 "alertFilter": { | |
598 "description": "Requests only beacons that h
ave the given alert. For example, to find\nbeacons that have low batteries use `
alert_filter=LOW_BATTERY`.", | |
599 "enum": [ | |
600 "ALERT_UNSPECIFIED", | |
601 "WRONG_LOCATION", | |
602 "LOW_BATTERY" | |
603 ], | |
604 "location": "query", | |
605 "type": "string" | |
606 }, | |
607 "projectId": { | |
608 "description": "Requests only diagnostic rec
ords for the given project id. If not set,\nthen the project making the request
will be used for looking up\ndiagnostic records. Optional.", | |
609 "location": "query", | |
610 "type": "string" | |
611 }, | |
612 "beaconName": { | |
613 "description": "Beacon that the diagnostics
are for.", | |
614 "location": "path", | |
615 "pattern": "^beacons/[^/]+$", | |
616 "required": true, | |
617 "type": "string" | |
618 }, | |
619 "pageToken": { | |
620 "description": "Requests results that occur
after the `page_token`, obtained from the\nresponse to a previous request. Optio
nal.", | |
621 "location": "query", | |
622 "type": "string" | |
623 } | |
624 }, | |
625 "path": "v1beta1/{+beaconName}/diagnostics", | |
626 "response": { | |
627 "$ref": "ListDiagnosticsResponse" | |
628 }, | |
629 "scopes": [ | |
630 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | |
631 ] | 631 ] |
632 } | 632 } |
633 } | 633 } |
634 } | 634 } |
635 } | 635 } |
636 } | 636 } |
637 }, | 637 }, |
638 "revision": "20170320", | 638 "revision": "20170403", |
639 "rootUrl": "https://proximitybeacon.googleapis.com/", | 639 "rootUrl": "https://proximitybeacon.googleapis.com/", |
640 "schemas": { | 640 "schemas": { |
641 "Observation": { | |
642 "description": "Represents one beacon observed once.", | |
643 "id": "Observation", | |
644 "properties": { | |
645 "timestampMs": { | |
646 "description": "Time when the beacon was observed.", | |
647 "format": "google-datetime", | |
648 "type": "string" | |
649 }, | |
650 "advertisedId": { | |
651 "$ref": "AdvertisedId", | |
652 "description": "The ID advertised by the beacon the client h
as encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then
the client\nmust be authorized to resolve the given beacon. Otherwise no data wi
ll be\nreturned for that beacon.\nRequired." | |
653 }, | |
654 "telemetry": { | |
655 "description": "The array of telemetry bytes received from t
he beacon. The server is\nresponsible for parsing it. This field may frequently
be empty, as\nwith a beacon that transmits telemetry only occasionally.", | |
656 "format": "byte", | |
657 "type": "string" | |
658 } | |
659 }, | |
660 "type": "object" | |
661 }, | |
662 "ListDiagnosticsResponse": { | 641 "ListDiagnosticsResponse": { |
663 "description": "Response that contains the requested diagnostics.", | 642 "description": "Response that contains the requested diagnostics.", |
664 "id": "ListDiagnosticsResponse", | 643 "id": "ListDiagnosticsResponse", |
665 "properties": { | 644 "properties": { |
666 "diagnostics": { | 645 "diagnostics": { |
667 "description": "The diagnostics matching the given request."
, | 646 "description": "The diagnostics matching the given request."
, |
668 "items": { | 647 "items": { |
669 "$ref": "Diagnostics" | 648 "$ref": "Diagnostics" |
670 }, | 649 }, |
671 "type": "array" | 650 "type": "array" |
(...skipping 16 matching lines...) Expand all Loading... |
688 }, | 667 }, |
689 "type": "array" | 668 "type": "array" |
690 } | 669 } |
691 }, | 670 }, |
692 "type": "object" | 671 "type": "object" |
693 }, | 672 }, |
694 "Beacon": { | 673 "Beacon": { |
695 "description": "Details of a beacon device.", | 674 "description": "Details of a beacon device.", |
696 "id": "Beacon", | 675 "id": "Beacon", |
697 "properties": { | 676 "properties": { |
| 677 "indoorLevel": { |
| 678 "$ref": "IndoorLevel", |
| 679 "description": "The indoor level information for this beacon
, if known. As returned by the\nGoogle Maps API.\nOptional." |
| 680 }, |
| 681 "status": { |
| 682 "description": "Current status of the beacon.\nRequired.", |
| 683 "enum": [ |
| 684 "STATUS_UNSPECIFIED", |
| 685 "ACTIVE", |
| 686 "DECOMMISSIONED", |
| 687 "INACTIVE" |
| 688 ], |
| 689 "enumDescriptions": [ |
| 690 "Do not use this value.", |
| 691 "The \"normal\" in-use state of a beacon.", |
| 692 "Beacon should no longer be used for any purpose. This i
s irreversible.", |
| 693 "The beacon should not be visible to mobile devices. Thi
s is reversible." |
| 694 ], |
| 695 "type": "string" |
| 696 }, |
698 "beaconName": { | 697 "beaconName": { |
699 "description": "Resource name of this beacon. A beacon name
has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broad
cast by\nthe beacon and N is a code for the beacon's type. Possible values are\n
`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be
left empty when registering. After reading a beacon,\nclients can use the name f
or future operations.", | 698 "description": "Resource name of this beacon. A beacon name
has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broad
cast by\nthe beacon and N is a code for the beacon's type. Possible values are\n
`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be
left empty when registering. After reading a beacon,\nclients can use the name f
or future operations.", |
700 "type": "string" | 699 "type": "string" |
701 }, | 700 }, |
702 "expectedStability": { | 701 "expectedStability": { |
703 "description": "Expected location stability. This is set whe
n the beacon is registered or\nupdated, not automatically detected in any way.\n
Optional.", | 702 "description": "Expected location stability. This is set whe
n the beacon is registered or\nupdated, not automatically detected in any way.\n
Optional.", |
704 "enum": [ | 703 "enum": [ |
705 "STABILITY_UNSPECIFIED", | 704 "STABILITY_UNSPECIFIED", |
706 "STABLE", | 705 "STABLE", |
707 "PORTABLE", | 706 "PORTABLE", |
(...skipping 15 matching lines...) Expand all Loading... |
723 }, | 722 }, |
724 "provisioningKey": { | 723 "provisioningKey": { |
725 "description": "Some beacons may require a user to provide a
n authorization key before\nchanging any of its configuration (e.g. broadcast fr
ames, transmit power).\nThis field provides a place to store and control access
to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!be
aconId`\nfrom users with write access to the given beacon. That is to say: If th
e\nuser is authorized to write the beacon's confidential data in the service,\nt
he service considers them authorized to configure the beacon. Note\nthat this ke
y grants nothing on the service, only on the beacon itself.", | 724 "description": "Some beacons may require a user to provide a
n authorization key before\nchanging any of its configuration (e.g. broadcast fr
ames, transmit power).\nThis field provides a place to store and control access
to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!be
aconId`\nfrom users with write access to the given beacon. That is to say: If th
e\nuser is authorized to write the beacon's confidential data in the service,\nt
he service considers them authorized to configure the beacon. Note\nthat this ke
y grants nothing on the service, only on the beacon itself.", |
726 "format": "byte", | 725 "format": "byte", |
727 "type": "string" | 726 "type": "string" |
728 }, | 727 }, |
729 "ephemeralIdRegistration": { | 728 "ephemeralIdRegistration": { |
730 "$ref": "EphemeralIdRegistration", | 729 "$ref": "EphemeralIdRegistration", |
731 "description": "Write-only registration parameters for beaco
ns using Eddystone-EID\n(remotely resolved ephemeral ID) format. This informatio
n will not be\npopulated in API responses. When submitting this data, the `adver
tised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type wil
l\nresult in an error." | 730 "description": "Write-only registration parameters for beaco
ns using Eddystone-EID\n(remotely resolved ephemeral ID) format. This informatio
n will not be\npopulated in API responses. When submitting this data, the `adver
tised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type wil
l\nresult in an error." |
732 }, | 731 }, |
| 732 "description": { |
| 733 "description": "Free text used to identify and describe the
beacon. Maximum length 140\ncharacters.\nOptional.", |
| 734 "type": "string" |
| 735 }, |
| 736 "placeId": { |
| 737 "description": "The [Google Places API](/places/place-id) Pl
ace ID of the place where\nthe beacon is deployed. This is given when the beacon
is registered or\nupdated, not automatically detected in any way.\nOptional.", |
| 738 "type": "string" |
| 739 }, |
733 "latLng": { | 740 "latLng": { |
734 "$ref": "LatLng", | 741 "$ref": "LatLng", |
735 "description": "The location of the beacon, expressed as a l
atitude and longitude pair.\nThis location is given when the beacon is registere
d or updated. It does\nnot necessarily indicate the actual current location of t
he beacon.\nOptional." | 742 "description": "The location of the beacon, expressed as a l
atitude and longitude pair.\nThis location is given when the beacon is registere
d or updated. It does\nnot necessarily indicate the actual current location of t
he beacon.\nOptional." |
736 }, | 743 }, |
737 "placeId": { | |
738 "description": "The [Google Places API](/places/place-id) Pl
ace ID of the place where\nthe beacon is deployed. This is given when the beacon
is registered or\nupdated, not automatically detected in any way.\nOptional.", | |
739 "type": "string" | |
740 }, | |
741 "description": { | |
742 "description": "Free text used to identify and describe the
beacon. Maximum length 140\ncharacters.\nOptional.", | |
743 "type": "string" | |
744 }, | |
745 "properties": { | 744 "properties": { |
746 "additionalProperties": { | 745 "additionalProperties": { |
747 "type": "string" | 746 "type": "string" |
748 }, | 747 }, |
749 "description": "Properties of the beacon device, for example
battery type or firmware\nversion.\nOptional.", | 748 "description": "Properties of the beacon device, for example
battery type or firmware\nversion.\nOptional.", |
750 "type": "object" | 749 "type": "object" |
751 }, | |
752 "status": { | |
753 "description": "Current status of the beacon.\nRequired.", | |
754 "enum": [ | |
755 "STATUS_UNSPECIFIED", | |
756 "ACTIVE", | |
757 "DECOMMISSIONED", | |
758 "INACTIVE" | |
759 ], | |
760 "enumDescriptions": [ | |
761 "Do not use this value.", | |
762 "The \"normal\" in-use state of a beacon.", | |
763 "Beacon should no longer be used for any purpose. This i
s irreversible.", | |
764 "The beacon should not be visible to mobile devices. Thi
s is reversible." | |
765 ], | |
766 "type": "string" | |
767 }, | |
768 "indoorLevel": { | |
769 "$ref": "IndoorLevel", | |
770 "description": "The indoor level information for this beacon
, if known. As returned by the\nGoogle Maps API.\nOptional." | |
771 } | 750 } |
772 }, | 751 }, |
773 "type": "object" | 752 "type": "object" |
774 }, | 753 }, |
775 "AdvertisedId": { | 754 "AdvertisedId": { |
776 "description": "Defines a unique identifier of a beacon as broadcast
by the device.", | 755 "description": "Defines a unique identifier of a beacon as broadcast
by the device.", |
777 "id": "AdvertisedId", | 756 "id": "AdvertisedId", |
778 "properties": { | 757 "properties": { |
779 "id": { | 758 "id": { |
780 "description": "The actual beacon identifier, as broadcast b
y the beacon hardware. Must be\n[base64](http://tools.ietf.org/html/rfc4648#sect
ion-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in respo
nses. The base64\nencoding should be of the binary byte-stream and not any textu
al (such as\nhex) representation thereof.\nRequired.", | 759 "description": "The actual beacon identifier, as broadcast b
y the beacon hardware. Must be\n[base64](http://tools.ietf.org/html/rfc4648#sect
ion-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in respo
nses. The base64\nencoding should be of the binary byte-stream and not any textu
al (such as\nhex) representation thereof.\nRequired.", |
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
842 "namespaces": { | 821 "namespaces": { |
843 "description": "The attachments that corresponded to the req
uest params.", | 822 "description": "The attachments that corresponded to the req
uest params.", |
844 "items": { | 823 "items": { |
845 "$ref": "Namespace" | 824 "$ref": "Namespace" |
846 }, | 825 }, |
847 "type": "array" | 826 "type": "array" |
848 } | 827 } |
849 }, | 828 }, |
850 "type": "object" | 829 "type": "object" |
851 }, | 830 }, |
852 "ListBeaconsResponse": { | |
853 "description": "Response that contains list beacon results and pagin
ation help.", | |
854 "id": "ListBeaconsResponse", | |
855 "properties": { | |
856 "nextPageToken": { | |
857 "description": "An opaque pagination token that the client m
ay provide in their next\nrequest to retrieve the next page of results.", | |
858 "type": "string" | |
859 }, | |
860 "beacons": { | |
861 "description": "The beacons that matched the search criteria
.", | |
862 "items": { | |
863 "$ref": "Beacon" | |
864 }, | |
865 "type": "array" | |
866 }, | |
867 "totalCount": { | |
868 "description": "Estimate of the total number of beacons matc
hed by the query. Higher\nvalues may be less accurate.", | |
869 "format": "int64", | |
870 "type": "string" | |
871 } | |
872 }, | |
873 "type": "object" | |
874 }, | |
875 "Diagnostics": { | 831 "Diagnostics": { |
876 "description": "Diagnostics for a single beacon.", | 832 "description": "Diagnostics for a single beacon.", |
877 "id": "Diagnostics", | 833 "id": "Diagnostics", |
878 "properties": { | 834 "properties": { |
879 "beaconName": { | 835 "beaconName": { |
880 "description": "Resource name of the beacon. For Eddystone-E
ID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Ed
dystone-UID.", | 836 "description": "Resource name of the beacon. For Eddystone-E
ID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Ed
dystone-UID.", |
881 "type": "string" | 837 "type": "string" |
882 }, | 838 }, |
883 "alerts": { | 839 "alerts": { |
884 "description": "An unordered list of Alerts that the beacon
has.", | 840 "description": "An unordered list of Alerts that the beacon
has.", |
(...skipping 12 matching lines...) Expand all Loading... |
897 }, | 853 }, |
898 "type": "array" | 854 "type": "array" |
899 }, | 855 }, |
900 "estimatedLowBatteryDate": { | 856 "estimatedLowBatteryDate": { |
901 "$ref": "Date", | 857 "$ref": "Date", |
902 "description": "The date when the battery is expected to be
low. If the value is missing\nthen there is no estimate for when the battery wil
l be low.\nThis value is only an estimate, not an exact date." | 858 "description": "The date when the battery is expected to be
low. If the value is missing\nthen there is no estimate for when the battery wil
l be low.\nThis value is only an estimate, not an exact date." |
903 } | 859 } |
904 }, | 860 }, |
905 "type": "object" | 861 "type": "object" |
906 }, | 862 }, |
| 863 "ListBeaconsResponse": { |
| 864 "description": "Response that contains list beacon results and pagin
ation help.", |
| 865 "id": "ListBeaconsResponse", |
| 866 "properties": { |
| 867 "beacons": { |
| 868 "description": "The beacons that matched the search criteria
.", |
| 869 "items": { |
| 870 "$ref": "Beacon" |
| 871 }, |
| 872 "type": "array" |
| 873 }, |
| 874 "totalCount": { |
| 875 "description": "Estimate of the total number of beacons matc
hed by the query. Higher\nvalues may be less accurate.", |
| 876 "format": "int64", |
| 877 "type": "string" |
| 878 }, |
| 879 "nextPageToken": { |
| 880 "description": "An opaque pagination token that the client m
ay provide in their next\nrequest to retrieve the next page of results.", |
| 881 "type": "string" |
| 882 } |
| 883 }, |
| 884 "type": "object" |
| 885 }, |
907 "GetInfoForObservedBeaconsRequest": { | 886 "GetInfoForObservedBeaconsRequest": { |
908 "description": "Request for beacon and attachment information about
beacons that\na mobile client has encountered \"in the wild\".", | 887 "description": "Request for beacon and attachment information about
beacons that\na mobile client has encountered \"in the wild\".", |
909 "id": "GetInfoForObservedBeaconsRequest", | 888 "id": "GetInfoForObservedBeaconsRequest", |
910 "properties": { | 889 "properties": { |
911 "observations": { | 890 "observations": { |
912 "description": "The beacons that the client has encountered.
\nAt least one must be given.", | 891 "description": "The beacons that the client has encountered.
\nAt least one must be given.", |
913 "items": { | 892 "items": { |
914 "$ref": "Observation" | 893 "$ref": "Observation" |
915 }, | 894 }, |
916 "type": "array" | 895 "type": "array" |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
953 "description": "Resource name of this attachment. Attachment
names have the format:\n<code>beacons/<var>beacon_id</var>/attachments/<var>att
achment_id</var></code>.\nLeave this empty on creation.", | 932 "description": "Resource name of this attachment. Attachment
names have the format:\n<code>beacons/<var>beacon_id</var>/attachments/<var>att
achment_id</var></code>.\nLeave this empty on creation.", |
954 "type": "string" | 933 "type": "string" |
955 } | 934 } |
956 }, | 935 }, |
957 "type": "object" | 936 "type": "object" |
958 }, | 937 }, |
959 "EphemeralIdRegistration": { | 938 "EphemeralIdRegistration": { |
960 "description": "Write-only registration parameters for beacons using
Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon
with the service\nare supported:\n\n1. Perform an ECDH key exchange via this AP
I, including a previous call\n to `GET /v1beta1/eidparams`. In this case the f
ields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n p
opulated and `beacon_identity_key` should not be populated. This\n method ensu
res that only the two parties in the ECDH key exchange can\n compute the ident
ity key, which becomes a secret between them.\n2. Derive or obtain the beacon's
identity key via other secure means\n (perhaps an ECDH key exchange between th
e beacon and a mobile device\n or any other secure method), and then submit th
e resulting identity key\n to the service. In this case `beacon_identity_key`
field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `
service_ecdh_public_key` fields should be. The security of this method\n depen
ds on how securely the parties involved (in particular the\n bluetooth client)
handle the identity key, and obviously on how\n securely the identity key was
generated.\n\nSee [the Eddystone specification](https://github.com/google/eddys
tone/tree/master/eddystone-eid) at GitHub.", | 939 "description": "Write-only registration parameters for beacons using
Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon
with the service\nare supported:\n\n1. Perform an ECDH key exchange via this AP
I, including a previous call\n to `GET /v1beta1/eidparams`. In this case the f
ields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n p
opulated and `beacon_identity_key` should not be populated. This\n method ensu
res that only the two parties in the ECDH key exchange can\n compute the ident
ity key, which becomes a secret between them.\n2. Derive or obtain the beacon's
identity key via other secure means\n (perhaps an ECDH key exchange between th
e beacon and a mobile device\n or any other secure method), and then submit th
e resulting identity key\n to the service. In this case `beacon_identity_key`
field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `
service_ecdh_public_key` fields should be. The security of this method\n depen
ds on how securely the parties involved (in particular the\n bluetooth client)
handle the identity key, and obviously on how\n securely the identity key was
generated.\n\nSee [the Eddystone specification](https://github.com/google/eddys
tone/tree/master/eddystone-eid) at GitHub.", |
961 "id": "EphemeralIdRegistration", | 940 "id": "EphemeralIdRegistration", |
962 "properties": { | 941 "properties": { |
| 942 "beaconEcdhPublicKey": { |
| 943 "description": "The beacon's public key used for the Ellipti
c curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecd
h_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", |
| 944 "format": "byte", |
| 945 "type": "string" |
| 946 }, |
| 947 "initialClockValue": { |
| 948 "description": "The initial clock value of the beacon. The b
eacon's clock must have\nbegun counting at this value immediately prior to trans
mitting this\nvalue to the resolving service. Significant delay in transmitting
this\nvalue to the service risks registration or resolution failures. If a\nvalu
e is not provided, the default is zero.", |
| 949 "format": "uint64", |
| 950 "type": "string" |
| 951 }, |
| 952 "rotationPeriodExponent": { |
| 953 "description": "Indicates the nominal period between each ro
tation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should rand
omize the\nactual interval. See [the spec at github](https://github.com/google/e
ddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a po
wer-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon
will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.", |
| 954 "format": "uint32", |
| 955 "type": "integer" |
| 956 }, |
963 "serviceEcdhPublicKey": { | 957 "serviceEcdhPublicKey": { |
964 "description": "The service's public key used for the Ellipt
ic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecd
h_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", | 958 "description": "The service's public key used for the Ellipt
ic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecd
h_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", |
965 "format": "byte", | 959 "format": "byte", |
966 "type": "string" | 960 "type": "string" |
967 }, | 961 }, |
968 "beaconIdentityKey": { | 962 "beaconIdentityKey": { |
969 "description": "The private key of the beacon. If this field
is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not
be\npopulated.", | 963 "description": "The private key of the beacon. If this field
is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not
be\npopulated.", |
970 "format": "byte", | 964 "format": "byte", |
971 "type": "string" | 965 "type": "string" |
972 }, | 966 }, |
973 "initialEid": { | 967 "initialEid": { |
974 "description": "An initial ephemeral ID calculated using the
clock value submitted as\n`initial_clock_value`, and the secret key generated b
y the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service
_ecdh_public_key`. This initial EID value will be used by the\nservice to confir
m that the key exchange process was successful.", | 968 "description": "An initial ephemeral ID calculated using the
clock value submitted as\n`initial_clock_value`, and the secret key generated b
y the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service
_ecdh_public_key`. This initial EID value will be used by the\nservice to confir
m that the key exchange process was successful.", |
975 "format": "byte", | 969 "format": "byte", |
976 "type": "string" | 970 "type": "string" |
977 }, | |
978 "initialClockValue": { | |
979 "description": "The initial clock value of the beacon. The b
eacon's clock must have\nbegun counting at this value immediately prior to trans
mitting this\nvalue to the resolving service. Significant delay in transmitting
this\nvalue to the service risks registration or resolution failures. If a\nvalu
e is not provided, the default is zero.", | |
980 "format": "uint64", | |
981 "type": "string" | |
982 }, | |
983 "beaconEcdhPublicKey": { | |
984 "description": "The beacon's public key used for the Ellipti
c curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecd
h_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", | |
985 "format": "byte", | |
986 "type": "string" | |
987 }, | |
988 "rotationPeriodExponent": { | |
989 "description": "Indicates the nominal period between each ro
tation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should rand
omize the\nactual interval. See [the spec at github](https://github.com/google/e
ddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a po
wer-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon
will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.", | |
990 "format": "uint32", | |
991 "type": "integer" | |
992 } | 971 } |
993 }, | 972 }, |
994 "type": "object" | 973 "type": "object" |
995 }, | 974 }, |
996 "LatLng": { | 975 "LatLng": { |
997 "description": "An object representing a latitude/longitude pair. Th
is is expressed as a pair\nof doubles representing degrees latitude and degrees
longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http
://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values
must be within normalized ranges.\n\nExample of normalization code in Python:\n
\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees long
itude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if
r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n retur
n r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal
degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], resp
ectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return
r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 36
0, NormalizeLongitude(longitude)\n else:\n return 180 - r, Normalize
Longitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n
assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLo
ngitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert
(0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == Normali
zeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\
n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.
0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng
(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n as
sert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == N
ormalizeLatLng(-270.0, 10.0)\n\nThe code in logs/storage/validator/logs_validato
r_traits.cc treats this type\nas if it were annotated as ST_LOCATION.", | 976 "description": "An object representing a latitude/longitude pair. Th
is is expressed as a pair\nof doubles representing degrees latitude and degrees
longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http
://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values
must be within normalized ranges.\n\nExample of normalization code in Python:\n
\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees long
itude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if
r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n retur
n r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal
degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], resp
ectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return
r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 36
0, NormalizeLongitude(longitude)\n else:\n return 180 - r, Normalize
Longitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n
assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLo
ngitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert
(0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == Normali
zeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\
n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.
0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng
(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n as
sert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == N
ormalizeLatLng(-270.0, 10.0)\n\nThe code in logs/storage/validator/logs_validato
r_traits.cc treats this type\nas if it were annotated as ST_LOCATION.", |
998 "id": "LatLng", | 977 "id": "LatLng", |
999 "properties": { | 978 "properties": { |
1000 "latitude": { | 979 "latitude": { |
1001 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", | 980 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", |
(...skipping 19 matching lines...) Expand all Loading... |
1021 }, | 1000 }, |
1022 "type": "array" | 1001 "type": "array" |
1023 } | 1002 } |
1024 }, | 1003 }, |
1025 "type": "object" | 1004 "type": "object" |
1026 }, | 1005 }, |
1027 "Namespace": { | 1006 "Namespace": { |
1028 "description": "An attachment namespace defines read and write acces
s for all the attachments\ncreated under it. Each namespace is globally unique,
and owned by one\nproject which is the only project that can create attachments
under it.", | 1007 "description": "An attachment namespace defines read and write acces
s for all the attachments\ncreated under it. Each namespace is globally unique,
and owned by one\nproject which is the only project that can create attachments
under it.", |
1029 "id": "Namespace", | 1008 "id": "Namespace", |
1030 "properties": { | 1009 "properties": { |
| 1010 "namespaceName": { |
| 1011 "description": "Resource name of this namespace. Namespaces
names have the format:\n<code>namespaces/<var>namespace</var></code>.", |
| 1012 "type": "string" |
| 1013 }, |
1031 "servingVisibility": { | 1014 "servingVisibility": { |
1032 "description": "Specifies what clients may receive attachmen
ts under this namespace\nvia `beaconinfo.getforobserved`.", | 1015 "description": "Specifies what clients may receive attachmen
ts under this namespace\nvia `beaconinfo.getforobserved`.", |
1033 "enum": [ | 1016 "enum": [ |
1034 "VISIBILITY_UNSPECIFIED", | 1017 "VISIBILITY_UNSPECIFIED", |
1035 "UNLISTED", | 1018 "UNLISTED", |
1036 "PUBLIC" | 1019 "PUBLIC" |
1037 ], | 1020 ], |
1038 "enumDescriptions": [ | 1021 "enumDescriptions": [ |
1039 "Do not use this value.", | 1022 "Do not use this value.", |
1040 "Served only to the project that owns the namespace.", | 1023 "Served only to the project that owns the namespace.", |
1041 "Any project can subscribe to attachments under the name
space." | 1024 "Any project can subscribe to attachments under the name
space." |
1042 ], | 1025 ], |
1043 "type": "string" | 1026 "type": "string" |
| 1027 } |
| 1028 }, |
| 1029 "type": "object" |
| 1030 }, |
| 1031 "AttachmentInfo": { |
| 1032 "description": "A subset of attachment information served via the\n`
beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.
", |
| 1033 "id": "AttachmentInfo", |
| 1034 "properties": { |
| 1035 "namespacedType": { |
| 1036 "description": "Specifies what kind of attachment this is. T
ells a client how to\ninterpret the `data` field. Format is <var>namespace/type<
/var>, for\nexample <code>scrupulous-wombat-12345/welcome-message</code>", |
| 1037 "type": "string" |
1044 }, | 1038 }, |
1045 "namespaceName": { | 1039 "data": { |
1046 "description": "Resource name of this namespace. Namespaces
names have the format:\n<code>namespaces/<var>namespace</var></code>.", | 1040 "description": "An opaque data container for client-provided
data.", |
| 1041 "format": "byte", |
1047 "type": "string" | 1042 "type": "string" |
1048 } | 1043 } |
1049 }, | 1044 }, |
1050 "type": "object" | 1045 "type": "object" |
1051 }, | 1046 }, |
1052 "BeaconInfo": { | 1047 "BeaconInfo": { |
1053 "description": "A subset of beacon information served via the `beaco
ninfo.getforobserved`\nmethod, which you call when users of your app encounter y
our beacons.", | 1048 "description": "A subset of beacon information served via the `beaco
ninfo.getforobserved`\nmethod, which you call when users of your app encounter y
our beacons.", |
1054 "id": "BeaconInfo", | 1049 "id": "BeaconInfo", |
1055 "properties": { | 1050 "properties": { |
1056 "beaconName": { | |
1057 "description": "The name under which the beacon is registere
d.", | |
1058 "type": "string" | |
1059 }, | |
1060 "advertisedId": { | 1051 "advertisedId": { |
1061 "$ref": "AdvertisedId", | 1052 "$ref": "AdvertisedId", |
1062 "description": "The ID advertised by the beacon." | 1053 "description": "The ID advertised by the beacon." |
1063 }, | 1054 }, |
1064 "attachments": { | 1055 "attachments": { |
1065 "description": "Attachments matching the type(s) requested.\
nMay be empty if no attachment types were requested.", | 1056 "description": "Attachments matching the type(s) requested.\
nMay be empty if no attachment types were requested.", |
1066 "items": { | 1057 "items": { |
1067 "$ref": "AttachmentInfo" | 1058 "$ref": "AttachmentInfo" |
1068 }, | 1059 }, |
1069 "type": "array" | 1060 "type": "array" |
1070 } | |
1071 }, | |
1072 "type": "object" | |
1073 }, | |
1074 "AttachmentInfo": { | |
1075 "description": "A subset of attachment information served via the\n`
beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.
", | |
1076 "id": "AttachmentInfo", | |
1077 "properties": { | |
1078 "data": { | |
1079 "description": "An opaque data container for client-provided
data.", | |
1080 "format": "byte", | |
1081 "type": "string" | |
1082 }, | 1061 }, |
1083 "namespacedType": { | 1062 "beaconName": { |
1084 "description": "Specifies what kind of attachment this is. T
ells a client how to\ninterpret the `data` field. Format is <var>namespace/type<
/var>, for\nexample <code>scrupulous-wombat-12345/welcome-message</code>", | 1063 "description": "The name under which the beacon is registere
d.", |
1085 "type": "string" | 1064 "type": "string" |
1086 } | 1065 } |
1087 }, | 1066 }, |
1088 "type": "object" | 1067 "type": "object" |
1089 }, | 1068 }, |
1090 "DeleteAttachmentsResponse": { | 1069 "DeleteAttachmentsResponse": { |
1091 "description": "Response for a request to delete attachments.", | 1070 "description": "Response for a request to delete attachments.", |
1092 "id": "DeleteAttachmentsResponse", | 1071 "id": "DeleteAttachmentsResponse", |
1093 "properties": { | 1072 "properties": { |
1094 "numDeleted": { | 1073 "numDeleted": { |
(...skipping 18 matching lines...) Expand all Loading... |
1113 "format": "uint32", | 1092 "format": "uint32", |
1114 "type": "integer" | 1093 "type": "integer" |
1115 }, | 1094 }, |
1116 "serviceEcdhPublicKey": { | 1095 "serviceEcdhPublicKey": { |
1117 "description": "The beacon service's public key for use by a
beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exch
ange.", | 1096 "description": "The beacon service's public key for use by a
beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exch
ange.", |
1118 "format": "byte", | 1097 "format": "byte", |
1119 "type": "string" | 1098 "type": "string" |
1120 } | 1099 } |
1121 }, | 1100 }, |
1122 "type": "object" | 1101 "type": "object" |
| 1102 }, |
| 1103 "Observation": { |
| 1104 "description": "Represents one beacon observed once.", |
| 1105 "id": "Observation", |
| 1106 "properties": { |
| 1107 "advertisedId": { |
| 1108 "$ref": "AdvertisedId", |
| 1109 "description": "The ID advertised by the beacon the client h
as encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then
the client\nmust be authorized to resolve the given beacon. Otherwise no data wi
ll be\nreturned for that beacon.\nRequired." |
| 1110 }, |
| 1111 "telemetry": { |
| 1112 "description": "The array of telemetry bytes received from t
he beacon. The server is\nresponsible for parsing it. This field may frequently
be empty, as\nwith a beacon that transmits telemetry only occasionally.", |
| 1113 "format": "byte", |
| 1114 "type": "string" |
| 1115 }, |
| 1116 "timestampMs": { |
| 1117 "description": "Time when the beacon was observed.", |
| 1118 "format": "google-datetime", |
| 1119 "type": "string" |
| 1120 } |
| 1121 }, |
| 1122 "type": "object" |
1123 } | 1123 } |
1124 }, | 1124 }, |
1125 "servicePath": "", | 1125 "servicePath": "", |
1126 "title": "Google Proximity Beacon API", | 1126 "title": "Google Proximity Beacon API", |
1127 "version": "v1beta1" | 1127 "version": "v1beta1" |
1128 } | 1128 } |
OLD | NEW |