OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/userlocation.beacon.registry":
{ | 5 "https://www.googleapis.com/auth/userlocation.beacon.registry":
{ |
6 "description": "View and modify your beacons" | 6 "description": "View and modify your beacons" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://proximitybeacon.googleapis.com/", | 12 "baseUrl": "https://proximitybeacon.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "description": "Registers, manages, indexes, and searches beacons.", | 14 "description": "Registers, manages, indexes, and searches beacons.", |
15 "discoveryVersion": "v1", | 15 "discoveryVersion": "v1", |
16 "documentationLink": "https://developers.google.com/beacons/proximity/", | 16 "documentationLink": "https://developers.google.com/beacons/proximity/", |
17 "icons": { | 17 "icons": { |
18 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 18 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
19 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 19 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
20 }, | 20 }, |
21 "id": "proximitybeacon:v1beta1", | 21 "id": "proximitybeacon:v1beta1", |
22 "kind": "discovery#restDescription", | 22 "kind": "discovery#restDescription", |
23 "name": "proximitybeacon", | 23 "name": "proximitybeacon", |
24 "ownerDomain": "google.com", | 24 "ownerDomain": "google.com", |
25 "ownerName": "Google", | 25 "ownerName": "Google", |
26 "parameters": { | 26 "parameters": { |
| 27 "quotaUser": { |
| 28 "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.", |
| 29 "location": "query", |
| 30 "type": "string" |
| 31 }, |
| 32 "pp": { |
| 33 "default": "true", |
| 34 "description": "Pretty-print response.", |
| 35 "location": "query", |
| 36 "type": "boolean" |
| 37 }, |
| 38 "oauth_token": { |
| 39 "description": "OAuth 2.0 token for the current user.", |
| 40 "location": "query", |
| 41 "type": "string" |
| 42 }, |
| 43 "bearer_token": { |
| 44 "description": "OAuth bearer token.", |
| 45 "location": "query", |
| 46 "type": "string" |
| 47 }, |
27 "upload_protocol": { | 48 "upload_protocol": { |
28 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 49 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
29 "location": "query", | 50 "location": "query", |
30 "type": "string" | 51 "type": "string" |
31 }, | 52 }, |
32 "prettyPrint": { | 53 "prettyPrint": { |
33 "default": "true", | 54 "default": "true", |
34 "description": "Returns response with indentations and line breaks."
, | 55 "description": "Returns response with indentations and line breaks."
, |
35 "location": "query", | 56 "location": "query", |
36 "type": "boolean" | 57 "type": "boolean" |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
72 "proto" | 93 "proto" |
73 ], | 94 ], |
74 "enumDescriptions": [ | 95 "enumDescriptions": [ |
75 "Responses with Content-Type of application/json", | 96 "Responses with Content-Type of application/json", |
76 "Media download with context-dependent Content-Type", | 97 "Media download with context-dependent Content-Type", |
77 "Responses with Content-Type of application/x-protobuf" | 98 "Responses with Content-Type of application/x-protobuf" |
78 ], | 99 ], |
79 "location": "query", | 100 "location": "query", |
80 "type": "string" | 101 "type": "string" |
81 }, | 102 }, |
82 "access_token": { | |
83 "description": "OAuth access token.", | |
84 "location": "query", | |
85 "type": "string" | |
86 }, | |
87 "key": { | 103 "key": { |
88 "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.", | 104 "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.", |
89 "location": "query", | 105 "location": "query", |
90 "type": "string" | 106 "type": "string" |
91 }, | 107 }, |
92 "quotaUser": { | 108 "access_token": { |
93 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 109 "description": "OAuth access token.", |
94 "location": "query", | |
95 "type": "string" | |
96 }, | |
97 "pp": { | |
98 "default": "true", | |
99 "description": "Pretty-print response.", | |
100 "location": "query", | |
101 "type": "boolean" | |
102 }, | |
103 "oauth_token": { | |
104 "description": "OAuth 2.0 token for the current user.", | |
105 "location": "query", | |
106 "type": "string" | |
107 }, | |
108 "bearer_token": { | |
109 "description": "OAuth bearer token.", | |
110 "location": "query", | 110 "location": "query", |
111 "type": "string" | 111 "type": "string" |
112 } | 112 } |
113 }, | 113 }, |
114 "protocol": "rest", | 114 "protocol": "rest", |
115 "resources": { | 115 "resources": { |
| 116 "beaconinfo": { |
| 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 "list": { |
| 137 "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.", |
| 138 "httpMethod": "GET", |
| 139 "id": "proximitybeacon.namespaces.list", |
| 140 "parameterOrder": [], |
| 141 "parameters": { |
| 142 "projectId": { |
| 143 "description": "The project id to list namespaces un
der.\nOptional.", |
| 144 "location": "query", |
| 145 "type": "string" |
| 146 } |
| 147 }, |
| 148 "path": "v1beta1/namespaces", |
| 149 "response": { |
| 150 "$ref": "ListNamespacesResponse" |
| 151 }, |
| 152 "scopes": [ |
| 153 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 154 ] |
| 155 }, |
| 156 "update": { |
| 157 "description": "Updates the information about the specified
namespace. Only the namespace\nvisibility can be updated.", |
| 158 "httpMethod": "PUT", |
| 159 "id": "proximitybeacon.namespaces.update", |
| 160 "parameterOrder": [ |
| 161 "namespaceName" |
| 162 ], |
| 163 "parameters": { |
| 164 "namespaceName": { |
| 165 "description": "Resource name of this namespace. Nam
espaces names have the format:\n<code>namespaces/<var>namespace</var></code>.", |
| 166 "location": "path", |
| 167 "pattern": "^namespaces/[^/]+$", |
| 168 "required": true, |
| 169 "type": "string" |
| 170 }, |
| 171 "projectId": { |
| 172 "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."
, |
| 173 "location": "query", |
| 174 "type": "string" |
| 175 } |
| 176 }, |
| 177 "path": "v1beta1/{+namespaceName}", |
| 178 "request": { |
| 179 "$ref": "Namespace" |
| 180 }, |
| 181 "response": { |
| 182 "$ref": "Namespace" |
| 183 }, |
| 184 "scopes": [ |
| 185 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 186 ] |
| 187 } |
| 188 } |
| 189 }, |
116 "v1beta1": { | 190 "v1beta1": { |
117 "methods": { | 191 "methods": { |
118 "getEidparams": { | 192 "getEidparams": { |
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.", | 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.", |
120 "httpMethod": "GET", | 194 "httpMethod": "GET", |
121 "id": "proximitybeacon.getEidparams", | 195 "id": "proximitybeacon.getEidparams", |
122 "parameterOrder": [], | 196 "parameterOrder": [], |
123 "parameters": {}, | 197 "parameters": {}, |
124 "path": "v1beta1/eidparams", | 198 "path": "v1beta1/eidparams", |
125 "response": { | 199 "response": { |
126 "$ref": "EphemeralIdRegistrationParams" | 200 "$ref": "EphemeralIdRegistrationParams" |
127 }, | 201 }, |
128 "scopes": [ | 202 "scopes": [ |
129 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 203 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
130 ] | 204 ] |
131 } | 205 } |
132 } | 206 } |
133 }, | 207 }, |
134 "beacons": { | 208 "beacons": { |
135 "methods": { | 209 "methods": { |
136 "delete": { | |
137 "description": "Deletes the specified beacon including all d
iagnostics data for the beacon\nas well as any attachments on the beacon (includ
ing those belonging to\nother projects). This operation cannot be undone.\n\nAut
henticate using an [OAuth access token](https://developers.google.com/identity/p
rotocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permis
sions in the\nGoogle Developers Console project.", | |
138 "httpMethod": "DELETE", | |
139 "id": "proximitybeacon.beacons.delete", | |
140 "parameterOrder": [ | |
141 "beaconName" | |
142 ], | |
143 "parameters": { | |
144 "projectId": { | |
145 "description": "The project id of the beacon to dele
te. If not provided, the project\nthat is making the request is used.\nOptional.
", | |
146 "location": "query", | |
147 "type": "string" | |
148 }, | |
149 "beaconName": { | |
150 "description": "Beacon that should be deleted. A bea
con name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16
ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible val
ues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\n
for AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or
the beacon's \"stable\" UID.\nRequired.", | |
151 "location": "path", | |
152 "pattern": "^beacons/[^/]+$", | |
153 "required": true, | |
154 "type": "string" | |
155 } | |
156 }, | |
157 "path": "v1beta1/{+beaconName}", | |
158 "response": { | |
159 "$ref": "Empty" | |
160 }, | |
161 "scopes": [ | |
162 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | |
163 ] | |
164 }, | |
165 "deactivate": { | 210 "deactivate": { |
166 "description": "Deactivates a beacon. Once deactivated, the
API will not return\ninformation nor attachment data for the beacon when queried
via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nb
eacon will do nothing (but will return a successful response code).\n\nAuthentic
ate using an [OAuth access token](https://developers.google.com/identity/protoco
ls/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions
in the\nGoogle Developers Console project.", | 211 "description": "Deactivates a beacon. Once deactivated, the
API will not return\ninformation nor attachment data for the beacon when queried
via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nb
eacon will do nothing (but will return a successful response code).\n\nAuthentic
ate using an [OAuth access token](https://developers.google.com/identity/protoco
ls/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions
in the\nGoogle Developers Console project.", |
167 "httpMethod": "POST", | 212 "httpMethod": "POST", |
168 "id": "proximitybeacon.beacons.deactivate", | 213 "id": "proximitybeacon.beacons.deactivate", |
169 "parameterOrder": [ | 214 "parameterOrder": [ |
170 "beaconName" | 215 "beaconName" |
171 ], | 216 ], |
172 "parameters": { | 217 "parameters": { |
173 "beaconName": { | 218 "beaconName": { |
174 "description": "Beacon that should be deactivated. A
beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the ba
se16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible
values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `
5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EI
D or the beacon's \"stable\" UID.\nRequired.", | 219 "description": "Beacon that should be deactivated. A
beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the ba
se16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible
values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `
5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EI
D or the beacon's \"stable\" UID.\nRequired.", |
175 "location": "path", | 220 "location": "path", |
176 "pattern": "^beacons/[^/]+$", | 221 "pattern": "^beacons/[^/]+$", |
177 "required": true, | 222 "required": true, |
178 "type": "string" | 223 "type": "string" |
179 }, | 224 }, |
180 "projectId": { | 225 "projectId": { |
181 "description": "The project id of the beacon to deac
tivate. If the project id is not\nspecified then the project making the request
is used. The project id must\nmatch the project that owns the beacon.\nOptional.
", | 226 "description": "The project id of the beacon to deac
tivate. If the project id is not\nspecified then the project making the request
is used. The project id must\nmatch the project that owns the beacon.\nOptional.
", |
182 "location": "query", | 227 "location": "query", |
183 "type": "string" | 228 "type": "string" |
184 } | 229 } |
185 }, | 230 }, |
186 "path": "v1beta1/{+beaconName}:deactivate", | 231 "path": "v1beta1/{+beaconName}:deactivate", |
187 "response": { | 232 "response": { |
188 "$ref": "Empty" | 233 "$ref": "Empty" |
189 }, | 234 }, |
190 "scopes": [ | 235 "scopes": [ |
191 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 236 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
192 ] | 237 ] |
193 }, | 238 }, |
194 "register": { | 239 "delete": { |
195 "description": "Registers a previously unregistered beacon g
iven its `advertisedId`.\nThese IDs are unique within the system. An ID can be r
egistered only once.\n\nAuthenticate using an [OAuth access token](https://devel
opers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is own
er** or **Can edit** permissions in the\nGoogle Developers Console project.", | 240 "description": "Deletes the specified beacon including all d
iagnostics data for the beacon\nas well as any attachments on the beacon (includ
ing those belonging to\nother projects). This operation cannot be undone.\n\nAut
henticate using an [OAuth access token](https://developers.google.com/identity/p
rotocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permis
sions in the\nGoogle Developers Console project.", |
196 "httpMethod": "POST", | 241 "httpMethod": "DELETE", |
197 "id": "proximitybeacon.beacons.register", | 242 "id": "proximitybeacon.beacons.delete", |
198 "parameterOrder": [], | 243 "parameterOrder": [ |
| 244 "beaconName" |
| 245 ], |
199 "parameters": { | 246 "parameters": { |
| 247 "beaconName": { |
| 248 "description": "Beacon that should be deleted. A bea
con name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16
ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible val
ues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\n
for AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or
the beacon's \"stable\" UID.\nRequired.", |
| 249 "location": "path", |
| 250 "pattern": "^beacons/[^/]+$", |
| 251 "required": true, |
| 252 "type": "string" |
| 253 }, |
200 "projectId": { | 254 "projectId": { |
201 "description": "The project id of the project the be
acon will be registered to. If\nthe project id is not specified then the project
making the request\nis used.\nOptional.", | 255 "description": "The project id of the beacon to dele
te. If not provided, the project\nthat is making the request is used.\nOptional.
", |
202 "location": "query", | 256 "location": "query", |
203 "type": "string" | 257 "type": "string" |
204 } | 258 } |
205 }, | 259 }, |
206 "path": "v1beta1/beacons:register", | 260 "path": "v1beta1/{+beaconName}", |
207 "request": { | |
208 "$ref": "Beacon" | |
209 }, | |
210 "response": { | 261 "response": { |
211 "$ref": "Beacon" | 262 "$ref": "Empty" |
212 }, | 263 }, |
213 "scopes": [ | 264 "scopes": [ |
214 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 265 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
215 ] | 266 ] |
216 }, | 267 }, |
217 "list": { | 268 "list": { |
218 "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.", | 269 "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.", |
219 "httpMethod": "GET", | 270 "httpMethod": "GET", |
220 "id": "proximitybeacon.beacons.list", | 271 "id": "proximitybeacon.beacons.list", |
221 "parameterOrder": [], | 272 "parameterOrder": [], |
(...skipping 21 matching lines...) Expand all Loading... |
243 } | 294 } |
244 }, | 295 }, |
245 "path": "v1beta1/beacons", | 296 "path": "v1beta1/beacons", |
246 "response": { | 297 "response": { |
247 "$ref": "ListBeaconsResponse" | 298 "$ref": "ListBeaconsResponse" |
248 }, | 299 }, |
249 "scopes": [ | 300 "scopes": [ |
250 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 301 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
251 ] | 302 ] |
252 }, | 303 }, |
| 304 "register": { |
| 305 "description": "Registers a previously unregistered beacon g
iven its `advertisedId`.\nThese IDs are unique within the system. An ID can be r
egistered only once.\n\nAuthenticate using an [OAuth access token](https://devel
opers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is own
er** or **Can edit** permissions in the\nGoogle Developers Console project.", |
| 306 "httpMethod": "POST", |
| 307 "id": "proximitybeacon.beacons.register", |
| 308 "parameterOrder": [], |
| 309 "parameters": { |
| 310 "projectId": { |
| 311 "description": "The project id of the project the be
acon will be registered to. If\nthe project id is not specified then the project
making the request\nis used.\nOptional.", |
| 312 "location": "query", |
| 313 "type": "string" |
| 314 } |
| 315 }, |
| 316 "path": "v1beta1/beacons:register", |
| 317 "request": { |
| 318 "$ref": "Beacon" |
| 319 }, |
| 320 "response": { |
| 321 "$ref": "Beacon" |
| 322 }, |
| 323 "scopes": [ |
| 324 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 325 ] |
| 326 }, |
253 "activate": { | 327 "activate": { |
254 "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.", | 328 "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.", |
255 "httpMethod": "POST", | 329 "httpMethod": "POST", |
256 "id": "proximitybeacon.beacons.activate", | 330 "id": "proximitybeacon.beacons.activate", |
257 "parameterOrder": [ | 331 "parameterOrder": [ |
258 "beaconName" | 332 "beaconName" |
259 ], | 333 ], |
260 "parameters": { | 334 "parameters": { |
| 335 "projectId": { |
| 336 "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.", |
| 337 "location": "query", |
| 338 "type": "string" |
| 339 }, |
261 "beaconName": { | 340 "beaconName": { |
262 "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.", | 341 "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.", |
263 "location": "path", | 342 "location": "path", |
264 "pattern": "^beacons/[^/]+$", | 343 "pattern": "^beacons/[^/]+$", |
265 "required": true, | 344 "required": true, |
266 "type": "string" | 345 "type": "string" |
267 }, | |
268 "projectId": { | |
269 "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.", | |
270 "location": "query", | |
271 "type": "string" | |
272 } | 346 } |
273 }, | 347 }, |
274 "path": "v1beta1/{+beaconName}:activate", | 348 "path": "v1beta1/{+beaconName}:activate", |
275 "response": { | 349 "response": { |
276 "$ref": "Empty" | 350 "$ref": "Empty" |
277 }, | 351 }, |
278 "scopes": [ | 352 "scopes": [ |
279 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 353 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
280 ] | 354 ] |
281 }, | 355 }, |
(...skipping 27 matching lines...) Expand all Loading... |
309 ] | 383 ] |
310 }, | 384 }, |
311 "update": { | 385 "update": { |
312 "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.", | 386 "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.", |
313 "httpMethod": "PUT", | 387 "httpMethod": "PUT", |
314 "id": "proximitybeacon.beacons.update", | 388 "id": "proximitybeacon.beacons.update", |
315 "parameterOrder": [ | 389 "parameterOrder": [ |
316 "beaconName" | 390 "beaconName" |
317 ], | 391 ], |
318 "parameters": { | 392 "parameters": { |
319 "projectId": { | |
320 "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.", | |
321 "location": "query", | |
322 "type": "string" | |
323 }, | |
324 "beaconName": { | 393 "beaconName": { |
325 "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.", | 394 "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.", |
326 "location": "path", | 395 "location": "path", |
327 "pattern": "^beacons/[^/]+$", | 396 "pattern": "^beacons/[^/]+$", |
328 "required": true, | 397 "required": true, |
329 "type": "string" | 398 "type": "string" |
| 399 }, |
| 400 "projectId": { |
| 401 "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.", |
| 402 "location": "query", |
| 403 "type": "string" |
330 } | 404 } |
331 }, | 405 }, |
332 "path": "v1beta1/{+beaconName}", | 406 "path": "v1beta1/{+beaconName}", |
333 "request": { | 407 "request": { |
334 "$ref": "Beacon" | 408 "$ref": "Beacon" |
335 }, | 409 }, |
336 "response": { | 410 "response": { |
337 "$ref": "Beacon" | 411 "$ref": "Beacon" |
338 }, | 412 }, |
339 "scopes": [ | 413 "scopes": [ |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
374 "diagnostics": { | 448 "diagnostics": { |
375 "methods": { | 449 "methods": { |
376 "list": { | 450 "list": { |
377 "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.", | 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.", |
378 "httpMethod": "GET", | 452 "httpMethod": "GET", |
379 "id": "proximitybeacon.beacons.diagnostics.list", | 453 "id": "proximitybeacon.beacons.diagnostics.list", |
380 "parameterOrder": [ | 454 "parameterOrder": [ |
381 "beaconName" | 455 "beaconName" |
382 ], | 456 ], |
383 "parameters": { | 457 "parameters": { |
| 458 "beaconName": { |
| 459 "description": "Beacon that the diagnostics
are for.", |
| 460 "location": "path", |
| 461 "pattern": "^beacons/[^/]+$", |
| 462 "required": true, |
| 463 "type": "string" |
| 464 }, |
| 465 "pageToken": { |
| 466 "description": "Requests results that occur
after the `page_token`, obtained from the\nresponse to a previous request. Optio
nal.", |
| 467 "location": "query", |
| 468 "type": "string" |
| 469 }, |
384 "pageSize": { | 470 "pageSize": { |
385 "description": "Specifies the maximum number
of results to return. Defaults to\n10. Maximum 1000. Optional.", | 471 "description": "Specifies the maximum number
of results to return. Defaults to\n10. Maximum 1000. Optional.", |
386 "format": "int32", | 472 "format": "int32", |
387 "location": "query", | 473 "location": "query", |
388 "type": "integer" | 474 "type": "integer" |
389 }, | 475 }, |
390 "alertFilter": { | 476 "alertFilter": { |
391 "description": "Requests only beacons that h
ave the given alert. For example, to find\nbeacons that have low batteries use `
alert_filter=LOW_BATTERY`.", | 477 "description": "Requests only beacons that h
ave the given alert. For example, to find\nbeacons that have low batteries use `
alert_filter=LOW_BATTERY`.", |
392 "enum": [ | 478 "enum": [ |
393 "ALERT_UNSPECIFIED", | 479 "ALERT_UNSPECIFIED", |
394 "WRONG_LOCATION", | 480 "WRONG_LOCATION", |
395 "LOW_BATTERY" | 481 "LOW_BATTERY" |
396 ], | 482 ], |
397 "location": "query", | 483 "location": "query", |
398 "type": "string" | 484 "type": "string" |
399 }, | 485 }, |
400 "projectId": { | 486 "projectId": { |
401 "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.", | 487 "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.", |
402 "location": "query", | 488 "location": "query", |
403 "type": "string" | 489 "type": "string" |
404 }, | |
405 "beaconName": { | |
406 "description": "Beacon that the diagnostics
are for.", | |
407 "location": "path", | |
408 "pattern": "^beacons/[^/]+$", | |
409 "required": true, | |
410 "type": "string" | |
411 }, | |
412 "pageToken": { | |
413 "description": "Requests results that occur
after the `page_token`, obtained from the\nresponse to a previous request. Optio
nal.", | |
414 "location": "query", | |
415 "type": "string" | |
416 } | 490 } |
417 }, | 491 }, |
418 "path": "v1beta1/{+beaconName}/diagnostics", | 492 "path": "v1beta1/{+beaconName}/diagnostics", |
419 "response": { | 493 "response": { |
420 "$ref": "ListDiagnosticsResponse" | 494 "$ref": "ListDiagnosticsResponse" |
421 }, | 495 }, |
422 "scopes": [ | 496 "scopes": [ |
423 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | 497 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
424 ] | 498 ] |
425 } | 499 } |
426 } | 500 } |
427 }, | 501 }, |
428 "attachments": { | 502 "attachments": { |
429 "methods": { | 503 "methods": { |
430 "delete": { | |
431 "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.", | |
432 "httpMethod": "DELETE", | |
433 "id": "proximitybeacon.beacons.attachments.delete", | |
434 "parameterOrder": [ | |
435 "attachmentName" | |
436 ], | |
437 "parameters": { | |
438 "projectId": { | |
439 "description": "The project id of the attach
ment to delete. If not provided, the project\nthat is making the request is used
.\nOptional.", | |
440 "location": "query", | |
441 "type": "string" | |
442 }, | |
443 "attachmentName": { | |
444 "description": "The attachment name (`attach
mentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/att
achments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon
ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\"
Eddystone-UID.\nRequired.", | |
445 "location": "path", | |
446 "pattern": "^beacons/[^/]+/attachments/[^/]+
$", | |
447 "required": true, | |
448 "type": "string" | |
449 } | |
450 }, | |
451 "path": "v1beta1/{+attachmentName}", | |
452 "response": { | |
453 "$ref": "Empty" | |
454 }, | |
455 "scopes": [ | |
456 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | |
457 ] | |
458 }, | |
459 "list": { | |
460 "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.", | |
461 "httpMethod": "GET", | |
462 "id": "proximitybeacon.beacons.attachments.list", | |
463 "parameterOrder": [ | |
464 "beaconName" | |
465 ], | |
466 "parameters": { | |
467 "namespacedType": { | |
468 "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\".", | |
469 "location": "query", | |
470 "type": "string" | |
471 }, | |
472 "beaconName": { | |
473 "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.", | |
474 "location": "path", | |
475 "pattern": "^beacons/[^/]+$", | |
476 "required": true, | |
477 "type": "string" | |
478 }, | |
479 "projectId": { | |
480 "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.", | |
481 "location": "query", | |
482 "type": "string" | |
483 } | |
484 }, | |
485 "path": "v1beta1/{+beaconName}/attachments", | |
486 "response": { | |
487 "$ref": "ListBeaconAttachmentsResponse" | |
488 }, | |
489 "scopes": [ | |
490 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | |
491 ] | |
492 }, | |
493 "create": { | 504 "create": { |
494 "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.", | 505 "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.", |
495 "httpMethod": "POST", | 506 "httpMethod": "POST", |
496 "id": "proximitybeacon.beacons.attachments.create", | 507 "id": "proximitybeacon.beacons.attachments.create", |
497 "parameterOrder": [ | 508 "parameterOrder": [ |
498 "beaconName" | 509 "beaconName" |
499 ], | 510 ], |
500 "parameters": { | 511 "parameters": { |
501 "beaconName": { | 512 "beaconName": { |
502 "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.", | 513 "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.", |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
547 "location": "query", | 558 "location": "query", |
548 "type": "string" | 559 "type": "string" |
549 } | 560 } |
550 }, | 561 }, |
551 "path": "v1beta1/{+beaconName}/attachments:batchDele
te", | 562 "path": "v1beta1/{+beaconName}/attachments:batchDele
te", |
552 "response": { | 563 "response": { |
553 "$ref": "DeleteAttachmentsResponse" | 564 "$ref": "DeleteAttachmentsResponse" |
554 }, | 565 }, |
555 "scopes": [ | 566 "scopes": [ |
556 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | 567 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 568 ] |
| 569 }, |
| 570 "delete": { |
| 571 "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.", |
| 572 "httpMethod": "DELETE", |
| 573 "id": "proximitybeacon.beacons.attachments.delete", |
| 574 "parameterOrder": [ |
| 575 "attachmentName" |
| 576 ], |
| 577 "parameters": { |
| 578 "projectId": { |
| 579 "description": "The project id of the attach
ment to delete. If not provided, the project\nthat is making the request is used
.\nOptional.", |
| 580 "location": "query", |
| 581 "type": "string" |
| 582 }, |
| 583 "attachmentName": { |
| 584 "description": "The attachment name (`attach
mentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/att
achments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon
ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\"
Eddystone-UID.\nRequired.", |
| 585 "location": "path", |
| 586 "pattern": "^beacons/[^/]+/attachments/[^/]+
$", |
| 587 "required": true, |
| 588 "type": "string" |
| 589 } |
| 590 }, |
| 591 "path": "v1beta1/{+attachmentName}", |
| 592 "response": { |
| 593 "$ref": "Empty" |
| 594 }, |
| 595 "scopes": [ |
| 596 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 597 ] |
| 598 }, |
| 599 "list": { |
| 600 "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.", |
| 601 "httpMethod": "GET", |
| 602 "id": "proximitybeacon.beacons.attachments.list", |
| 603 "parameterOrder": [ |
| 604 "beaconName" |
| 605 ], |
| 606 "parameters": { |
| 607 "projectId": { |
| 608 "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.", |
| 609 "location": "query", |
| 610 "type": "string" |
| 611 }, |
| 612 "namespacedType": { |
| 613 "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\".", |
| 614 "location": "query", |
| 615 "type": "string" |
| 616 }, |
| 617 "beaconName": { |
| 618 "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.", |
| 619 "location": "path", |
| 620 "pattern": "^beacons/[^/]+$", |
| 621 "required": true, |
| 622 "type": "string" |
| 623 } |
| 624 }, |
| 625 "path": "v1beta1/{+beaconName}/attachments", |
| 626 "response": { |
| 627 "$ref": "ListBeaconAttachmentsResponse" |
| 628 }, |
| 629 "scopes": [ |
| 630 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
557 ] | 631 ] |
558 } | 632 } |
559 } | 633 } |
560 } | 634 } |
561 } | 635 } |
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 } | |
635 } | |
636 } | 636 } |
637 }, | 637 }, |
638 "revision": "20170517", | 638 "revision": "20170606", |
639 "rootUrl": "https://proximitybeacon.googleapis.com/", | 639 "rootUrl": "https://proximitybeacon.googleapis.com/", |
640 "schemas": { | 640 "schemas": { |
641 "ListBeaconAttachmentsResponse": { | 641 "ListBeaconAttachmentsResponse": { |
642 "description": "Response to `ListBeaconAttachments` that contains th
e requested attachments.", | 642 "description": "Response to `ListBeaconAttachments` that contains th
e requested attachments.", |
643 "id": "ListBeaconAttachmentsResponse", | 643 "id": "ListBeaconAttachmentsResponse", |
644 "properties": { | 644 "properties": { |
645 "attachments": { | 645 "attachments": { |
646 "description": "The attachments that corresponded to the req
uest params.", | 646 "description": "The attachments that corresponded to the req
uest params.", |
647 "items": { | 647 "items": { |
648 "$ref": "BeaconAttachment" | 648 "$ref": "BeaconAttachment" |
649 }, | 649 }, |
650 "type": "array" | 650 "type": "array" |
651 } | 651 } |
652 }, | 652 }, |
653 "type": "object" | 653 "type": "object" |
654 }, | 654 }, |
655 "Namespace": { | 655 "Namespace": { |
656 "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.", | 656 "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.", |
657 "id": "Namespace", | 657 "id": "Namespace", |
658 "properties": { | 658 "properties": { |
| 659 "namespaceName": { |
| 660 "description": "Resource name of this namespace. Namespaces
names have the format:\n<code>namespaces/<var>namespace</var></code>.", |
| 661 "type": "string" |
| 662 }, |
659 "servingVisibility": { | 663 "servingVisibility": { |
660 "description": "Specifies what clients may receive attachmen
ts under this namespace\nvia `beaconinfo.getforobserved`.", | 664 "description": "Specifies what clients may receive attachmen
ts under this namespace\nvia `beaconinfo.getforobserved`.", |
661 "enum": [ | 665 "enum": [ |
662 "VISIBILITY_UNSPECIFIED", | 666 "VISIBILITY_UNSPECIFIED", |
663 "UNLISTED", | 667 "UNLISTED", |
664 "PUBLIC" | 668 "PUBLIC" |
665 ], | 669 ], |
666 "enumDescriptions": [ | 670 "enumDescriptions": [ |
667 "Do not use this value.", | 671 "Do not use this value.", |
668 "Served only to the project that owns the namespace.", | 672 "Served only to the project that owns the namespace.", |
669 "Any project can subscribe to attachments under the name
space." | 673 "Any project can subscribe to attachments under the name
space." |
670 ], | 674 ], |
671 "type": "string" | 675 "type": "string" |
672 }, | |
673 "namespaceName": { | |
674 "description": "Resource name of this namespace. Namespaces
names have the format:\n<code>namespaces/<var>namespace</var></code>.", | |
675 "type": "string" | |
676 } | 676 } |
677 }, | 677 }, |
678 "type": "object" | 678 "type": "object" |
679 }, | 679 }, |
680 "AttachmentInfo": { | 680 "AttachmentInfo": { |
681 "description": "A subset of attachment information served via the\n`
beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.
", | 681 "description": "A subset of attachment information served via the\n`
beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.
", |
682 "id": "AttachmentInfo", | 682 "id": "AttachmentInfo", |
683 "properties": { | 683 "properties": { |
684 "namespacedType": { | 684 "namespacedType": { |
685 "description": "Specifies what kind of attachment this is. T
ells a client how to\ninterpret the `data` field. Format is <var>namespace/type<
/var>, for\nexample <code>scrupulous-wombat-12345/welcome-message</code>", | 685 "description": "Specifies what kind of attachment this is. T
ells a client how to\ninterpret the `data` field. Format is <var>namespace/type<
/var>, for\nexample <code>scrupulous-wombat-12345/welcome-message</code>", |
686 "type": "string" | 686 "type": "string" |
687 }, | 687 }, |
688 "data": { | 688 "data": { |
689 "description": "An opaque data container for client-provided
data.", | 689 "description": "An opaque data container for client-provided
data.", |
690 "format": "byte", | 690 "format": "byte", |
691 "type": "string" | 691 "type": "string" |
692 } | 692 } |
693 }, | 693 }, |
694 "type": "object" | 694 "type": "object" |
695 }, | 695 }, |
696 "BeaconInfo": { | 696 "BeaconInfo": { |
697 "description": "A subset of beacon information served via the `beaco
ninfo.getforobserved`\nmethod, which you call when users of your app encounter y
our beacons.", | 697 "description": "A subset of beacon information served via the `beaco
ninfo.getforobserved`\nmethod, which you call when users of your app encounter y
our beacons.", |
698 "id": "BeaconInfo", | 698 "id": "BeaconInfo", |
699 "properties": { | 699 "properties": { |
700 "beaconName": { | |
701 "description": "The name under which the beacon is registere
d.", | |
702 "type": "string" | |
703 }, | |
704 "advertisedId": { | 700 "advertisedId": { |
705 "$ref": "AdvertisedId", | 701 "$ref": "AdvertisedId", |
706 "description": "The ID advertised by the beacon." | 702 "description": "The ID advertised by the beacon." |
707 }, | 703 }, |
708 "attachments": { | 704 "attachments": { |
709 "description": "Attachments matching the type(s) requested.\
nMay be empty if no attachment types were requested.", | 705 "description": "Attachments matching the type(s) requested.\
nMay be empty if no attachment types were requested.", |
710 "items": { | 706 "items": { |
711 "$ref": "AttachmentInfo" | 707 "$ref": "AttachmentInfo" |
712 }, | 708 }, |
713 "type": "array" | 709 "type": "array" |
| 710 }, |
| 711 "beaconName": { |
| 712 "description": "The name under which the beacon is registere
d.", |
| 713 "type": "string" |
714 } | 714 } |
715 }, | 715 }, |
716 "type": "object" | 716 "type": "object" |
| 717 }, |
| 718 "DeleteAttachmentsResponse": { |
| 719 "description": "Response for a request to delete attachments.", |
| 720 "id": "DeleteAttachmentsResponse", |
| 721 "properties": { |
| 722 "numDeleted": { |
| 723 "description": "The number of attachments that were deleted.
", |
| 724 "format": "int32", |
| 725 "type": "integer" |
| 726 } |
| 727 }, |
| 728 "type": "object" |
717 }, | 729 }, |
718 "EphemeralIdRegistrationParams": { | 730 "EphemeralIdRegistrationParams": { |
719 "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.", | 731 "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.", |
720 "id": "EphemeralIdRegistrationParams", | 732 "id": "EphemeralIdRegistrationParams", |
721 "properties": { | 733 "properties": { |
722 "minRotationPeriodExponent": { | 734 "minRotationPeriodExponent": { |
723 "description": "Indicates the minimum rotation period suppor
ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", | 735 "description": "Indicates the minimum rotation period suppor
ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", |
724 "format": "uint32", | 736 "format": "uint32", |
725 "type": "integer" | 737 "type": "integer" |
726 }, | 738 }, |
727 "maxRotationPeriodExponent": { | 739 "maxRotationPeriodExponent": { |
728 "description": "Indicates the maximum rotation period suppor
ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", | 740 "description": "Indicates the maximum rotation period suppor
ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", |
729 "format": "uint32", | 741 "format": "uint32", |
730 "type": "integer" | 742 "type": "integer" |
731 }, | 743 }, |
732 "serviceEcdhPublicKey": { | 744 "serviceEcdhPublicKey": { |
733 "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.", | 745 "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.", |
734 "format": "byte", | 746 "format": "byte", |
735 "type": "string" | 747 "type": "string" |
736 } | 748 } |
737 }, | 749 }, |
738 "type": "object" | 750 "type": "object" |
739 }, | 751 }, |
740 "DeleteAttachmentsResponse": { | |
741 "description": "Response for a request to delete attachments.", | |
742 "id": "DeleteAttachmentsResponse", | |
743 "properties": { | |
744 "numDeleted": { | |
745 "description": "The number of attachments that were deleted.
", | |
746 "format": "int32", | |
747 "type": "integer" | |
748 } | |
749 }, | |
750 "type": "object" | |
751 }, | |
752 "Observation": { | 752 "Observation": { |
753 "description": "Represents one beacon observed once.", | 753 "description": "Represents one beacon observed once.", |
754 "id": "Observation", | 754 "id": "Observation", |
755 "properties": { | 755 "properties": { |
756 "advertisedId": { | |
757 "$ref": "AdvertisedId", | |
758 "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." | |
759 }, | |
760 "telemetry": { | 756 "telemetry": { |
761 "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.", | 757 "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.", |
762 "format": "byte", | 758 "format": "byte", |
763 "type": "string" | 759 "type": "string" |
764 }, | 760 }, |
765 "timestampMs": { | 761 "timestampMs": { |
766 "description": "Time when the beacon was observed.", | 762 "description": "Time when the beacon was observed.", |
767 "format": "google-datetime", | 763 "format": "google-datetime", |
768 "type": "string" | 764 "type": "string" |
| 765 }, |
| 766 "advertisedId": { |
| 767 "$ref": "AdvertisedId", |
| 768 "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." |
769 } | 769 } |
770 }, | 770 }, |
771 "type": "object" | 771 "type": "object" |
772 }, | 772 }, |
773 "ListDiagnosticsResponse": { | 773 "ListDiagnosticsResponse": { |
774 "description": "Response that contains the requested diagnostics.", | 774 "description": "Response that contains the requested diagnostics.", |
775 "id": "ListDiagnosticsResponse", | 775 "id": "ListDiagnosticsResponse", |
776 "properties": { | 776 "properties": { |
777 "diagnostics": { | 777 "diagnostics": { |
778 "description": "The diagnostics matching the given request."
, | 778 "description": "The diagnostics matching the given request."
, |
(...skipping 20 matching lines...) Expand all Loading... |
799 }, | 799 }, |
800 "type": "array" | 800 "type": "array" |
801 } | 801 } |
802 }, | 802 }, |
803 "type": "object" | 803 "type": "object" |
804 }, | 804 }, |
805 "Beacon": { | 805 "Beacon": { |
806 "description": "Details of a beacon device.", | 806 "description": "Details of a beacon device.", |
807 "id": "Beacon", | 807 "id": "Beacon", |
808 "properties": { | 808 "properties": { |
809 "description": { | |
810 "description": "Free text used to identify and describe the
beacon. Maximum length 140\ncharacters.\nOptional.", | |
811 "type": "string" | |
812 }, | |
813 "placeId": { | |
814 "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.", | |
815 "type": "string" | |
816 }, | |
817 "latLng": { | |
818 "$ref": "LatLng", | |
819 "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." | |
820 }, | |
821 "properties": { | 809 "properties": { |
822 "additionalProperties": { | 810 "additionalProperties": { |
823 "type": "string" | 811 "type": "string" |
824 }, | 812 }, |
825 "description": "Properties of the beacon device, for example
battery type or firmware\nversion.\nOptional.", | 813 "description": "Properties of the beacon device, for example
battery type or firmware\nversion.\nOptional.", |
826 "type": "object" | 814 "type": "object" |
827 }, | 815 }, |
828 "status": { | 816 "status": { |
829 "description": "Current status of the beacon.\nRequired.", | 817 "description": "Current status of the beacon.\nRequired.", |
830 "enum": [ | 818 "enum": [ |
(...skipping 41 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
872 "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." | 860 "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." |
873 }, | 861 }, |
874 "ephemeralIdRegistration": { | 862 "ephemeralIdRegistration": { |
875 "$ref": "EphemeralIdRegistration", | 863 "$ref": "EphemeralIdRegistration", |
876 "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." | 864 "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." |
877 }, | 865 }, |
878 "provisioningKey": { | 866 "provisioningKey": { |
879 "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.", | 867 "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.", |
880 "format": "byte", | 868 "format": "byte", |
881 "type": "string" | 869 "type": "string" |
| 870 }, |
| 871 "description": { |
| 872 "description": "Free text used to identify and describe the
beacon. Maximum length 140\ncharacters.\nOptional.", |
| 873 "type": "string" |
| 874 }, |
| 875 "placeId": { |
| 876 "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.", |
| 877 "type": "string" |
| 878 }, |
| 879 "latLng": { |
| 880 "$ref": "LatLng", |
| 881 "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." |
882 } | 882 } |
883 }, | 883 }, |
884 "type": "object" | 884 "type": "object" |
885 }, | 885 }, |
886 "AdvertisedId": { | 886 "AdvertisedId": { |
887 "description": "Defines a unique identifier of a beacon as broadcast
by the device.", | 887 "description": "Defines a unique identifier of a beacon as broadcast
by the device.", |
888 "id": "AdvertisedId", | 888 "id": "AdvertisedId", |
889 "properties": { | 889 "properties": { |
890 "type": { | 890 "type": { |
891 "description": "Specifies the identifier type.\nRequired.", | 891 "description": "Specifies the identifier type.\nRequired.", |
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
953 "namespaces": { | 953 "namespaces": { |
954 "description": "The attachments that corresponded to the req
uest params.", | 954 "description": "The attachments that corresponded to the req
uest params.", |
955 "items": { | 955 "items": { |
956 "$ref": "Namespace" | 956 "$ref": "Namespace" |
957 }, | 957 }, |
958 "type": "array" | 958 "type": "array" |
959 } | 959 } |
960 }, | 960 }, |
961 "type": "object" | 961 "type": "object" |
962 }, | 962 }, |
963 "ListBeaconsResponse": { | |
964 "description": "Response that contains list beacon results and pagin
ation help.", | |
965 "id": "ListBeaconsResponse", | |
966 "properties": { | |
967 "nextPageToken": { | |
968 "description": "An opaque pagination token that the client m
ay provide in their next\nrequest to retrieve the next page of results.", | |
969 "type": "string" | |
970 }, | |
971 "beacons": { | |
972 "description": "The beacons that matched the search criteria
.", | |
973 "items": { | |
974 "$ref": "Beacon" | |
975 }, | |
976 "type": "array" | |
977 }, | |
978 "totalCount": { | |
979 "description": "Estimate of the total number of beacons matc
hed by the query. Higher\nvalues may be less accurate.", | |
980 "format": "int64", | |
981 "type": "string" | |
982 } | |
983 }, | |
984 "type": "object" | |
985 }, | |
986 "Diagnostics": { | 963 "Diagnostics": { |
987 "description": "Diagnostics for a single beacon.", | 964 "description": "Diagnostics for a single beacon.", |
988 "id": "Diagnostics", | 965 "id": "Diagnostics", |
989 "properties": { | 966 "properties": { |
990 "beaconName": { | 967 "beaconName": { |
991 "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.", | 968 "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.", |
992 "type": "string" | 969 "type": "string" |
993 }, | 970 }, |
994 "alerts": { | 971 "alerts": { |
995 "description": "An unordered list of Alerts that the beacon
has.", | 972 "description": "An unordered list of Alerts that the beacon
has.", |
(...skipping 12 matching lines...) Expand all Loading... |
1008 }, | 985 }, |
1009 "type": "array" | 986 "type": "array" |
1010 }, | 987 }, |
1011 "estimatedLowBatteryDate": { | 988 "estimatedLowBatteryDate": { |
1012 "$ref": "Date", | 989 "$ref": "Date", |
1013 "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." | 990 "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." |
1014 } | 991 } |
1015 }, | 992 }, |
1016 "type": "object" | 993 "type": "object" |
1017 }, | 994 }, |
| 995 "ListBeaconsResponse": { |
| 996 "description": "Response that contains list beacon results and pagin
ation help.", |
| 997 "id": "ListBeaconsResponse", |
| 998 "properties": { |
| 999 "nextPageToken": { |
| 1000 "description": "An opaque pagination token that the client m
ay provide in their next\nrequest to retrieve the next page of results.", |
| 1001 "type": "string" |
| 1002 }, |
| 1003 "beacons": { |
| 1004 "description": "The beacons that matched the search criteria
.", |
| 1005 "items": { |
| 1006 "$ref": "Beacon" |
| 1007 }, |
| 1008 "type": "array" |
| 1009 }, |
| 1010 "totalCount": { |
| 1011 "description": "Estimate of the total number of beacons matc
hed by the query. Higher\nvalues may be less accurate.", |
| 1012 "format": "int64", |
| 1013 "type": "string" |
| 1014 } |
| 1015 }, |
| 1016 "type": "object" |
| 1017 }, |
| 1018 "Empty": { |
| 1019 "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 `{}`.", |
| 1020 "id": "Empty", |
| 1021 "properties": {}, |
| 1022 "type": "object" |
| 1023 }, |
1018 "GetInfoForObservedBeaconsRequest": { | 1024 "GetInfoForObservedBeaconsRequest": { |
1019 "description": "Request for beacon and attachment information about
beacons that\na mobile client has encountered \"in the wild\".", | 1025 "description": "Request for beacon and attachment information about
beacons that\na mobile client has encountered \"in the wild\".", |
1020 "id": "GetInfoForObservedBeaconsRequest", | 1026 "id": "GetInfoForObservedBeaconsRequest", |
1021 "properties": { | 1027 "properties": { |
1022 "observations": { | 1028 "observations": { |
1023 "description": "The beacons that the client has encountered.
\nAt least one must be given.", | 1029 "description": "The beacons that the client has encountered.
\nAt least one must be given.", |
1024 "items": { | 1030 "items": { |
1025 "$ref": "Observation" | 1031 "$ref": "Observation" |
1026 }, | 1032 }, |
1027 "type": "array" | 1033 "type": "array" |
1028 }, | 1034 }, |
1029 "namespacedTypes": { | 1035 "namespacedTypes": { |
1030 "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.", | 1036 "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.", |
1031 "items": { | 1037 "items": { |
1032 "type": "string" | 1038 "type": "string" |
1033 }, | 1039 }, |
1034 "type": "array" | 1040 "type": "array" |
1035 } | 1041 } |
1036 }, | 1042 }, |
1037 "type": "object" | 1043 "type": "object" |
1038 }, | 1044 }, |
1039 "Empty": { | |
1040 "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 `{}`.", | |
1041 "id": "Empty", | |
1042 "properties": {}, | |
1043 "type": "object" | |
1044 }, | |
1045 "BeaconAttachment": { | 1045 "BeaconAttachment": { |
1046 "description": "Project-specific data associated with a beacon.", | 1046 "description": "Project-specific data associated with a beacon.", |
1047 "id": "BeaconAttachment", | 1047 "id": "BeaconAttachment", |
1048 "properties": { | 1048 "properties": { |
1049 "creationTimeMs": { | |
1050 "description": "The UTC time when this attachment was create
d, in milliseconds since the\nUNIX epoch.", | |
1051 "format": "google-datetime", | |
1052 "type": "string" | |
1053 }, | |
1054 "attachmentName": { | |
1055 "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.", | |
1056 "type": "string" | |
1057 }, | |
1058 "namespacedType": { | 1049 "namespacedType": { |
1059 "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."
, | 1050 "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."
, |
1060 "type": "string" | 1051 "type": "string" |
1061 }, | 1052 }, |
1062 "data": { | 1053 "data": { |
1063 "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.
", | 1054 "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.
", |
1064 "format": "byte", | 1055 "format": "byte", |
1065 "type": "string" | 1056 "type": "string" |
| 1057 }, |
| 1058 "creationTimeMs": { |
| 1059 "description": "The UTC time when this attachment was create
d, in milliseconds since the\nUNIX epoch.", |
| 1060 "format": "google-datetime", |
| 1061 "type": "string" |
| 1062 }, |
| 1063 "attachmentName": { |
| 1064 "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.", |
| 1065 "type": "string" |
1066 } | 1066 } |
1067 }, | 1067 }, |
1068 "type": "object" | 1068 "type": "object" |
1069 }, | 1069 }, |
1070 "EphemeralIdRegistration": { | 1070 "EphemeralIdRegistration": { |
1071 "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.", | 1071 "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.", |
1072 "id": "EphemeralIdRegistration", | 1072 "id": "EphemeralIdRegistration", |
1073 "properties": { | 1073 "properties": { |
| 1074 "initialClockValue": { |
| 1075 "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.", |
| 1076 "format": "uint64", |
| 1077 "type": "string" |
| 1078 }, |
| 1079 "beaconEcdhPublicKey": { |
| 1080 "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.", |
| 1081 "format": "byte", |
| 1082 "type": "string" |
| 1083 }, |
1074 "rotationPeriodExponent": { | 1084 "rotationPeriodExponent": { |
1075 "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.", | 1085 "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.", |
1076 "format": "uint32", | 1086 "format": "uint32", |
1077 "type": "integer" | 1087 "type": "integer" |
1078 }, | 1088 }, |
1079 "serviceEcdhPublicKey": { | 1089 "serviceEcdhPublicKey": { |
1080 "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.", | 1090 "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.", |
1081 "format": "byte", | 1091 "format": "byte", |
1082 "type": "string" | 1092 "type": "string" |
1083 }, | 1093 }, |
1084 "beaconIdentityKey": { | 1094 "beaconIdentityKey": { |
1085 "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.", | 1095 "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.", |
1086 "format": "byte", | 1096 "format": "byte", |
1087 "type": "string" | 1097 "type": "string" |
1088 }, | 1098 }, |
1089 "initialEid": { | 1099 "initialEid": { |
1090 "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.", | 1100 "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.", |
1091 "format": "byte", | 1101 "format": "byte", |
1092 "type": "string" | 1102 "type": "string" |
1093 }, | |
1094 "initialClockValue": { | |
1095 "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.", | |
1096 "format": "uint64", | |
1097 "type": "string" | |
1098 }, | |
1099 "beaconEcdhPublicKey": { | |
1100 "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.", | |
1101 "format": "byte", | |
1102 "type": "string" | |
1103 } | 1103 } |
1104 }, | 1104 }, |
1105 "type": "object" | 1105 "type": "object" |
1106 }, | 1106 }, |
1107 "LatLng": { | 1107 "LatLng": { |
1108 "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)", | 1108 "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)", |
1109 "id": "LatLng", | 1109 "id": "LatLng", |
1110 "properties": { | 1110 "properties": { |
1111 "latitude": { | 1111 "latitude": { |
1112 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", | 1112 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", |
1113 "format": "double", | 1113 "format": "double", |
1114 "type": "number" | 1114 "type": "number" |
1115 }, | 1115 }, |
1116 "longitude": { | 1116 "longitude": { |
1117 "description": "The longitude in degrees. It must be in the
range [-180.0, +180.0].", | 1117 "description": "The longitude in degrees. It must be in the
range [-180.0, +180.0].", |
1118 "format": "double", | 1118 "format": "double", |
1119 "type": "number" | 1119 "type": "number" |
1120 } | 1120 } |
1121 }, | 1121 }, |
1122 "type": "object" | 1122 "type": "object" |
1123 } | 1123 } |
1124 }, | 1124 }, |
1125 "servicePath": "", | 1125 "servicePath": "", |
1126 "title": "Google Proximity Beacon API", | 1126 "title": "Google Proximity Beacon API", |
1127 "version": "v1beta1" | 1127 "version": "v1beta1" |
1128 } | 1128 } |
OLD | NEW |