Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(223)

Side by Side Diff: discovery/googleapis_beta/proximitybeacon__v1beta1.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
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 "access_token": {
28 "description": "OAuth access token.",
29 "location": "query",
30 "type": "string"
31 },
32 "key": {
33 "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.",
34 "location": "query",
35 "type": "string"
36 },
37 "quotaUser": {
38 "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.",
39 "location": "query",
40 "type": "string"
41 },
42 "pp": {
43 "default": "true",
44 "description": "Pretty-print response.",
45 "location": "query",
46 "type": "boolean"
47 },
48 "bearer_token": { 27 "bearer_token": {
49 "description": "OAuth bearer token.", 28 "description": "OAuth bearer token.",
50 "location": "query", 29 "location": "query",
51 "type": "string" 30 "type": "string"
52 }, 31 },
53 "oauth_token": { 32 "oauth_token": {
54 "description": "OAuth 2.0 token for the current user.", 33 "description": "OAuth 2.0 token for the current user.",
55 "location": "query", 34 "location": "query",
56 "type": "string" 35 "type": "string"
57 }, 36 },
58 "upload_protocol": { 37 "upload_protocol": {
59 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
60 "location": "query", 39 "location": "query",
61 "type": "string" 40 "type": "string"
62 }, 41 },
63 "prettyPrint": { 42 "prettyPrint": {
64 "default": "true", 43 "default": "true",
65 "description": "Returns response with indentations and line breaks." , 44 "description": "Returns response with indentations and line breaks." ,
66 "location": "query", 45 "location": "query",
67 "type": "boolean" 46 "type": "boolean"
68 }, 47 },
48 "fields": {
49 "description": "Selector specifying which fields to include in a par tial response.",
50 "location": "query",
51 "type": "string"
52 },
69 "uploadType": { 53 "uploadType": {
70 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 54 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
71 "location": "query", 55 "location": "query",
72 "type": "string" 56 "type": "string"
73 }, 57 },
74 "fields": {
75 "description": "Selector specifying which fields to include in a par tial response.",
76 "location": "query",
77 "type": "string"
78 },
79 "$.xgafv": { 58 "$.xgafv": {
80 "description": "V1 error format.", 59 "description": "V1 error format.",
81 "enum": [ 60 "enum": [
82 "1", 61 "1",
83 "2" 62 "2"
84 ], 63 ],
85 "enumDescriptions": [ 64 "enumDescriptions": [
86 "v1 error format", 65 "v1 error format",
87 "v2 error format" 66 "v2 error format"
88 ], 67 ],
(...skipping 13 matching lines...) Expand all
102 "media", 81 "media",
103 "proto" 82 "proto"
104 ], 83 ],
105 "enumDescriptions": [ 84 "enumDescriptions": [
106 "Responses with Content-Type of application/json", 85 "Responses with Content-Type of application/json",
107 "Media download with context-dependent Content-Type", 86 "Media download with context-dependent Content-Type",
108 "Responses with Content-Type of application/x-protobuf" 87 "Responses with Content-Type of application/x-protobuf"
109 ], 88 ],
110 "location": "query", 89 "location": "query",
111 "type": "string" 90 "type": "string"
91 },
92 "key": {
93 "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.",
94 "location": "query",
95 "type": "string"
96 },
97 "access_token": {
98 "description": "OAuth access token.",
99 "location": "query",
100 "type": "string"
101 },
102 "quotaUser": {
103 "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.",
104 "location": "query",
105 "type": "string"
106 },
107 "pp": {
108 "default": "true",
109 "description": "Pretty-print response.",
110 "location": "query",
111 "type": "boolean"
112 } 112 }
113 }, 113 },
114 "protocol": "rest", 114 "protocol": "rest",
115 "resources": { 115 "resources": {
116 "beaconinfo": {
117 "methods": {
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/get -started#request_a_browser_api_key)\nfor the application.",
120 "httpMethod": "POST",
121 "id": "proximitybeacon.beaconinfo.getforobserved",
122 "parameterOrder": [],
123 "parameters": {},
124 "path": "v1beta1/beaconinfo:getforobserved",
125 "request": {
126 "$ref": "GetInfoForObservedBeaconsRequest"
127 },
128 "response": {
129 "$ref": "GetInfoForObservedBeaconsResponse"
130 }
131 }
132 }
133 },
134 "namespaces": {
135 "methods": {
136 "update": {
137 "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
138 "httpMethod": "PUT",
139 "id": "proximitybeacon.namespaces.update",
140 "parameterOrder": [
141 "namespaceName"
142 ],
143 "parameters": {
144 "namespaceName": {
145 "description": "Resource name of this namespace. Nam espaces names have the format:\n<code>namespaces/<var>namespace</var></code>.",
146 "location": "path",
147 "pattern": "^namespaces/[^/]+$",
148 "required": true,
149 "type": "string"
150 },
151 "projectId": {
152 "description": "The project id of the namespace to u pdate. If the project id is not\nspecified then the project making the request i s used. The project id\nmust match the project that owns the beacon.\nOptional." ,
153 "location": "query",
154 "type": "string"
155 }
156 },
157 "path": "v1beta1/{+namespaceName}",
158 "request": {
159 "$ref": "Namespace"
160 },
161 "response": {
162 "$ref": "Namespace"
163 },
164 "scopes": [
165 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
166 ]
167 },
168 "list": {
169 "description": "Lists all attachment namespaces owned by you r Google Developers Console\nproject. Attachment data associated with a beacon m ust include a\nnamespaced type, and the namespace must be owned by your project. \n\nAuthenticate using an [OAuth access token](https://developers.google.com/ide ntity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
170 "httpMethod": "GET",
171 "id": "proximitybeacon.namespaces.list",
172 "parameterOrder": [],
173 "parameters": {
174 "projectId": {
175 "description": "The project id to list namespaces un der.\nOptional.",
176 "location": "query",
177 "type": "string"
178 }
179 },
180 "path": "v1beta1/namespaces",
181 "response": {
182 "$ref": "ListNamespacesResponse"
183 },
184 "scopes": [
185 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
186 ]
187 }
188 }
189 },
190 "v1beta1": { 116 "v1beta1": {
191 "methods": { 117 "methods": {
192 "getEidparams": { 118 "getEidparams": {
193 "description": "Gets the Proximity Beacon API's current publ ic key and associated\nparameters used to initiate the Diffie-Hellman key exchan ge required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\ nto provision and register multiple beacons. However, clients should be\nprepare d to refresh this key when they encounter an error registering an\nEddystone-EID beacon.", 119 "description": "Gets the Proximity Beacon API's current publ ic key and associated\nparameters used to initiate the Diffie-Hellman key exchan ge required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\ nto provision and register multiple beacons. However, clients should be\nprepare d to refresh this key when they encounter an error registering an\nEddystone-EID beacon.",
194 "httpMethod": "GET", 120 "httpMethod": "GET",
195 "id": "proximitybeacon.getEidparams", 121 "id": "proximitybeacon.getEidparams",
196 "parameterOrder": [], 122 "parameterOrder": [],
197 "parameters": {}, 123 "parameters": {},
198 "path": "v1beta1/eidparams", 124 "path": "v1beta1/eidparams",
199 "response": { 125 "response": {
200 "$ref": "EphemeralIdRegistrationParams" 126 "$ref": "EphemeralIdRegistrationParams"
201 }, 127 },
202 "scopes": [ 128 "scopes": [
203 "https://www.googleapis.com/auth/userlocation.beacon.reg istry" 129 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
204 ] 130 ]
205 } 131 }
206 } 132 }
207 }, 133 },
208 "beacons": { 134 "beacons": {
209 "methods": { 135 "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 "projectId": {
219 "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.",
220 "location": "query",
221 "type": "string"
222 },
223 "beaconName": {
224 "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.",
225 "location": "path",
226 "pattern": "^beacons/[^/]+$",
227 "required": true,
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": { 136 "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.", 137 "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", 138 "httpMethod": "GET",
242 "id": "proximitybeacon.beacons.get", 139 "id": "proximitybeacon.beacons.get",
243 "parameterOrder": [ 140 "parameterOrder": [
244 "beaconName" 141 "beaconName"
245 ], 142 ],
246 "parameters": { 143 "parameters": {
247 "beaconName": { 144 "beaconName": {
248 "description": "Resource name of this beacon. A beac on 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 valu es are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nf or AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", 145 "description": "Resource name of this beacon. A beac on 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 valu es are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nf or AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
(...skipping 17 matching lines...) Expand all
266 ] 163 ]
267 }, 164 },
268 "update": { 165 "update": {
269 "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be pe rmanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate met hods on this API for\nactivation, deactivation, and decommissioning.\nAuthentica te using an [OAuth access token](https://developers.google.com/identity/protocol s/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions i n the\nGoogle Developers Console project.", 166 "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be pe rmanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate met hods on this API for\nactivation, deactivation, and decommissioning.\nAuthentica te using an [OAuth access token](https://developers.google.com/identity/protocol s/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions i n the\nGoogle Developers Console project.",
270 "httpMethod": "PUT", 167 "httpMethod": "PUT",
271 "id": "proximitybeacon.beacons.update", 168 "id": "proximitybeacon.beacons.update",
272 "parameterOrder": [ 169 "parameterOrder": [
273 "beaconName" 170 "beaconName"
274 ], 171 ],
275 "parameters": { 172 "parameters": {
276 "projectId": {
277 "description": "The project id of the beacon to upda te. If the project id is not\nspecified then the project making the request is u sed. The project id\nmust match the project that owns the beacon.\nOptional.",
278 "location": "query",
279 "type": "string"
280 },
281 "beaconName": { 173 "beaconName": {
282 "description": "Resource name of this beacon. A beac on 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 valu es 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 th e name for future operations.", 174 "description": "Resource name of this beacon. A beac on 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 valu es 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 th e name for future operations.",
283 "location": "path", 175 "location": "path",
284 "pattern": "^beacons/[^/]+$", 176 "pattern": "^beacons/[^/]+$",
285 "required": true, 177 "required": true,
286 "type": "string" 178 "type": "string"
179 },
180 "projectId": {
181 "description": "The project id of the beacon to upda te. If the project id is not\nspecified then the project making the request is u sed. The project id\nmust match the project that owns the beacon.\nOptional.",
182 "location": "query",
183 "type": "string"
287 } 184 }
288 }, 185 },
289 "path": "v1beta1/{+beaconName}", 186 "path": "v1beta1/{+beaconName}",
290 "request": { 187 "request": {
291 "$ref": "Beacon" 188 "$ref": "Beacon"
292 }, 189 },
293 "response": { 190 "response": {
294 "$ref": "Beacon" 191 "$ref": "Beacon"
295 }, 192 },
296 "scopes": [ 193 "scopes": [
(...skipping 109 matching lines...) Expand 10 before | Expand all | Expand 10 after
406 "scopes": [ 303 "scopes": [
407 "https://www.googleapis.com/auth/userlocation.beacon.reg istry" 304 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
408 ] 305 ]
409 }, 306 },
410 "list": { 307 "list": {
411 "description": "Searches the beacon registry for beacons tha t match the given search\ncriteria. Only those beacons that the client has permi ssion to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](h ttps://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user w ith **viewer**, **Is owner** or **Can edit**\npermissions in the Google Develope rs Console project.", 308 "description": "Searches the beacon registry for beacons tha t match the given search\ncriteria. Only those beacons that the client has permi ssion to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](h ttps://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user w ith **viewer**, **Is owner** or **Can edit**\npermissions in the Google Develope rs Console project.",
412 "httpMethod": "GET", 309 "httpMethod": "GET",
413 "id": "proximitybeacon.beacons.list", 310 "id": "proximitybeacon.beacons.list",
414 "parameterOrder": [], 311 "parameterOrder": [],
415 "parameters": { 312 "parameters": {
416 "projectId": {
417 "description": "The project id to list beacons under . If not present then the project\ncredential that made the request is used as t he project.\nOptional.",
418 "location": "query",
419 "type": "string"
420 },
421 "pageToken": { 313 "pageToken": {
422 "description": "A pagination token obtained from a p revious request to list beacons.", 314 "description": "A pagination token obtained from a p revious request to list beacons.",
423 "location": "query", 315 "location": "query",
424 "type": "string" 316 "type": "string"
425 }, 317 },
426 "pageSize": { 318 "pageSize": {
427 "description": "The maximum number of records to ret urn for this request, up to a\nserver-defined upper limit.", 319 "description": "The maximum number of records to ret urn for this request, up to a\nserver-defined upper limit.",
428 "format": "int32", 320 "format": "int32",
429 "location": "query", 321 "location": "query",
430 "type": "integer" 322 "type": "integer"
431 }, 323 },
432 "q": { 324 "q": {
433 "description": "Filter query string that supports th e following field filters:\n\n* **description:`\"<string>\"`**\n For example: * *description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string mus t be double-quoted.\n* **status:`<enum>`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of t he Beacon.Status enum values (case insensitive). Accepts\n multiple filters whi ch will be combined with OR logic.\n* **stability:`<enum>`**\n For example: **s tability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insens itive). Accepts multiple filters which will be combined with\n OR logic.\n* **p lace\\_id:`\"<string>\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6 SslKw=\"**\n Returns beacons explicitly registered at the given place, expresse d as\n a Place ID obtained from [Google Places API](/places/place-id). Does not \n match places inside the given place. Does not consider the beacon's\n actua l location (which may be different from its registered place).\n Accepts multip le filters that will be combined with OR logic. The place\n ID must be double-q uoted.\n* **registration\\_time`[<|>|<=|>=]<integer>`**\n For example: **regist ration\\_time>=1433116800**\n Returns beacons whose registration time matches t he given filter.\n Supports the operators: <, >, <=, and >=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support \n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`<double> lng:<double> radius:<integer>`**\n For example: ** lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered l ocation is within the given circle.\n When any of these fields are given, all a re required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer nu mber of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"<string>= <string>\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns be acons which have a property of the given name and value.\n Supports multiple fi lters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"<string>\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within t his namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be do uble-quoted.\n* **indoor\\_level:`\"<string>\"`**\n For example: **indoor\\_lev el:\"1\"**\n Returns beacons which are located on the given indoor level. Accep ts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined wi th AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample R EST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20 radius:1000`", 325 "description": "Filter query string that supports th e following field filters:\n\n* **description:`\"<string>\"`**\n For example: * *description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string mus t be double-quoted.\n* **status:`<enum>`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of t he Beacon.Status enum values (case insensitive). Accepts\n multiple filters whi ch will be combined with OR logic.\n* **stability:`<enum>`**\n For example: **s tability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insens itive). Accepts multiple filters which will be combined with\n OR logic.\n* **p lace\\_id:`\"<string>\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6 SslKw=\"**\n Returns beacons explicitly registered at the given place, expresse d as\n a Place ID obtained from [Google Places API](/places/place-id). Does not \n match places inside the given place. Does not consider the beacon's\n actua l location (which may be different from its registered place).\n Accepts multip le filters that will be combined with OR logic. The place\n ID must be double-q uoted.\n* **registration\\_time`[<|>|<=|>=]<integer>`**\n For example: **regist ration\\_time>=1433116800**\n Returns beacons whose registration time matches t he given filter.\n Supports the operators: <, >, <=, and >=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support \n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`<double> lng:<double> radius:<integer>`**\n For example: ** lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered l ocation is within the given circle.\n When any of these fields are given, all a re required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer nu mber of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"<string>= <string>\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns be acons which have a property of the given name and value.\n Supports multiple fi lters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"<string>\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within t his namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be do uble-quoted.\n* **indoor\\_level:`\"<string>\"`**\n For example: **indoor\\_lev el:\"1\"**\n Returns beacons which are located on the given indoor level. Accep ts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined wi th AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample R EST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20 radius:1000`",
434 "location": "query", 326 "location": "query",
435 "type": "string" 327 "type": "string"
328 },
329 "projectId": {
330 "description": "The project id to list beacons under . If not present then the project\ncredential that made the request is used as t he project.\nOptional.",
331 "location": "query",
332 "type": "string"
436 } 333 }
437 }, 334 },
438 "path": "v1beta1/beacons", 335 "path": "v1beta1/beacons",
439 "response": { 336 "response": {
440 "$ref": "ListBeaconsResponse" 337 "$ref": "ListBeaconsResponse"
441 }, 338 },
442 "scopes": [ 339 "scopes": [
443 "https://www.googleapis.com/auth/userlocation.beacon.reg istry" 340 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
444 ] 341 ]
342 },
343 "activate": {
344 "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.",
345 "httpMethod": "POST",
346 "id": "proximitybeacon.beacons.activate",
347 "parameterOrder": [
348 "beaconName"
349 ],
350 "parameters": {
351 "beaconName": {
352 "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.",
353 "location": "path",
354 "pattern": "^beacons/[^/]+$",
355 "required": true,
356 "type": "string"
357 },
358 "projectId": {
359 "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.",
360 "location": "query",
361 "type": "string"
362 }
363 },
364 "path": "v1beta1/{+beaconName}:activate",
365 "response": {
366 "$ref": "Empty"
367 },
368 "scopes": [
369 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
370 ]
445 } 371 }
446 }, 372 },
447 "resources": { 373 "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 "alertFilter": {
459 "description": "Requests only beacons that h ave the given alert. For example, to find\nbeacons that have low batteries use ` alert_filter=LOW_BATTERY`.",
460 "enum": [
461 "ALERT_UNSPECIFIED",
462 "WRONG_LOCATION",
463 "LOW_BATTERY"
464 ],
465 "location": "query",
466 "type": "string"
467 },
468 "pageSize": {
469 "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
470 "format": "int32",
471 "location": "query",
472 "type": "integer"
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 },
502 "attachments": { 374 "attachments": {
503 "methods": { 375 "methods": {
504 "delete": { 376 "delete": {
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.", 377 "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.",
506 "httpMethod": "DELETE", 378 "httpMethod": "DELETE",
507 "id": "proximitybeacon.beacons.attachments.delete", 379 "id": "proximitybeacon.beacons.attachments.delete",
508 "parameterOrder": [ 380 "parameterOrder": [
509 "attachmentName" 381 "attachmentName"
510 ], 382 ],
511 "parameters": { 383 "parameters": {
(...skipping 19 matching lines...) Expand all
531 ] 403 ]
532 }, 404 },
533 "list": { 405 "list": {
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.", 406 "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.",
535 "httpMethod": "GET", 407 "httpMethod": "GET",
536 "id": "proximitybeacon.beacons.attachments.list", 408 "id": "proximitybeacon.beacons.attachments.list",
537 "parameterOrder": [ 409 "parameterOrder": [
538 "beaconName" 410 "beaconName"
539 ], 411 ],
540 "parameters": { 412 "parameters": {
541 "projectId": {
542 "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.",
543 "location": "query",
544 "type": "string"
545 },
546 "namespacedType": { 413 "namespacedType": {
547 "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\".", 414 "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\".",
548 "location": "query", 415 "location": "query",
549 "type": "string" 416 "type": "string"
550 }, 417 },
551 "beaconName": { 418 "beaconName": {
552 "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.", 419 "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.",
553 "location": "path", 420 "location": "path",
554 "pattern": "^beacons/[^/]+$", 421 "pattern": "^beacons/[^/]+$",
555 "required": true, 422 "required": true,
556 "type": "string" 423 "type": "string"
424 },
425 "projectId": {
426 "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.",
427 "location": "query",
428 "type": "string"
557 } 429 }
558 }, 430 },
559 "path": "v1beta1/{+beaconName}/attachments", 431 "path": "v1beta1/{+beaconName}/attachments",
560 "response": { 432 "response": {
561 "$ref": "ListBeaconAttachmentsResponse" 433 "$ref": "ListBeaconAttachmentsResponse"
562 }, 434 },
563 "scopes": [ 435 "scopes": [
564 "https://www.googleapis.com/auth/userlocation.be acon.registry" 436 "https://www.googleapis.com/auth/userlocation.be acon.registry"
565 ] 437 ]
566 }, 438 },
567 "batchDelete": { 439 "batchDelete": {
568 "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.", 440 "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.",
569 "httpMethod": "POST", 441 "httpMethod": "POST",
570 "id": "proximitybeacon.beacons.attachments.batchDele te", 442 "id": "proximitybeacon.beacons.attachments.batchDele te",
571 "parameterOrder": [ 443 "parameterOrder": [
572 "beaconName" 444 "beaconName"
573 ], 445 ],
574 "parameters": { 446 "parameters": {
447 "beaconName": {
448 "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.",
449 "location": "path",
450 "pattern": "^beacons/[^/]+$",
451 "required": true,
452 "type": "string"
453 },
575 "projectId": { 454 "projectId": {
576 "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.", 455 "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.",
577 "location": "query", 456 "location": "query",
578 "type": "string" 457 "type": "string"
579 }, 458 },
580 "namespacedType": { 459 "namespacedType": {
581 "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.", 460 "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.",
582 "location": "query", 461 "location": "query",
583 "type": "string" 462 "type": "string"
584 },
585 "beaconName": {
586 "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.",
587 "location": "path",
588 "pattern": "^beacons/[^/]+$",
589 "required": true,
590 "type": "string"
591 } 463 }
592 }, 464 },
593 "path": "v1beta1/{+beaconName}/attachments:batchDele te", 465 "path": "v1beta1/{+beaconName}/attachments:batchDele te",
594 "response": { 466 "response": {
595 "$ref": "DeleteAttachmentsResponse" 467 "$ref": "DeleteAttachmentsResponse"
596 }, 468 },
597 "scopes": [ 469 "scopes": [
598 "https://www.googleapis.com/auth/userlocation.be acon.registry" 470 "https://www.googleapis.com/auth/userlocation.be acon.registry"
599 ] 471 ]
600 }, 472 },
601 "create": { 473 "create": {
602 "description": "Associates the given data with the s pecified beacon. Attachment data must\ncontain two parts:\n<ul>\n<li>A namespace d type.</li>\n<li>The actual attachment data itself.</li>\n</ul>\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 charact ers in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/O Auth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in t he\nGoogle Developers Console project.", 474 "description": "Associates the given data with the s pecified beacon. Attachment data must\ncontain two parts:\n<ul>\n<li>A namespace d type.</li>\n<li>The actual attachment data itself.</li>\n</ul>\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 charact ers in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/O Auth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in t he\nGoogle Developers Console project.",
603 "httpMethod": "POST", 475 "httpMethod": "POST",
604 "id": "proximitybeacon.beacons.attachments.create", 476 "id": "proximitybeacon.beacons.attachments.create",
605 "parameterOrder": [ 477 "parameterOrder": [
606 "beaconName" 478 "beaconName"
607 ], 479 ],
608 "parameters": { 480 "parameters": {
609 "projectId": {
610 "description": "The project id of the projec t the attachment will belong to. If\nthe project id is not specified then the pr oject making the request\nis used.\nOptional.",
611 "location": "query",
612 "type": "string"
613 },
614 "beaconName": { 481 "beaconName": {
615 "description": "Beacon on which the attachme nt should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId 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 either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", 482 "description": "Beacon on which the attachme nt should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId 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 either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
616 "location": "path", 483 "location": "path",
617 "pattern": "^beacons/[^/]+$", 484 "pattern": "^beacons/[^/]+$",
618 "required": true, 485 "required": true,
619 "type": "string" 486 "type": "string"
487 },
488 "projectId": {
489 "description": "The project id of the projec t the attachment will belong to. If\nthe project id is not specified then the pr oject making the request\nis used.\nOptional.",
490 "location": "query",
491 "type": "string"
620 } 492 }
621 }, 493 },
622 "path": "v1beta1/{+beaconName}/attachments", 494 "path": "v1beta1/{+beaconName}/attachments",
623 "request": { 495 "request": {
624 "$ref": "BeaconAttachment" 496 "$ref": "BeaconAttachment"
625 }, 497 },
626 "response": { 498 "response": {
627 "$ref": "BeaconAttachment" 499 "$ref": "BeaconAttachment"
628 }, 500 },
629 "scopes": [ 501 "scopes": [
630 "https://www.googleapis.com/auth/userlocation.be acon.registry" 502 "https://www.googleapis.com/auth/userlocation.be acon.registry"
631 ] 503 ]
632 } 504 }
633 } 505 }
506 },
507 "diagnostics": {
508 "methods": {
509 "list": {
510 "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.",
511 "httpMethod": "GET",
512 "id": "proximitybeacon.beacons.diagnostics.list",
513 "parameterOrder": [
514 "beaconName"
515 ],
516 "parameters": {
517 "beaconName": {
518 "description": "Beacon that the diagnostics are for.",
519 "location": "path",
520 "pattern": "^beacons/[^/]+$",
521 "required": true,
522 "type": "string"
523 },
524 "pageToken": {
525 "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optio nal.",
526 "location": "query",
527 "type": "string"
528 },
529 "alertFilter": {
530 "description": "Requests only beacons that h ave the given alert. For example, to find\nbeacons that have low batteries use ` alert_filter=LOW_BATTERY`.",
531 "enum": [
532 "ALERT_UNSPECIFIED",
533 "WRONG_LOCATION",
534 "LOW_BATTERY"
535 ],
536 "location": "query",
537 "type": "string"
538 },
539 "pageSize": {
540 "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
541 "format": "int32",
542 "location": "query",
543 "type": "integer"
544 },
545 "projectId": {
546 "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.",
547 "location": "query",
548 "type": "string"
549 }
550 },
551 "path": "v1beta1/{+beaconName}/diagnostics",
552 "response": {
553 "$ref": "ListDiagnosticsResponse"
554 },
555 "scopes": [
556 "https://www.googleapis.com/auth/userlocation.be acon.registry"
557 ]
558 }
559 }
560 }
561 }
562 },
563 "beaconinfo": {
564 "methods": {
565 "getforobserved": {
566 "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.",
567 "httpMethod": "POST",
568 "id": "proximitybeacon.beaconinfo.getforobserved",
569 "parameterOrder": [],
570 "parameters": {},
571 "path": "v1beta1/beaconinfo:getforobserved",
572 "request": {
573 "$ref": "GetInfoForObservedBeaconsRequest"
574 },
575 "response": {
576 "$ref": "GetInfoForObservedBeaconsResponse"
577 }
578 }
579 }
580 },
581 "namespaces": {
582 "methods": {
583 "update": {
584 "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
585 "httpMethod": "PUT",
586 "id": "proximitybeacon.namespaces.update",
587 "parameterOrder": [
588 "namespaceName"
589 ],
590 "parameters": {
591 "namespaceName": {
592 "description": "Resource name of this namespace. Nam espaces names have the format:\n<code>namespaces/<var>namespace</var></code>.",
593 "location": "path",
594 "pattern": "^namespaces/[^/]+$",
595 "required": true,
596 "type": "string"
597 },
598 "projectId": {
599 "description": "The project id of the namespace to u pdate. If the project id is not\nspecified then the project making the request i s used. The project id\nmust match the project that owns the beacon.\nOptional." ,
600 "location": "query",
601 "type": "string"
602 }
603 },
604 "path": "v1beta1/{+namespaceName}",
605 "request": {
606 "$ref": "Namespace"
607 },
608 "response": {
609 "$ref": "Namespace"
610 },
611 "scopes": [
612 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
613 ]
614 },
615 "list": {
616 "description": "Lists all attachment namespaces owned by you r Google Developers Console\nproject. Attachment data associated with a beacon m ust include a\nnamespaced type, and the namespace must be owned by your project. \n\nAuthenticate using an [OAuth access token](https://developers.google.com/ide ntity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
617 "httpMethod": "GET",
618 "id": "proximitybeacon.namespaces.list",
619 "parameterOrder": [],
620 "parameters": {
621 "projectId": {
622 "description": "The project id to list namespaces un der.\nOptional.",
623 "location": "query",
624 "type": "string"
625 }
626 },
627 "path": "v1beta1/namespaces",
628 "response": {
629 "$ref": "ListNamespacesResponse"
630 },
631 "scopes": [
632 "https://www.googleapis.com/auth/userlocation.beacon.reg istry"
633 ]
634 } 634 }
635 } 635 }
636 } 636 }
637 }, 637 },
638 "revision": "20170815", 638 "revision": "20170823",
639 "rootUrl": "https://proximitybeacon.googleapis.com/", 639 "rootUrl": "https://proximitybeacon.googleapis.com/",
640 "schemas": { 640 "schemas": {
641 "Beacon": {
642 "description": "Details of a beacon device.",
643 "id": "Beacon",
644 "properties": {
645 "properties": {
646 "additionalProperties": {
647 "type": "string"
648 },
649 "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
650 "type": "object"
651 },
652 "status": {
653 "description": "Current status of the beacon.\nRequired.",
654 "enum": [
655 "STATUS_UNSPECIFIED",
656 "ACTIVE",
657 "DECOMMISSIONED",
658 "INACTIVE"
659 ],
660 "enumDescriptions": [
661 "Do not use this value.",
662 "The \"normal\" in-use state of a beacon.",
663 "Beacon should no longer be used for any purpose. This i s irreversible.",
664 "The beacon should not be visible to mobile devices. Thi s is reversible."
665 ],
666 "type": "string"
667 },
668 "indoorLevel": {
669 "$ref": "IndoorLevel",
670 "description": "The indoor level information for this beacon , if known. As returned by the\nGoogle Maps API.\nOptional."
671 },
672 "beaconName": {
673 "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.",
674 "type": "string"
675 },
676 "expectedStability": {
677 "description": "Expected location stability. This is set whe n the beacon is registered or\nupdated, not automatically detected in any way.\n Optional.",
678 "enum": [
679 "STABILITY_UNSPECIFIED",
680 "STABLE",
681 "PORTABLE",
682 "MOBILE",
683 "ROVING"
684 ],
685 "enumDescriptions": [
686 "Do not use this value.",
687 "Not expected to move, for example a store's front door. ",
688 "Usually stable but may move rarely, usually within a si ngle place,\nfor example a store display.",
689 "Moves frequently, for example a personal item or food t ruck.",
690 "Moves continuously in service, for example a bus or tra in."
691 ],
692 "type": "string"
693 },
694 "advertisedId": {
695 "$ref": "AdvertisedId",
696 "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updatin g a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beaco n that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddysto ne-UID that identifies the beacon and\nlinks it to its attachments. The stable E ddystone-UID is only used for\nadministering the beacon."
697 },
698 "ephemeralIdRegistration": {
699 "$ref": "EphemeralIdRegistration",
700 "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."
701 },
702 "provisioningKey": {
703 "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.",
704 "format": "byte",
705 "type": "string"
706 },
707 "description": {
708 "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
709 "type": "string"
710 },
711 "placeId": {
712 "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.",
713 "type": "string"
714 },
715 "latLng": {
716 "$ref": "LatLng",
717 "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."
718 }
719 },
720 "type": "object"
721 },
722 "AdvertisedId": {
723 "description": "Defines a unique identifier of a beacon as broadcast by the device.",
724 "id": "AdvertisedId",
725 "properties": {
726 "id": {
727 "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.",
728 "format": "byte",
729 "type": "string"
730 },
731 "type": {
732 "description": "Specifies the identifier type.\nRequired.",
733 "enum": [
734 "TYPE_UNSPECIFIED",
735 "EDDYSTONE",
736 "IBEACON",
737 "ALTBEACON",
738 "EDDYSTONE_EID"
739 ],
740 "enumDescriptions": [
741 "Do not use this value.",
742 "Eddystone, an open beacon format that supports Android and iOS devices\nhttps://github.com/google/eddystone/wiki/Beacon-Specification",
743 "Apple iBeacon compatible beacon",
744 "See http://altbeacon.org and/or https://github.com/AltB eacon/spec.",
745 "Eddystone Ephemeral ID"
746 ],
747 "type": "string"
748 }
749 },
750 "type": "object"
751 },
641 "Date": { 752 "Date": {
642 "description": "Represents a whole calendar date, e.g. date of birth . The time of day and\ntime zone are either specified elsewhere or are not signi ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b e 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independe nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.", 753 "description": "Represents a whole calendar date, e.g. date of birth . The time of day and\ntime zone are either specified elsewhere or are not signi ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b e 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independe nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
643 "id": "Date", 754 "id": "Date",
644 "properties": { 755 "properties": {
756 "month": {
757 "description": "Month of year. Must be from 1 to 12.",
758 "format": "int32",
759 "type": "integer"
760 },
645 "day": { 761 "day": {
646 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.", 762 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.",
647 "format": "int32", 763 "format": "int32",
648 "type": "integer" 764 "type": "integer"
649 }, 765 },
650 "year": { 766 "year": {
651 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.", 767 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",
652 "format": "int32", 768 "format": "int32",
653 "type": "integer" 769 "type": "integer"
654 },
655 "month": {
656 "description": "Month of year. Must be from 1 to 12.",
657 "format": "int32",
658 "type": "integer"
659 } 770 }
660 }, 771 },
661 "type": "object" 772 "type": "object"
662 }, 773 },
663 "IndoorLevel": { 774 "IndoorLevel": {
664 "description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is loc ated on.", 775 "description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is loc ated on.",
665 "id": "IndoorLevel", 776 "id": "IndoorLevel",
666 "properties": { 777 "properties": {
667 "name": { 778 "name": {
668 "description": "The name of this level.", 779 "description": "The name of this level.",
669 "type": "string" 780 "type": "string"
670 } 781 }
671 }, 782 },
672 "type": "object" 783 "type": "object"
673 }, 784 },
674 "ListNamespacesResponse": { 785 "ListNamespacesResponse": {
675 "description": "Response to ListNamespacesRequest that contains all the project's namespaces.", 786 "description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
676 "id": "ListNamespacesResponse", 787 "id": "ListNamespacesResponse",
677 "properties": { 788 "properties": {
678 "namespaces": { 789 "namespaces": {
679 "description": "The attachments that corresponded to the req uest params.", 790 "description": "The attachments that corresponded to the req uest params.",
680 "items": { 791 "items": {
681 "$ref": "Namespace" 792 "$ref": "Namespace"
682 }, 793 },
683 "type": "array" 794 "type": "array"
684 } 795 }
685 },
686 "type": "object"
687 },
688 "ListBeaconsResponse": {
689 "description": "Response that contains list beacon results and pagin ation help.",
690 "id": "ListBeaconsResponse",
691 "properties": {
692 "nextPageToken": {
693 "description": "An opaque pagination token that the client m ay provide in their next\nrequest to retrieve the next page of results.",
694 "type": "string"
695 },
696 "totalCount": {
697 "description": "Estimate of the total number of beacons matc hed by the query. Higher\nvalues may be less accurate.",
698 "format": "int64",
699 "type": "string"
700 },
701 "beacons": {
702 "description": "The beacons that matched the search criteria .",
703 "items": {
704 "$ref": "Beacon"
705 },
706 "type": "array"
707 }
708 }, 796 },
709 "type": "object" 797 "type": "object"
710 }, 798 },
711 "Diagnostics": { 799 "Diagnostics": {
712 "description": "Diagnostics for a single beacon.", 800 "description": "Diagnostics for a single beacon.",
713 "id": "Diagnostics", 801 "id": "Diagnostics",
714 "properties": { 802 "properties": {
803 "beaconName": {
804 "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.",
805 "type": "string"
806 },
715 "alerts": { 807 "alerts": {
716 "description": "An unordered list of Alerts that the beacon has.", 808 "description": "An unordered list of Alerts that the beacon has.",
717 "enumDescriptions": [ 809 "enumDescriptions": [
718 "Invalid value. Should never appear.", 810 "Invalid value. Should never appear.",
719 "The beacon has been reported in a location different th an its registered\nlocation. This may indicate that the beacon has been moved. T his signal\nis not 100% accurate, but indicates that further investigation is wo rth\nwhile.", 811 "The beacon has been reported in a location different th an its registered\nlocation. This may indicate that the beacon has been moved. T his signal\nis not 100% accurate, but indicates that further investigation is wo rth\nwhile.",
720 "The battery level for the beacon is low enough that, gi ven the beacon's\ncurrent use, its battery will run out with in the next 60 days . This\nindicates that the battery should be replaced soon." 812 "The battery level for the beacon is low enough that, gi ven the beacon's\ncurrent use, its battery will run out with in the next 60 days . This\nindicates that the battery should be replaced soon."
721 ], 813 ],
722 "items": { 814 "items": {
723 "enum": [ 815 "enum": [
724 "ALERT_UNSPECIFIED", 816 "ALERT_UNSPECIFIED",
725 "WRONG_LOCATION", 817 "WRONG_LOCATION",
726 "LOW_BATTERY" 818 "LOW_BATTERY"
727 ], 819 ],
728 "type": "string" 820 "type": "string"
729 }, 821 },
730 "type": "array" 822 "type": "array"
731 }, 823 },
732 "estimatedLowBatteryDate": { 824 "estimatedLowBatteryDate": {
733 "$ref": "Date", 825 "$ref": "Date",
734 "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." 826 "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."
735 },
736 "beaconName": {
737 "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.",
738 "type": "string"
739 } 827 }
740 }, 828 },
741 "type": "object" 829 "type": "object"
742 }, 830 },
743 "Empty": { 831 "ListBeaconsResponse": {
744 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", 832 "description": "Response that contains list beacon results and pagin ation help.",
745 "id": "Empty", 833 "id": "ListBeaconsResponse",
746 "properties": {}, 834 "properties": {
835 "nextPageToken": {
836 "description": "An opaque pagination token that the client m ay provide in their next\nrequest to retrieve the next page of results.",
837 "type": "string"
838 },
839 "totalCount": {
840 "description": "Estimate of the total number of beacons matc hed by the query. Higher\nvalues may be less accurate.",
841 "format": "int64",
842 "type": "string"
843 },
844 "beacons": {
845 "description": "The beacons that matched the search criteria .",
846 "items": {
847 "$ref": "Beacon"
848 },
849 "type": "array"
850 }
851 },
747 "type": "object" 852 "type": "object"
748 }, 853 },
749 "GetInfoForObservedBeaconsRequest": { 854 "GetInfoForObservedBeaconsRequest": {
750 "description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".", 855 "description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".",
751 "id": "GetInfoForObservedBeaconsRequest", 856 "id": "GetInfoForObservedBeaconsRequest",
752 "properties": { 857 "properties": {
753 "observations": { 858 "observations": {
754 "description": "The beacons that the client has encountered. \nAt least one must be given.", 859 "description": "The beacons that the client has encountered. \nAt least one must be given.",
755 "items": { 860 "items": {
756 "$ref": "Observation" 861 "$ref": "Observation"
757 }, 862 },
758 "type": "array" 863 "type": "array"
759 }, 864 },
760 "namespacedTypes": { 865 "namespacedTypes": {
761 "description": "Specifies what kind of attachments to includ e in the response.\nWhen given, the response will include only attachments of th e given types.\nWhen empty, no attachments will be returned. Must be in the form at\n<var>namespace/type</var>. Accepts `*` to specify all types in\nall namespac es owned by the client.\nOptional.", 866 "description": "Specifies what kind of attachments to includ e in the response.\nWhen given, the response will include only attachments of th e given types.\nWhen empty, no attachments will be returned. Must be in the form at\n<var>namespace/type</var>. Accepts `*` to specify all types in\nall namespac es owned by the client.\nOptional.",
762 "items": { 867 "items": {
763 "type": "string" 868 "type": "string"
764 }, 869 },
765 "type": "array" 870 "type": "array"
766 } 871 }
767 }, 872 },
768 "type": "object" 873 "type": "object"
769 }, 874 },
875 "Empty": {
876 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
877 "id": "Empty",
878 "properties": {},
879 "type": "object"
880 },
770 "BeaconAttachment": { 881 "BeaconAttachment": {
771 "description": "Project-specific data associated with a beacon.", 882 "description": "Project-specific data associated with a beacon.",
772 "id": "BeaconAttachment", 883 "id": "BeaconAttachment",
773 "properties": { 884 "properties": {
774 "attachmentName": {
775 "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.",
776 "type": "string"
777 },
778 "namespacedType": {
779 "description": "Specifies what kind of attachment this is. T ells a client how to\ninterpret the `data` field. Format is <var>namespace/type< /var>. Namespace\nprovides type separation between clients. Type describes the t ype of\n`data`, for use by the client when parsing the `data` field.\nRequired." ,
780 "type": "string"
781 },
782 "data": { 885 "data": {
783 "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded i n HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired. ", 886 "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded i n HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired. ",
784 "format": "byte", 887 "format": "byte",
785 "type": "string" 888 "type": "string"
786 }, 889 },
787 "creationTimeMs": { 890 "creationTimeMs": {
788 "description": "The UTC time when this attachment was create d, in milliseconds since the\nUNIX epoch.", 891 "description": "The UTC time when this attachment was create d, in milliseconds since the\nUNIX epoch.",
789 "format": "google-datetime", 892 "format": "google-datetime",
790 "type": "string" 893 "type": "string"
894 },
895 "attachmentName": {
896 "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.",
897 "type": "string"
898 },
899 "namespacedType": {
900 "description": "Specifies what kind of attachment this is. T ells a client how to\ninterpret the `data` field. Format is <var>namespace/type< /var>. Namespace\nprovides type separation between clients. Type describes the t ype of\n`data`, for use by the client when parsing the `data` field.\nRequired." ,
901 "type": "string"
791 } 902 }
792 }, 903 },
793 "type": "object" 904 "type": "object"
794 }, 905 },
795 "EphemeralIdRegistration": { 906 "EphemeralIdRegistration": {
796 "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.", 907 "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.",
797 "id": "EphemeralIdRegistration", 908 "id": "EphemeralIdRegistration",
798 "properties": { 909 "properties": {
910 "initialClockValue": {
911 "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.",
912 "format": "uint64",
913 "type": "string"
914 },
915 "beaconEcdhPublicKey": {
916 "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.",
917 "format": "byte",
918 "type": "string"
919 },
799 "rotationPeriodExponent": { 920 "rotationPeriodExponent": {
800 "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.", 921 "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.",
801 "format": "uint32", 922 "format": "uint32",
802 "type": "integer" 923 "type": "integer"
803 }, 924 },
804 "serviceEcdhPublicKey": { 925 "serviceEcdhPublicKey": {
805 "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.", 926 "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.",
806 "format": "byte", 927 "format": "byte",
807 "type": "string" 928 "type": "string"
808 }, 929 },
809 "beaconIdentityKey": { 930 "beaconIdentityKey": {
810 "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.", 931 "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.",
811 "format": "byte", 932 "format": "byte",
812 "type": "string" 933 "type": "string"
813 }, 934 },
814 "initialEid": { 935 "initialEid": {
815 "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.", 936 "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.",
816 "format": "byte", 937 "format": "byte",
817 "type": "string" 938 "type": "string"
818 },
819 "initialClockValue": {
820 "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.",
821 "format": "uint64",
822 "type": "string"
823 },
824 "beaconEcdhPublicKey": {
825 "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.",
826 "format": "byte",
827 "type": "string"
828 } 939 }
829 }, 940 },
830 "type": "object" 941 "type": "object"
831 }, 942 },
832 "LatLng": { 943 "LatLng": {
833 "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)", 944 "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)",
834 "id": "LatLng", 945 "id": "LatLng",
835 "properties": { 946 "properties": {
836 "latitude": { 947 "latitude": {
837 "description": "The latitude in degrees. It must be in the r ange [-90.0, +90.0].", 948 "description": "The latitude in degrees. It must be in the r ange [-90.0, +90.0].",
(...skipping 19 matching lines...) Expand all
857 }, 968 },
858 "type": "array" 969 "type": "array"
859 } 970 }
860 }, 971 },
861 "type": "object" 972 "type": "object"
862 }, 973 },
863 "Namespace": { 974 "Namespace": {
864 "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.", 975 "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.",
865 "id": "Namespace", 976 "id": "Namespace",
866 "properties": { 977 "properties": {
978 "namespaceName": {
979 "description": "Resource name of this namespace. Namespaces names have the format:\n<code>namespaces/<var>namespace</var></code>.",
980 "type": "string"
981 },
867 "servingVisibility": { 982 "servingVisibility": {
868 "description": "Specifies what clients may receive attachmen ts under this namespace\nvia `beaconinfo.getforobserved`.", 983 "description": "Specifies what clients may receive attachmen ts under this namespace\nvia `beaconinfo.getforobserved`.",
869 "enum": [ 984 "enum": [
870 "VISIBILITY_UNSPECIFIED", 985 "VISIBILITY_UNSPECIFIED",
871 "UNLISTED", 986 "UNLISTED",
872 "PUBLIC" 987 "PUBLIC"
873 ], 988 ],
874 "enumDescriptions": [ 989 "enumDescriptions": [
875 "Do not use this value.", 990 "Do not use this value.",
876 "Served only to the project that owns the namespace.", 991 "Served only to the project that owns the namespace.",
877 "Any project can subscribe to attachments under the name space." 992 "Any project can subscribe to attachments under the name space."
878 ], 993 ],
879 "type": "string" 994 "type": "string"
880 },
881 "namespaceName": {
882 "description": "Resource name of this namespace. Namespaces names have the format:\n<code>namespaces/<var>namespace</var></code>.",
883 "type": "string"
884 } 995 }
885 }, 996 },
886 "type": "object" 997 "type": "object"
887 }, 998 },
888 "AttachmentInfo": { 999 "AttachmentInfo": {
889 "description": "A subset of attachment information served via the\n` beaconinfo.getforobserved` method, used when your users encounter your\nbeacons. ", 1000 "description": "A subset of attachment information served via the\n` beaconinfo.getforobserved` method, used when your users encounter your\nbeacons. ",
890 "id": "AttachmentInfo", 1001 "id": "AttachmentInfo",
891 "properties": { 1002 "properties": {
892 "data": { 1003 "data": {
893 "description": "An opaque data container for client-provided data.", 1004 "description": "An opaque data container for client-provided data.",
(...skipping 22 matching lines...) Expand all
916 }, 1027 },
917 "type": "array" 1028 "type": "array"
918 }, 1029 },
919 "advertisedId": { 1030 "advertisedId": {
920 "$ref": "AdvertisedId", 1031 "$ref": "AdvertisedId",
921 "description": "The ID advertised by the beacon." 1032 "description": "The ID advertised by the beacon."
922 } 1033 }
923 }, 1034 },
924 "type": "object" 1035 "type": "object"
925 }, 1036 },
926 "DeleteAttachmentsResponse": {
927 "description": "Response for a request to delete attachments.",
928 "id": "DeleteAttachmentsResponse",
929 "properties": {
930 "numDeleted": {
931 "description": "The number of attachments that were deleted. ",
932 "format": "int32",
933 "type": "integer"
934 }
935 },
936 "type": "object"
937 },
938 "EphemeralIdRegistrationParams": { 1037 "EphemeralIdRegistrationParams": {
939 "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\n Diffie-Hellman key exchange. See\n[the Eddystone specification](https://github.c om/google/eddystone/tree/master/eddystone-eid) at GitHub.", 1038 "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\n Diffie-Hellman key exchange. See\n[the Eddystone specification](https://github.c om/google/eddystone/tree/master/eddystone-eid) at GitHub.",
940 "id": "EphemeralIdRegistrationParams", 1039 "id": "EphemeralIdRegistrationParams",
941 "properties": { 1040 "properties": {
942 "serviceEcdhPublicKey": {
943 "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.",
944 "format": "byte",
945 "type": "string"
946 },
947 "maxRotationPeriodExponent": { 1041 "maxRotationPeriodExponent": {
948 "description": "Indicates the maximum rotation period suppor ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", 1042 "description": "Indicates the maximum rotation period suppor ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
949 "format": "uint32", 1043 "format": "uint32",
950 "type": "integer" 1044 "type": "integer"
951 }, 1045 },
952 "minRotationPeriodExponent": { 1046 "minRotationPeriodExponent": {
953 "description": "Indicates the minimum rotation period suppor ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", 1047 "description": "Indicates the minimum rotation period suppor ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
954 "format": "uint32", 1048 "format": "uint32",
955 "type": "integer" 1049 "type": "integer"
1050 },
1051 "serviceEcdhPublicKey": {
1052 "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.",
1053 "format": "byte",
1054 "type": "string"
1055 }
1056 },
1057 "type": "object"
1058 },
1059 "DeleteAttachmentsResponse": {
1060 "description": "Response for a request to delete attachments.",
1061 "id": "DeleteAttachmentsResponse",
1062 "properties": {
1063 "numDeleted": {
1064 "description": "The number of attachments that were deleted. ",
1065 "format": "int32",
1066 "type": "integer"
956 } 1067 }
957 }, 1068 },
958 "type": "object" 1069 "type": "object"
959 }, 1070 },
960 "Observation": { 1071 "Observation": {
961 "description": "Represents one beacon observed once.", 1072 "description": "Represents one beacon observed once.",
962 "id": "Observation", 1073 "id": "Observation",
963 "properties": { 1074 "properties": {
964 "telemetry": {
965 "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.",
966 "format": "byte",
967 "type": "string"
968 },
969 "timestampMs": { 1075 "timestampMs": {
970 "description": "Time when the beacon was observed.", 1076 "description": "Time when the beacon was observed.",
971 "format": "google-datetime", 1077 "format": "google-datetime",
972 "type": "string" 1078 "type": "string"
973 }, 1079 },
974 "advertisedId": { 1080 "advertisedId": {
975 "$ref": "AdvertisedId", 1081 "$ref": "AdvertisedId",
976 "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." 1082 "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."
1083 },
1084 "telemetry": {
1085 "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.",
1086 "format": "byte",
1087 "type": "string"
977 } 1088 }
978 }, 1089 },
979 "type": "object" 1090 "type": "object"
980 }, 1091 },
981 "ListDiagnosticsResponse": { 1092 "ListDiagnosticsResponse": {
982 "description": "Response that contains the requested diagnostics.", 1093 "description": "Response that contains the requested diagnostics.",
983 "id": "ListDiagnosticsResponse", 1094 "id": "ListDiagnosticsResponse",
984 "properties": { 1095 "properties": {
985 "nextPageToken": { 1096 "nextPageToken": {
986 "description": "Token that can be used for pagination. Retur ned only if the\nrequest matches more beacons than can be returned in this respo nse.", 1097 "description": "Token that can be used for pagination. Retur ned only if the\nrequest matches more beacons than can be returned in this respo nse.",
(...skipping 15 matching lines...) Expand all
1002 "properties": { 1113 "properties": {
1003 "beacons": { 1114 "beacons": {
1004 "description": "Public information about beacons.\nMay be em pty if the request matched no beacons.", 1115 "description": "Public information about beacons.\nMay be em pty if the request matched no beacons.",
1005 "items": { 1116 "items": {
1006 "$ref": "BeaconInfo" 1117 "$ref": "BeaconInfo"
1007 }, 1118 },
1008 "type": "array" 1119 "type": "array"
1009 } 1120 }
1010 }, 1121 },
1011 "type": "object" 1122 "type": "object"
1012 },
1013 "Beacon": {
1014 "description": "Details of a beacon device.",
1015 "id": "Beacon",
1016 "properties": {
1017 "advertisedId": {
1018 "$ref": "AdvertisedId",
1019 "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updatin g a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beaco n that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddysto ne-UID that identifies the beacon and\nlinks it to its attachments. The stable E ddystone-UID is only used for\nadministering the beacon."
1020 },
1021 "provisioningKey": {
1022 "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.",
1023 "format": "byte",
1024 "type": "string"
1025 },
1026 "ephemeralIdRegistration": {
1027 "$ref": "EphemeralIdRegistration",
1028 "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."
1029 },
1030 "latLng": {
1031 "$ref": "LatLng",
1032 "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."
1033 },
1034 "placeId": {
1035 "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.",
1036 "type": "string"
1037 },
1038 "description": {
1039 "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
1040 "type": "string"
1041 },
1042 "properties": {
1043 "additionalProperties": {
1044 "type": "string"
1045 },
1046 "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
1047 "type": "object"
1048 },
1049 "status": {
1050 "description": "Current status of the beacon.\nRequired.",
1051 "enum": [
1052 "STATUS_UNSPECIFIED",
1053 "ACTIVE",
1054 "DECOMMISSIONED",
1055 "INACTIVE"
1056 ],
1057 "enumDescriptions": [
1058 "Do not use this value.",
1059 "The \"normal\" in-use state of a beacon.",
1060 "Beacon should no longer be used for any purpose. This i s irreversible.",
1061 "The beacon should not be visible to mobile devices. Thi s is reversible."
1062 ],
1063 "type": "string"
1064 },
1065 "indoorLevel": {
1066 "$ref": "IndoorLevel",
1067 "description": "The indoor level information for this beacon , if known. As returned by the\nGoogle Maps API.\nOptional."
1068 },
1069 "beaconName": {
1070 "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.",
1071 "type": "string"
1072 },
1073 "expectedStability": {
1074 "description": "Expected location stability. This is set whe n the beacon is registered or\nupdated, not automatically detected in any way.\n Optional.",
1075 "enum": [
1076 "STABILITY_UNSPECIFIED",
1077 "STABLE",
1078 "PORTABLE",
1079 "MOBILE",
1080 "ROVING"
1081 ],
1082 "enumDescriptions": [
1083 "Do not use this value.",
1084 "Not expected to move, for example a store's front door. ",
1085 "Usually stable but may move rarely, usually within a si ngle place,\nfor example a store display.",
1086 "Moves frequently, for example a personal item or food t ruck.",
1087 "Moves continuously in service, for example a bus or tra in."
1088 ],
1089 "type": "string"
1090 }
1091 },
1092 "type": "object"
1093 },
1094 "AdvertisedId": {
1095 "description": "Defines a unique identifier of a beacon as broadcast by the device.",
1096 "id": "AdvertisedId",
1097 "properties": {
1098 "type": {
1099 "description": "Specifies the identifier type.\nRequired.",
1100 "enum": [
1101 "TYPE_UNSPECIFIED",
1102 "EDDYSTONE",
1103 "IBEACON",
1104 "ALTBEACON",
1105 "EDDYSTONE_EID"
1106 ],
1107 "enumDescriptions": [
1108 "Do not use this value.",
1109 "Eddystone, an open beacon format that supports Android and iOS devices\nhttps://github.com/google/eddystone/wiki/Beacon-Specification",
1110 "Apple iBeacon compatible beacon",
1111 "See http://altbeacon.org and/or https://github.com/AltB eacon/spec.",
1112 "Eddystone Ephemeral ID"
1113 ],
1114 "type": "string"
1115 },
1116 "id": {
1117 "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.",
1118 "format": "byte",
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 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/oslogin__v1alpha.json ('k') | discovery/googleapis_beta/pubsub__v1beta2.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698