| 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 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/InJfaYgEs4kvxVpfe1cZDPrjhv0\"", | |
| 18 "icons": { | 17 "icons": { |
| 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 18 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 19 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 21 }, | 20 }, |
| 22 "id": "proximitybeacon:v1beta1", | 21 "id": "proximitybeacon:v1beta1", |
| 23 "kind": "discovery#restDescription", | 22 "kind": "discovery#restDescription", |
| 24 "name": "proximitybeacon", | 23 "name": "proximitybeacon", |
| 25 "ownerDomain": "google.com", | 24 "ownerDomain": "google.com", |
| 26 "ownerName": "Google", | 25 "ownerName": "Google", |
| 27 "parameters": { | 26 "parameters": { |
| 28 "access_token": { | 27 "upload_protocol": { |
| 29 "description": "OAuth access token.", | 28 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 30 "location": "query", | 29 "location": "query", |
| 31 "type": "string" | 30 "type": "string" |
| 32 }, | 31 }, |
| 33 "alt": { | 32 "prettyPrint": { |
| 34 "default": "json", | 33 "default": "true", |
| 35 "description": "Data format for response.", | 34 "description": "Returns response with indentations and line breaks."
, |
| 36 "enumDescriptions": [ | 35 "location": "query", |
| 37 "Responses with Content-Type of application/json", | 36 "type": "boolean" |
| 38 "Media download with context-dependent Content-Type", | 37 }, |
| 39 "Responses with Content-Type of application/x-protobuf" | 38 "fields": { |
| 40 ], | 39 "description": "Selector specifying which fields to include in a par
tial response.", |
| 41 "location": "query", | 40 "location": "query", |
| 42 "type": "string" | 41 "type": "string" |
| 43 }, | 42 }, |
| 44 "bearer_token": { | 43 "uploadType": { |
| 45 "description": "OAuth bearer token.", | 44 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 46 "location": "query", | 45 "location": "query", |
| 47 "type": "string" | 46 "type": "string" |
| 48 }, | 47 }, |
| 49 "callback": { | 48 "callback": { |
| 50 "description": "JSONP", | 49 "description": "JSONP", |
| 51 "location": "query", | 50 "location": "query", |
| 52 "type": "string" | 51 "type": "string" |
| 53 }, | 52 }, |
| 54 "fields": { | 53 "$.xgafv": { |
| 55 "description": "Selector specifying which fields to include in a par
tial response.", | 54 "description": "V1 error format.", |
| 55 "enum": [ |
| 56 "1", |
| 57 "2" |
| 58 ], |
| 59 "enumDescriptions": [ |
| 60 "v1 error format", |
| 61 "v2 error format" |
| 62 ], |
| 63 "location": "query", |
| 64 "type": "string" |
| 65 }, |
| 66 "alt": { |
| 67 "default": "json", |
| 68 "description": "Data format for response.", |
| 69 "enum": [ |
| 70 "json", |
| 71 "media", |
| 72 "proto" |
| 73 ], |
| 74 "enumDescriptions": [ |
| 75 "Responses with Content-Type of application/json", |
| 76 "Media download with context-dependent Content-Type", |
| 77 "Responses with Content-Type of application/x-protobuf" |
| 78 ], |
| 56 "location": "query", | 79 "location": "query", |
| 57 "type": "string" | 80 "type": "string" |
| 58 }, | 81 }, |
| 59 "key": { | 82 "key": { |
| 60 "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.", | 83 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 61 "location": "query", | 84 "location": "query", |
| 62 "type": "string" | 85 "type": "string" |
| 63 }, | 86 }, |
| 64 "oauth_token": { | 87 "access_token": { |
| 65 "description": "OAuth 2.0 token for the current user.", | 88 "description": "OAuth access token.", |
| 89 "location": "query", |
| 90 "type": "string" |
| 91 }, |
| 92 "quotaUser": { |
| 93 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 66 "location": "query", | 94 "location": "query", |
| 67 "type": "string" | 95 "type": "string" |
| 68 }, | 96 }, |
| 69 "pp": { | 97 "pp": { |
| 70 "default": "true", | 98 "default": "true", |
| 71 "description": "Pretty-print response.", | 99 "description": "Pretty-print response.", |
| 72 "location": "query", | 100 "location": "query", |
| 73 "type": "boolean" | 101 "type": "boolean" |
| 74 }, | 102 }, |
| 75 "prettyPrint": { | 103 "bearer_token": { |
| 76 "default": "true", | 104 "description": "OAuth bearer token.", |
| 77 "description": "Returns response with indentations and line breaks."
, | 105 "location": "query", |
| 78 "location": "query", | 106 "type": "string" |
| 79 "type": "boolean" | 107 }, |
| 80 }, | 108 "oauth_token": { |
| 81 "quotaUser": { | 109 "description": "OAuth 2.0 token for the current user.", |
| 82 "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.", | |
| 83 "location": "query", | |
| 84 "type": "string" | |
| 85 }, | |
| 86 "upload_protocol": { | |
| 87 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
| 88 "location": "query", | |
| 89 "type": "string" | |
| 90 }, | |
| 91 "uploadType": { | |
| 92 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
| 93 "location": "query", | |
| 94 "type": "string" | |
| 95 }, | |
| 96 "$.xgafv": { | |
| 97 "description": "V1 error format.", | |
| 98 "enumDescriptions": [ | |
| 99 "v1 error format", | |
| 100 "v2 error format" | |
| 101 ], | |
| 102 "location": "query", | 110 "location": "query", |
| 103 "type": "string" | 111 "type": "string" |
| 104 } | 112 } |
| 105 }, | 113 }, |
| 106 "protocol": "rest", | 114 "protocol": "rest", |
| 107 "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/how
-tos/authorizing#APIKey)\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 }, |
| 190 "v1beta1": { |
| 191 "methods": { |
| 192 "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.", |
| 194 "httpMethod": "GET", |
| 195 "id": "proximitybeacon.getEidparams", |
| 196 "parameterOrder": [], |
| 197 "parameters": {}, |
| 198 "path": "v1beta1/eidparams", |
| 199 "response": { |
| 200 "$ref": "EphemeralIdRegistrationParams" |
| 201 }, |
| 202 "scopes": [ |
| 203 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 204 ] |
| 205 } |
| 206 } |
| 207 }, |
| 108 "beacons": { | 208 "beacons": { |
| 109 "methods": { | 209 "methods": { |
| 110 "register": { | 210 "activate": { |
| 111 "description": "Registers a previously unregistered beacon g
iven its `advertisedId`. These IDs are unique within the system. An ID can be re
gistered only once. Authenticate using an [OAuth access token](https://developer
s.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner**
or **Can edit** permissions in the Google Developers Console project.", | 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.", |
| 112 "httpMethod": "POST", | 212 "httpMethod": "POST", |
| 113 "id": "proximitybeacon.beacons.register", | 213 "id": "proximitybeacon.beacons.activate", |
| 114 "parameters": { | |
| 115 "projectId": { | |
| 116 "description": "The project id of the project the be
acon will be registered to. If the project id is not specified then the project
making the request is used. Optional.", | |
| 117 "location": "query", | |
| 118 "type": "string" | |
| 119 } | |
| 120 }, | |
| 121 "path": "v1beta1/beacons:register", | |
| 122 "request": { | |
| 123 "$ref": "Beacon" | |
| 124 }, | |
| 125 "response": { | |
| 126 "$ref": "Beacon" | |
| 127 }, | |
| 128 "scopes": [ | |
| 129 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | |
| 130 ] | |
| 131 }, | |
| 132 "decommission": { | |
| 133 "description": "Decommissions the specified beacon in the se
rvice. This beacon will no longer be returned from `beaconinfo.getforobserved`.
This operation is permanent -- you will not be able to re-register a beacon with
this ID again. Authenticate using an [OAuth access token](https://developers.go
ogle.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or *
*Can edit** permissions in the Google Developers Console project.", | |
| 134 "httpMethod": "POST", | |
| 135 "id": "proximitybeacon.beacons.decommission", | |
| 136 "parameterOrder": [ | 214 "parameterOrder": [ |
| 137 "beaconName" | 215 "beaconName" |
| 138 ], | 216 ], |
| 139 "parameters": { | 217 "parameters": { |
| 140 "beaconName": { | 218 "beaconName": { |
| 141 "description": "Beacon that should be decommissioned
. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the
base16 ID broadcast by the beacon and N is a code for the beacon's type. Possibl
e values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `
5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID
of the beacon's \"stable\" UID. Required.", | 219 "description": "Beacon that should be activated. A b
eacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base
16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible v
alues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID
or the beacon's \"stable\" UID.\nRequired.", |
| 142 "location": "path", | 220 "location": "path", |
| 143 "pattern": "^beacons/[^/]*$", | 221 "pattern": "^beacons/[^/]+$", |
| 144 "required": true, | 222 "required": true, |
| 145 "type": "string" | 223 "type": "string" |
| 146 }, | 224 }, |
| 147 "projectId": { | 225 "projectId": { |
| 148 "description": "The project id of the beacon to deco
mmission. If the project id is not specified then the project making the request
is used. The project id must match the project that owns the beacon. Optional."
, | 226 "description": "The project id of the beacon to acti
vate. If the project id is not\nspecified then the project making the request is
used. The project id\nmust match the project that owns the beacon.\nOptional.", |
| 149 "location": "query", | 227 "location": "query", |
| 150 "type": "string" | 228 "type": "string" |
| 151 } | 229 } |
| 152 }, | 230 }, |
| 153 "path": "v1beta1/{+beaconName}:decommission", | 231 "path": "v1beta1/{+beaconName}:activate", |
| 154 "response": { | 232 "response": { |
| 155 "$ref": "Empty" | 233 "$ref": "Empty" |
| 156 }, | 234 }, |
| 157 "scopes": [ | 235 "scopes": [ |
| 158 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 236 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 159 ] | 237 ] |
| 160 }, | 238 }, |
| 161 "get": { | 239 "get": { |
| 162 "description": "Returns detailed information about the speci
fied beacon. Authenticate using an [OAuth access token](https://developers.googl
e.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is own
er** or **Can edit** permissions in the Google Developers Console project. Reque
sts may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` wh
ere the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The retur
ned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not
authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receiv
e an error.", | 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.", |
| 163 "httpMethod": "GET", | 241 "httpMethod": "GET", |
| 164 "id": "proximitybeacon.beacons.get", | 242 "id": "proximitybeacon.beacons.get", |
| 165 "parameterOrder": [ | 243 "parameterOrder": [ |
| 166 "beaconName" | 244 "beaconName" |
| 167 ], | 245 ], |
| 168 "parameters": { | 246 "parameters": { |
| 247 "projectId": { |
| 248 "description": "The project id of the beacon to requ
est. If the project id is not specified\nthen the project making the request is
used. The project id must match the\nproject that owns the beacon.\nOptional.", |
| 249 "location": "query", |
| 250 "type": "string" |
| 251 }, |
| 169 "beaconName": { | 252 "beaconName": { |
| 170 "description": "Resource name of this beacon. A beac
on name has the format \"beacons/N!beaconId\" where the beaconId is the base16 I
D broadcast by the beacon and N is a code for the beacon's type. Possible values
are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for A
ltBeacon. For Eddystone-EID beacons, you may use either the current EID or the b
eacon's \"stable\" UID. Required.", | 253 "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.", |
| 171 "location": "path", | 254 "location": "path", |
| 172 "pattern": "^beacons/[^/]*$", | 255 "pattern": "^beacons/[^/]+$", |
| 173 "required": true, | 256 "required": true, |
| 174 "type": "string" | 257 "type": "string" |
| 175 }, | |
| 176 "projectId": { | |
| 177 "description": "The project id of the beacon to requ
est. If the project id is not specified then the project making the request is u
sed. The project id must match the project that owns the beacon. Optional.", | |
| 178 "location": "query", | |
| 179 "type": "string" | |
| 180 } | 258 } |
| 181 }, | 259 }, |
| 182 "path": "v1beta1/{+beaconName}", | 260 "path": "v1beta1/{+beaconName}", |
| 183 "response": { | 261 "response": { |
| 184 "$ref": "Beacon" | 262 "$ref": "Beacon" |
| 185 }, | 263 }, |
| 186 "scopes": [ | 264 "scopes": [ |
| 187 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 265 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 188 ] | 266 ] |
| 189 }, | 267 }, |
| 190 "list": { | |
| 191 "description": "Searches the beacon registry for beacons tha
t match the given search criteria. Only those beacons that the client has permis
sion to list will be returned. Authenticate using an [OAuth access token](https:
//developers.google.com/identity/protocols/OAuth2) from a signed-in user with **
viewer**, **Is owner** or **Can edit** permissions in the Google Developers Cons
ole project.", | |
| 192 "httpMethod": "GET", | |
| 193 "id": "proximitybeacon.beacons.list", | |
| 194 "parameters": { | |
| 195 "q": { | |
| 196 "description": "Filter query string that supports th
e following field filters: * `description:\"\"` For example: `description:\"Room
3\"` Returns beacons whose description matches tokens in the string \"Room 3\"
(not necessarily that exact string). The string must be double-quoted. * `status
:` For example: `status:active` Returns beacons whose status matches the given v
alue. Values must be one of the Beacon.Status enum values (case insensitive). Ac
cepts multiple filters which will be combined with OR logic. * `stability:` For
example: `stability:mobile` Returns beacons whose expected stability matches the
given value. Values must be one of the Beacon.Stability enum values (case insen
sitive). Accepts multiple filters which will be combined with OR logic. * `place
_id:\"\"` For example: `place_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"` Returns beaco
ns explicitly registered at the given place, expressed as a Place ID obtained fr
om [Google Places API](/places/place-id). Does not match places inside the given
place. Does not consider the beacon's actual location (which may be different f
rom its registered place). Accepts multiple filters that will be combined with O
R logic. The place ID must be double-quoted. * `registration_time[|=]` For examp
le: `registration_time>=1433116800` Returns beacons whose registration time matc
hes the given filter. Supports the operators: , =. Timestamp must be expressed a
s an integer number of seconds since midnight January 1, 1970 UTC. Accepts at mo
st two filters that will be combined with AND logic, to support \"between\" sema
ntics. If more than two are supplied, the latter ones are ignored. * `lat: lng:
radius:` For example: `lat:51.1232343 lng:-1.093852 radius:1000` Returns beacons
whose registered location is within the given circle. When any of these fields
are given, all are required. Latitude and longitude must be decimal degrees betw
een -90.0 and 90.0 and between -180.0 and 180.0 respectively. Radius must be an
integer number of meters between 10 and 1,000,000 (1000 km). * `property:\"=\"`
For example: `property:\"battery-type=CR2032\"` Returns beacons which have a pro
perty of the given name and value. Supports multiple filters which will be combi
ned with OR logic. The entire name=value string must be double-quoted as one str
ing. * `attachment_type:\"\"` For example: `attachment_type:\"my-namespace/my-ty
pe\"` Returns beacons having at least one attachment of the given namespaced typ
e. Supports \"any within this namespace\" via the partial wildcard syntax: \"my-
namespace/*\". Supports multiple filters which will be combined with OR logic. T
he string must be double-quoted. Multiple filters on the same field are combined
with OR logic (except registration_time which is combined with AND logic). Mult
iple filters on different fields are combined with AND logic. Filters should be
separated by spaces. As with any HTTP query string parameter, the whole filter e
xpression must be URL-encoded. Example REST request: `GET /v1beta1/beacons?q=sta
tus:active%20lat:51.123%20lng:-1.095%20radius:1000`", | |
| 197 "location": "query", | |
| 198 "type": "string" | |
| 199 }, | |
| 200 "pageToken": { | |
| 201 "description": "A pagination token obtained from a p
revious request to list beacons.", | |
| 202 "location": "query", | |
| 203 "type": "string" | |
| 204 }, | |
| 205 "pageSize": { | |
| 206 "description": "The maximum number of records to ret
urn for this request, up to a server-defined upper limit.", | |
| 207 "format": "int32", | |
| 208 "location": "query", | |
| 209 "type": "integer" | |
| 210 }, | |
| 211 "projectId": { | |
| 212 "description": "The project id to list beacons under
. If not present then the project credential that made the request is used as th
e project. Optional.", | |
| 213 "location": "query", | |
| 214 "type": "string" | |
| 215 } | |
| 216 }, | |
| 217 "path": "v1beta1/beacons", | |
| 218 "response": { | |
| 219 "$ref": "ListBeaconsResponse" | |
| 220 }, | |
| 221 "scopes": [ | |
| 222 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | |
| 223 ] | |
| 224 }, | |
| 225 "update": { | 268 "update": { |
| 226 "description": "Updates the information about the specified
beacon. **Any field that you do not populate in the submitted beacon will be per
manently erased**, so you should follow the \"read, modify, write\" pattern to a
void inadvertently destroying data. Changes to the beacon status via this method
will be silently ignored. To update beacon status, use the separate methods on
this API for activation, deactivation, and decommissioning. Authenticate using a
n [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
from a signed-in user with **Is owner** or **Can edit** permissions in the Googl
e Developers Console project.", | 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.", |
| 227 "httpMethod": "PUT", | 270 "httpMethod": "PUT", |
| 228 "id": "proximitybeacon.beacons.update", | 271 "id": "proximitybeacon.beacons.update", |
| 229 "parameterOrder": [ | 272 "parameterOrder": [ |
| 230 "beaconName" | 273 "beaconName" |
| 231 ], | 274 ], |
| 232 "parameters": { | 275 "parameters": { |
| 233 "beaconName": { | 276 "beaconName": { |
| 234 "description": "Resource name of this beacon. A beac
on name has the format \"beacons/N!beaconId\" where the beaconId is the base16 I
D broadcast by the beacon and N is a code for the beacon's type. Possible values
are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must b
e left empty when registering. After reading a beacon, clients can use the name
for future operations.", | 277 "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.", |
| 235 "location": "path", | 278 "location": "path", |
| 236 "pattern": "^beacons/[^/]*$", | 279 "pattern": "^beacons/[^/]+$", |
| 237 "required": true, | 280 "required": true, |
| 238 "type": "string" | 281 "type": "string" |
| 239 }, | 282 }, |
| 240 "projectId": { | 283 "projectId": { |
| 241 "description": "The project id of the beacon to upda
te. If the project id is not specified then the project making the request is us
ed. The project id must match the project that owns the beacon. Optional.", | 284 "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.", |
| 242 "location": "query", | 285 "location": "query", |
| 243 "type": "string" | 286 "type": "string" |
| 244 } | 287 } |
| 245 }, | 288 }, |
| 246 "path": "v1beta1/{+beaconName}", | 289 "path": "v1beta1/{+beaconName}", |
| 247 "request": { | 290 "request": { |
| 248 "$ref": "Beacon" | 291 "$ref": "Beacon" |
| 249 }, | 292 }, |
| 250 "response": { | 293 "response": { |
| 251 "$ref": "Beacon" | 294 "$ref": "Beacon" |
| 252 }, | 295 }, |
| 253 "scopes": [ | 296 "scopes": [ |
| 254 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 297 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 255 ] | 298 ] |
| 256 }, | 299 }, |
| 257 "activate": { | 300 "decommission": { |
| 258 "description": "Activates a beacon. A beacon that is active
will return information and attachment data when queried via `beaconinfo.getforo
bserved`. Calling this method on an already active beacon will do nothing (but w
ill return a successful response code). Authenticate using an [OAuth access toke
n](https://developers.google.com/identity/protocols/OAuth2) from a signed-in use
r with **Is owner** or **Can edit** permissions in the Google Developers Console
project.", | 301 "description": "Decommissions the specified beacon in the se
rvice. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`.
This operation is\npermanent -- you will not be able to re-register a beacon wi
th this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://develop
ers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner
** or **Can edit** permissions in the\nGoogle Developers Console project.", |
| 259 "httpMethod": "POST", | 302 "httpMethod": "POST", |
| 260 "id": "proximitybeacon.beacons.activate", | 303 "id": "proximitybeacon.beacons.decommission", |
| 261 "parameterOrder": [ | 304 "parameterOrder": [ |
| 262 "beaconName" | 305 "beaconName" |
| 263 ], | 306 ], |
| 264 "parameters": { | 307 "parameters": { |
| 265 "beaconName": { | 308 "beaconName": { |
| 266 "description": "Beacon that should be activated. A b
eacon name has the format \"beacons/N!beaconId\" where the beaconId is the base1
6 ID broadcast by the beacon and N is a code for the beacon's type. Possible val
ues are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` fo
r AltBeacon. For Eddystone-EID beacons, you may use either the current EID or th
e beacon's \"stable\" UID. Required.", | 309 "description": "Beacon that should be decommissioned
. A beacon 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. Possi
ble values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, o
r `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent
EID of the beacon's \"stable\" UID.\nRequired.", |
| 267 "location": "path", | 310 "location": "path", |
| 268 "pattern": "^beacons/[^/]*$", | 311 "pattern": "^beacons/[^/]+$", |
| 269 "required": true, | 312 "required": true, |
| 270 "type": "string" | 313 "type": "string" |
| 271 }, | 314 }, |
| 272 "projectId": { | 315 "projectId": { |
| 273 "description": "The project id of the beacon to acti
vate. If the project id is not specified then the project making the request is
used. The project id must match the project that owns the beacon. Optional.", | 316 "description": "The project id of the beacon to deco
mmission. If the project id is not\nspecified then the project making the reques
t is used. The project id\nmust match the project that owns the beacon.\nOptiona
l.", |
| 274 "location": "query", | 317 "location": "query", |
| 275 "type": "string" | 318 "type": "string" |
| 276 } | 319 } |
| 277 }, | 320 }, |
| 278 "path": "v1beta1/{+beaconName}:activate", | 321 "path": "v1beta1/{+beaconName}:decommission", |
| 279 "response": { | 322 "response": { |
| 280 "$ref": "Empty" | 323 "$ref": "Empty" |
| 281 }, | 324 }, |
| 325 "scopes": [ |
| 326 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 327 ] |
| 328 }, |
| 329 "delete": { |
| 330 "description": "Deletes the specified beacon including all d
iagnostics data for the beacon\nas well as any attachments on the beacon (includ
ing those belonging to\nother projects). This operation cannot be undone.\n\nAut
henticate using an [OAuth access token](https://developers.google.com/identity/p
rotocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permis
sions in the\nGoogle Developers Console project.", |
| 331 "httpMethod": "DELETE", |
| 332 "id": "proximitybeacon.beacons.delete", |
| 333 "parameterOrder": [ |
| 334 "beaconName" |
| 335 ], |
| 336 "parameters": { |
| 337 "beaconName": { |
| 338 "description": "Beacon that should be deleted. A bea
con name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16
ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible val
ues are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\n
for AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or
the beacon's \"stable\" UID.\nRequired.", |
| 339 "location": "path", |
| 340 "pattern": "^beacons/[^/]+$", |
| 341 "required": true, |
| 342 "type": "string" |
| 343 }, |
| 344 "projectId": { |
| 345 "description": "The project id of the beacon to dele
te. If not provided, the project\nthat is making the request is used.\nOptional.
", |
| 346 "location": "query", |
| 347 "type": "string" |
| 348 } |
| 349 }, |
| 350 "path": "v1beta1/{+beaconName}", |
| 351 "response": { |
| 352 "$ref": "Empty" |
| 353 }, |
| 282 "scopes": [ | 354 "scopes": [ |
| 283 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 355 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 284 ] | 356 ] |
| 285 }, | 357 }, |
| 286 "deactivate": { | 358 "deactivate": { |
| 287 "description": "Deactivates a beacon. Once deactivated, the
API will not return information nor attachment data for the beacon when queried
via `beaconinfo.getforobserved`. Calling this method on an already inactive beac
on will do nothing (but will return a successful response code). Authenticate us
ing an [OAuth access token](https://developers.google.com/identity/protocols/OAu
th2) from a signed-in user with **Is owner** or **Can edit** permissions in the
Google Developers Console project.", | 359 "description": "Deactivates a beacon. Once deactivated, the
API will not return\ninformation nor attachment data for the beacon when queried
via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nb
eacon will do nothing (but will return a successful response code).\n\nAuthentic
ate using an [OAuth access token](https://developers.google.com/identity/protoco
ls/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions
in the\nGoogle Developers Console project.", |
| 288 "httpMethod": "POST", | 360 "httpMethod": "POST", |
| 289 "id": "proximitybeacon.beacons.deactivate", | 361 "id": "proximitybeacon.beacons.deactivate", |
| 290 "parameterOrder": [ | 362 "parameterOrder": [ |
| 291 "beaconName" | 363 "beaconName" |
| 292 ], | 364 ], |
| 293 "parameters": { | 365 "parameters": { |
| 294 "beaconName": { | 366 "beaconName": { |
| 295 "description": "Beacon that should be deactivated. A
beacon name has the format \"beacons/N!beaconId\" where the beaconId is the bas
e16 ID broadcast by the beacon and N is a code for the beacon's type. Possible v
alues are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or
the beacon's \"stable\" UID. Required.", | 367 "description": "Beacon that should be deactivated. A
beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the ba
se16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible
values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `
5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EI
D or the beacon's \"stable\" UID.\nRequired.", |
| 296 "location": "path", | 368 "location": "path", |
| 297 "pattern": "^beacons/[^/]*$", | 369 "pattern": "^beacons/[^/]+$", |
| 298 "required": true, | 370 "required": true, |
| 299 "type": "string" | 371 "type": "string" |
| 300 }, | 372 }, |
| 301 "projectId": { | 373 "projectId": { |
| 302 "description": "The project id of the beacon to deac
tivate. If the project id is not specified then the project making the request i
s used. The project id must match the project that owns the beacon. Optional.", | 374 "description": "The project id of the beacon to deac
tivate. If the project id is not\nspecified then the project making the request
is used. The project id must\nmatch the project that owns the beacon.\nOptional.
", |
| 303 "location": "query", | 375 "location": "query", |
| 304 "type": "string" | 376 "type": "string" |
| 305 } | 377 } |
| 306 }, | 378 }, |
| 307 "path": "v1beta1/{+beaconName}:deactivate", | 379 "path": "v1beta1/{+beaconName}:deactivate", |
| 308 "response": { | 380 "response": { |
| 309 "$ref": "Empty" | 381 "$ref": "Empty" |
| 310 }, | 382 }, |
| 311 "scopes": [ | 383 "scopes": [ |
| 312 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | 384 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 313 ] | 385 ] |
| 386 }, |
| 387 "register": { |
| 388 "description": "Registers a previously unregistered beacon g
iven its `advertisedId`.\nThese IDs are unique within the system. An ID can be r
egistered only once.\n\nAuthenticate using an [OAuth access token](https://devel
opers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is own
er** or **Can edit** permissions in the\nGoogle Developers Console project.", |
| 389 "httpMethod": "POST", |
| 390 "id": "proximitybeacon.beacons.register", |
| 391 "parameterOrder": [], |
| 392 "parameters": { |
| 393 "projectId": { |
| 394 "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.", |
| 395 "location": "query", |
| 396 "type": "string" |
| 397 } |
| 398 }, |
| 399 "path": "v1beta1/beacons:register", |
| 400 "request": { |
| 401 "$ref": "Beacon" |
| 402 }, |
| 403 "response": { |
| 404 "$ref": "Beacon" |
| 405 }, |
| 406 "scopes": [ |
| 407 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 408 ] |
| 409 }, |
| 410 "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.", |
| 412 "httpMethod": "GET", |
| 413 "id": "proximitybeacon.beacons.list", |
| 414 "parameterOrder": [], |
| 415 "parameters": { |
| 416 "pageToken": { |
| 417 "description": "A pagination token obtained from a p
revious request to list beacons.", |
| 418 "location": "query", |
| 419 "type": "string" |
| 420 }, |
| 421 "q": { |
| 422 "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`", |
| 423 "location": "query", |
| 424 "type": "string" |
| 425 }, |
| 426 "pageSize": { |
| 427 "description": "The maximum number of records to ret
urn for this request, up to a\nserver-defined upper limit.", |
| 428 "format": "int32", |
| 429 "location": "query", |
| 430 "type": "integer" |
| 431 }, |
| 432 "projectId": { |
| 433 "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.", |
| 434 "location": "query", |
| 435 "type": "string" |
| 436 } |
| 437 }, |
| 438 "path": "v1beta1/beacons", |
| 439 "response": { |
| 440 "$ref": "ListBeaconsResponse" |
| 441 }, |
| 442 "scopes": [ |
| 443 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" |
| 444 ] |
| 314 } | 445 } |
| 315 }, | 446 }, |
| 316 "resources": { | 447 "resources": { |
| 317 "attachments": { | 448 "attachments": { |
| 318 "methods": { | 449 "methods": { |
| 450 "delete": { |
| 451 "description": "Deletes the specified attachment for
the given beacon. Each attachment has\na unique attachment name (`attachmentNam
e`) which is returned when you\nfetch the attachment data via this API. You spec
ify this with the delete\nrequest to control which attachment is removed. This o
peration cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https:
//developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with *
*Is owner** or **Can edit** permissions in the\nGoogle Developers Console projec
t.", |
| 452 "httpMethod": "DELETE", |
| 453 "id": "proximitybeacon.beacons.attachments.delete", |
| 454 "parameterOrder": [ |
| 455 "attachmentName" |
| 456 ], |
| 457 "parameters": { |
| 458 "attachmentName": { |
| 459 "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.", |
| 460 "location": "path", |
| 461 "pattern": "^beacons/[^/]+/attachments/[^/]+
$", |
| 462 "required": true, |
| 463 "type": "string" |
| 464 }, |
| 465 "projectId": { |
| 466 "description": "The project id of the attach
ment to delete. If not provided, the project\nthat is making the request is used
.\nOptional.", |
| 467 "location": "query", |
| 468 "type": "string" |
| 469 } |
| 470 }, |
| 471 "path": "v1beta1/{+attachmentName}", |
| 472 "response": { |
| 473 "$ref": "Empty" |
| 474 }, |
| 475 "scopes": [ |
| 476 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 477 ] |
| 478 }, |
| 479 "list": { |
| 480 "description": "Returns the attachments for the spec
ified beacon that match the specified\nnamespaced-type pattern.\n\nTo control wh
ich namespaced types are returned, you add the\n`namespacedType` query parameter
to the request. You must either use\n`*/*`, to return all attachments, or the n
amespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nA
uthenticate using an [OAuth access token](https://developers.google.com/identity
/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can
edit**\npermissions in the Google Developers Console project.", |
| 481 "httpMethod": "GET", |
| 482 "id": "proximitybeacon.beacons.attachments.list", |
| 483 "parameterOrder": [ |
| 484 "beaconName" |
| 485 ], |
| 486 "parameters": { |
| 487 "projectId": { |
| 488 "description": "The project id to list beaco
n attachments under. This field can be\nused when \"*\" is specified to mean all
attachment namespaces. Projects\nmay have multiple attachments with multiple na
mespaces. If \"*\" is\nspecified and the projectId string is empty, then the pro
ject\nmaking the request is used.\nOptional.", |
| 489 "location": "query", |
| 490 "type": "string" |
| 491 }, |
| 492 "namespacedType": { |
| 493 "description": "Specifies the namespace and
type of attachment to include in response in\n<var>namespace/type</var> format.
Accepts `*/*` to specify\n\"all types in all namespaces\".", |
| 494 "location": "query", |
| 495 "type": "string" |
| 496 }, |
| 497 "beaconName": { |
| 498 "description": "Beacon whose attachments sho
uld be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the b
eaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon
's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1`
for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use eithe
r the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", |
| 499 "location": "path", |
| 500 "pattern": "^beacons/[^/]+$", |
| 501 "required": true, |
| 502 "type": "string" |
| 503 } |
| 504 }, |
| 505 "path": "v1beta1/{+beaconName}/attachments", |
| 506 "response": { |
| 507 "$ref": "ListBeaconAttachmentsResponse" |
| 508 }, |
| 509 "scopes": [ |
| 510 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 511 ] |
| 512 }, |
| 319 "create": { | 513 "create": { |
| 320 "description": "Associates the given data with the s
pecified beacon. Attachment data must contain two parts: \n- A namespaced type.
\n- The actual attachment data itself. The namespaced type consists of two par
ts, the namespace and the type. The namespace must be one of the values returned
by the `namespaces` endpoint, while the type can be a string of any characters
except for the forward slash (`/`) up to 100 characters in length. Attachment da
ta can be up to 1024 bytes long. Authenticate using an [OAuth access token](http
s://developers.google.com/identity/protocols/OAuth2) from a signed-in user with
**Is owner** or **Can edit** permissions in the Google Developers Console projec
t.", | 514 "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.", |
| 321 "httpMethod": "POST", | 515 "httpMethod": "POST", |
| 322 "id": "proximitybeacon.beacons.attachments.create", | 516 "id": "proximitybeacon.beacons.attachments.create", |
| 323 "parameterOrder": [ | 517 "parameterOrder": [ |
| 324 "beaconName" | 518 "beaconName" |
| 325 ], | 519 ], |
| 326 "parameters": { | 520 "parameters": { |
| 327 "beaconName": { | 521 "projectId": { |
| 328 "description": "Beacon on which the attachme
nt should be created. A beacon name has the format \"beacons/N!beaconId\" where
the beaconId is the base16 ID broadcast by the beacon and N is a code for the be
acon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `
1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use eit
her the current EID or the beacon's \"stable\" UID. Required.", | 522 "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.", |
| 329 "location": "path", | 523 "location": "query", |
| 330 "pattern": "^beacons/[^/]*$", | |
| 331 "required": true, | |
| 332 "type": "string" | 524 "type": "string" |
| 333 }, | 525 }, |
| 334 "projectId": { | 526 "beaconName": { |
| 335 "description": "The project id of the projec
t the attachment will belong to. If the project id is not specified then the pro
ject making the request is used. Optional.", | 527 "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.", |
| 336 "location": "query", | 528 "location": "path", |
| 529 "pattern": "^beacons/[^/]+$", |
| 530 "required": true, |
| 337 "type": "string" | 531 "type": "string" |
| 338 } | 532 } |
| 339 }, | 533 }, |
| 340 "path": "v1beta1/{+beaconName}/attachments", | 534 "path": "v1beta1/{+beaconName}/attachments", |
| 341 "request": { | 535 "request": { |
| 342 "$ref": "BeaconAttachment" | 536 "$ref": "BeaconAttachment" |
| 343 }, | 537 }, |
| 344 "response": { | 538 "response": { |
| 345 "$ref": "BeaconAttachment" | 539 "$ref": "BeaconAttachment" |
| 346 }, | 540 }, |
| 347 "scopes": [ | 541 "scopes": [ |
| 348 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | 542 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 349 ] | 543 ] |
| 350 }, | 544 }, |
| 351 "list": { | |
| 352 "description": "Returns the attachments for the spec
ified beacon that match the specified namespaced-type pattern. To control which
namespaced types are returned, you add the `namespacedType` query parameter to t
he request. You must either use `*/*`, to return all attachments, or the namespa
ce must be one of the ones returned from the `namespaces` endpoint. Authenticate
using an [OAuth access token](https://developers.google.com/identity/protocols/
OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** perm
issions in the Google Developers Console project.", | |
| 353 "httpMethod": "GET", | |
| 354 "id": "proximitybeacon.beacons.attachments.list", | |
| 355 "parameterOrder": [ | |
| 356 "beaconName" | |
| 357 ], | |
| 358 "parameters": { | |
| 359 "beaconName": { | |
| 360 "description": "Beacon whose attachments sho
uld be fetched. A beacon name has the format \"beacons/N!beaconId\" where the be
aconId is the base16 ID broadcast by the beacon and N is a code for the beacon's
type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for
iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either th
e current EID or the beacon's \"stable\" UID. Required.", | |
| 361 "location": "path", | |
| 362 "pattern": "^beacons/[^/]*$", | |
| 363 "required": true, | |
| 364 "type": "string" | |
| 365 }, | |
| 366 "namespacedType": { | |
| 367 "description": "Specifies the namespace and
type of attachment to include in response in namespace/type format. Accepts `*/*
` to specify \"all types in all namespaces\".", | |
| 368 "location": "query", | |
| 369 "type": "string" | |
| 370 }, | |
| 371 "projectId": { | |
| 372 "description": "The project id to list beaco
n attachments under. This field can be used when \"*\" is specified to mean all
attachment namespaces. Projects may have multiple attachments with multiple name
spaces. If \"*\" is specified and the projectId string is empty, then the projec
t making the request is used. Optional.", | |
| 373 "location": "query", | |
| 374 "type": "string" | |
| 375 } | |
| 376 }, | |
| 377 "path": "v1beta1/{+beaconName}/attachments", | |
| 378 "response": { | |
| 379 "$ref": "ListBeaconAttachmentsResponse" | |
| 380 }, | |
| 381 "scopes": [ | |
| 382 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | |
| 383 ] | |
| 384 }, | |
| 385 "delete": { | |
| 386 "description": "Deletes the specified attachment for
the given beacon. Each attachment has a unique attachment name (`attachmentName
`) which is returned when you fetch the attachment data via this API. You specif
y this with the delete request to control which attachment is removed. This oper
ation cannot be undone. Authenticate using an [OAuth access token](https://devel
opers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owne
r** or **Can edit** permissions in the Google Developers Console project.", | |
| 387 "httpMethod": "DELETE", | |
| 388 "id": "proximitybeacon.beacons.attachments.delete", | |
| 389 "parameterOrder": [ | |
| 390 "attachmentName" | |
| 391 ], | |
| 392 "parameters": { | |
| 393 "attachmentName": { | |
| 394 "description": "The attachment name (`attach
mentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attac
hments/c5e937-af0-494-959-ec49d12738`. For Eddystone-EID beacons, the beacon ID
portion (`3!893737abc9`) may be the beacon's current EID, or its \"stable\" Eddy
stone-UID. Required.", | |
| 395 "location": "path", | |
| 396 "pattern": "^beacons/[^/]*/attachments/[^/]*
$", | |
| 397 "required": true, | |
| 398 "type": "string" | |
| 399 }, | |
| 400 "projectId": { | |
| 401 "description": "The project id of the attach
ment to delete. If not provided, the project that is making the request is used.
Optional.", | |
| 402 "location": "query", | |
| 403 "type": "string" | |
| 404 } | |
| 405 }, | |
| 406 "path": "v1beta1/{+attachmentName}", | |
| 407 "response": { | |
| 408 "$ref": "Empty" | |
| 409 }, | |
| 410 "scopes": [ | |
| 411 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | |
| 412 ] | |
| 413 }, | |
| 414 "batchDelete": { | 545 "batchDelete": { |
| 415 "description": "Deletes multiple attachments on a gi
ven beacon. This operation is permanent and cannot be undone. You can optionally
specify `namespacedType` to choose which attachments should be deleted. If you
do not specify `namespacedType`, all your attachments on the given beacon will b
e deleted. You also may explicitly specify `*/*` to delete all. Authenticate usi
ng an [OAuth access token](https://developers.google.com/identity/protocols/OAut
h2) from a signed-in user with **Is owner** or **Can edit** permissions in the G
oogle Developers Console project.", | 546 "description": "Deletes multiple attachments on a gi
ven beacon. This operation is\npermanent and cannot be undone.\n\nYou can option
ally specify `namespacedType` to choose which attachments\nshould be deleted. If
you do not specify `namespacedType`, all your\nattachments on the given beacon
will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthe
nticate using an [OAuth access token](https://developers.google.com/identity/pro
tocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissi
ons in the\nGoogle Developers Console project.", |
| 416 "httpMethod": "POST", | 547 "httpMethod": "POST", |
| 417 "id": "proximitybeacon.beacons.attachments.batchDele
te", | 548 "id": "proximitybeacon.beacons.attachments.batchDele
te", |
| 418 "parameterOrder": [ | 549 "parameterOrder": [ |
| 419 "beaconName" | 550 "beaconName" |
| 420 ], | 551 ], |
| 421 "parameters": { | 552 "parameters": { |
| 553 "namespacedType": { |
| 554 "description": "Specifies the namespace and
type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to spec
ify\n\"all types in all namespaces\".\nOptional.", |
| 555 "location": "query", |
| 556 "type": "string" |
| 557 }, |
| 422 "beaconName": { | 558 "beaconName": { |
| 423 "description": "The beacon whose attachments
should be deleted. A beacon name has the format \"beacons/N!beaconId\" where th
e beaconId is the base16 ID broadcast by the beacon and N is a code for the beac
on's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1`
for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use eithe
r the current EID or the beacon's \"stable\" UID. Required.", | 559 "description": "The beacon whose attachments
should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where t
he beaconId is the base16 ID broadcast\nby the beacon and N is a code for the be
acon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID,
`1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use e
ither the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", |
| 424 "location": "path", | 560 "location": "path", |
| 425 "pattern": "^beacons/[^/]*$", | 561 "pattern": "^beacons/[^/]+$", |
| 426 "required": true, | 562 "required": true, |
| 427 "type": "string" | 563 "type": "string" |
| 428 }, | 564 }, |
| 429 "namespacedType": { | |
| 430 "description": "Specifies the namespace and
type of attachments to delete in `namespace/type` format. Accepts `*/*` to speci
fy \"all types in all namespaces\". Optional.", | |
| 431 "location": "query", | |
| 432 "type": "string" | |
| 433 }, | |
| 434 "projectId": { | 565 "projectId": { |
| 435 "description": "The project id to delete bea
con attachments under. This field can be used when \"*\" is specified to mean al
l attachment namespaces. Projects may have multiple attachments with multiple na
mespaces. If \"*\" is specified and the projectId string is empty, then the proj
ect making the request is used. Optional.", | 566 "description": "The project id to delete bea
con attachments under. This field can be\nused when \"*\" is specified to mean a
ll attachment namespaces. Projects\nmay have multiple attachments with multiple
namespaces. If \"*\" is\nspecified and the projectId string is empty, then the p
roject\nmaking the request is used.\nOptional.", |
| 436 "location": "query", | 567 "location": "query", |
| 437 "type": "string" | 568 "type": "string" |
| 438 } | 569 } |
| 439 }, | 570 }, |
| 440 "path": "v1beta1/{+beaconName}/attachments:batchDele
te", | 571 "path": "v1beta1/{+beaconName}/attachments:batchDele
te", |
| 441 "response": { | 572 "response": { |
| 442 "$ref": "DeleteAttachmentsResponse" | 573 "$ref": "DeleteAttachmentsResponse" |
| 443 }, | 574 }, |
| 444 "scopes": [ | 575 "scopes": [ |
| 445 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | 576 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 446 ] | 577 ] |
| 447 } | 578 } |
| 448 } | 579 } |
| 449 }, | 580 }, |
| 450 "diagnostics": { | 581 "diagnostics": { |
| 451 "methods": { | 582 "methods": { |
| 452 "list": { | 583 "list": { |
| 453 "description": "List the diagnostics for a single be
acon. You can also list diagnostics for all the beacons owned by your Google Dev
elopers Console project by using the beacon name `beacons/-`. Authenticate using
an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2
) from a signed-in user with **viewer**, **Is owner** or **Can edit** permission
s in the Google Developers Console project.", | 584 "description": "List the diagnostics for a single be
acon. You can also list diagnostics for\nall the beacons owned by your Google De
velopers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate
using an [OAuth access token](https://developers.google.com/identity/protocols/O
Auth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\nper
missions in the Google Developers Console project.", |
| 454 "httpMethod": "GET", | 585 "httpMethod": "GET", |
| 455 "id": "proximitybeacon.beacons.diagnostics.list", | 586 "id": "proximitybeacon.beacons.diagnostics.list", |
| 456 "parameterOrder": [ | 587 "parameterOrder": [ |
| 457 "beaconName" | 588 "beaconName" |
| 458 ], | 589 ], |
| 459 "parameters": { | 590 "parameters": { |
| 460 "beaconName": { | |
| 461 "description": "Beacon that the diagnostics
are for.", | |
| 462 "location": "path", | |
| 463 "pattern": "^beacons/[^/]*$", | |
| 464 "required": true, | |
| 465 "type": "string" | |
| 466 }, | |
| 467 "pageSize": { | 591 "pageSize": { |
| 468 "description": "Specifies the maximum number
of results to return. Defaults to 10. Maximum 1000. Optional.", | 592 "description": "Specifies the maximum number
of results to return. Defaults to\n10. Maximum 1000. Optional.", |
| 469 "format": "int32", | 593 "format": "int32", |
| 470 "location": "query", | 594 "location": "query", |
| 471 "type": "integer" | 595 "type": "integer" |
| 472 }, | 596 }, |
| 473 "pageToken": { | |
| 474 "description": "Requests results that occur
after the `page_token`, obtained from the response to a previous request. Option
al.", | |
| 475 "location": "query", | |
| 476 "type": "string" | |
| 477 }, | |
| 478 "alertFilter": { | 597 "alertFilter": { |
| 479 "description": "Requests only beacons that h
ave the given alert. For example, to find beacons that have low batteries use `a
lert_filter=LOW_BATTERY`.", | 598 "description": "Requests only beacons that h
ave the given alert. For example, to find\nbeacons that have low batteries use `
alert_filter=LOW_BATTERY`.", |
| 480 "enum": [ | 599 "enum": [ |
| 481 "ALERT_UNSPECIFIED", | 600 "ALERT_UNSPECIFIED", |
| 482 "WRONG_LOCATION", | 601 "WRONG_LOCATION", |
| 483 "LOW_BATTERY" | 602 "LOW_BATTERY" |
| 484 ], | 603 ], |
| 485 "location": "query", | 604 "location": "query", |
| 486 "type": "string" | 605 "type": "string" |
| 487 }, | 606 }, |
| 488 "projectId": { | 607 "projectId": { |
| 489 "description": "Requests only diagnostic rec
ords for the given project id. If not set, then the project making the request w
ill be used for looking up diagnostic records. Optional.", | 608 "description": "Requests only diagnostic rec
ords for the given project id. If not set,\nthen the project making the request
will be used for looking up\ndiagnostic records. Optional.", |
| 609 "location": "query", |
| 610 "type": "string" |
| 611 }, |
| 612 "beaconName": { |
| 613 "description": "Beacon that the diagnostics
are for.", |
| 614 "location": "path", |
| 615 "pattern": "^beacons/[^/]+$", |
| 616 "required": true, |
| 617 "type": "string" |
| 618 }, |
| 619 "pageToken": { |
| 620 "description": "Requests results that occur
after the `page_token`, obtained from the\nresponse to a previous request. Optio
nal.", |
| 490 "location": "query", | 621 "location": "query", |
| 491 "type": "string" | 622 "type": "string" |
| 492 } | 623 } |
| 493 }, | 624 }, |
| 494 "path": "v1beta1/{+beaconName}/diagnostics", | 625 "path": "v1beta1/{+beaconName}/diagnostics", |
| 495 "response": { | 626 "response": { |
| 496 "$ref": "ListDiagnosticsResponse" | 627 "$ref": "ListDiagnosticsResponse" |
| 497 }, | 628 }, |
| 498 "scopes": [ | 629 "scopes": [ |
| 499 "https://www.googleapis.com/auth/userlocation.be
acon.registry" | 630 "https://www.googleapis.com/auth/userlocation.be
acon.registry" |
| 500 ] | 631 ] |
| 501 } | 632 } |
| 502 } | 633 } |
| 503 } | 634 } |
| 504 } | 635 } |
| 505 }, | |
| 506 "namespaces": { | |
| 507 "methods": { | |
| 508 "list": { | |
| 509 "description": "Lists all attachment namespaces owned by you
r Google Developers Console project. Attachment data associated with a beacon mu
st include a namespaced type, and the namespace must be owned by your project. A
uthenticate using an [OAuth access token](https://developers.google.com/identity
/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can
edit** permissions in the Google Developers Console project.", | |
| 510 "httpMethod": "GET", | |
| 511 "id": "proximitybeacon.namespaces.list", | |
| 512 "parameters": { | |
| 513 "projectId": { | |
| 514 "description": "The project id to list namespaces un
der. Optional.", | |
| 515 "location": "query", | |
| 516 "type": "string" | |
| 517 } | |
| 518 }, | |
| 519 "path": "v1beta1/namespaces", | |
| 520 "response": { | |
| 521 "$ref": "ListNamespacesResponse" | |
| 522 }, | |
| 523 "scopes": [ | |
| 524 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | |
| 525 ] | |
| 526 }, | |
| 527 "update": { | |
| 528 "description": "Updates the information about the specified
namespace. Only the namespace visibility can be updated.", | |
| 529 "httpMethod": "PUT", | |
| 530 "id": "proximitybeacon.namespaces.update", | |
| 531 "parameterOrder": [ | |
| 532 "namespaceName" | |
| 533 ], | |
| 534 "parameters": { | |
| 535 "namespaceName": { | |
| 536 "description": "Resource name of this namespace. Nam
espaces names have the format: namespaces/namespace.", | |
| 537 "location": "path", | |
| 538 "pattern": "^namespaces/[^/]*$", | |
| 539 "required": true, | |
| 540 "type": "string" | |
| 541 }, | |
| 542 "projectId": { | |
| 543 "description": "The project id of the namespace to u
pdate. If the project id is not specified then the project making the request is
used. The project id must match the project that owns the beacon. Optional.", | |
| 544 "location": "query", | |
| 545 "type": "string" | |
| 546 } | |
| 547 }, | |
| 548 "path": "v1beta1/{+namespaceName}", | |
| 549 "request": { | |
| 550 "$ref": "Namespace" | |
| 551 }, | |
| 552 "response": { | |
| 553 "$ref": "Namespace" | |
| 554 }, | |
| 555 "scopes": [ | |
| 556 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | |
| 557 ] | |
| 558 } | |
| 559 } | |
| 560 }, | |
| 561 "v1beta1": { | |
| 562 "methods": { | |
| 563 "getEidparams": { | |
| 564 "description": "Gets the Proximity Beacon API's current publ
ic key and associated parameters used to initiate the Diffie-Hellman key exchang
e required to register a beacon that broadcasts the Eddystone-EID format. This k
ey changes periodically; clients may cache it and re-use the same public key to
provision and register multiple beacons. However, clients should be prepared to
refresh this key when they encounter an error registering an Eddystone-EID beaco
n.", | |
| 565 "httpMethod": "GET", | |
| 566 "id": "proximitybeacon.getEidparams", | |
| 567 "path": "v1beta1/eidparams", | |
| 568 "response": { | |
| 569 "$ref": "EphemeralIdRegistrationParams" | |
| 570 }, | |
| 571 "scopes": [ | |
| 572 "https://www.googleapis.com/auth/userlocation.beacon.reg
istry" | |
| 573 ] | |
| 574 } | |
| 575 } | |
| 576 }, | |
| 577 "beaconinfo": { | |
| 578 "methods": { | |
| 579 "getforobserved": { | |
| 580 "description": "Given one or more beacon observations, retur
ns any beacon information and attachments accessible to your application. Author
ize by using the [API key](https://developers.google.com/beacons/proximity/how-t
os/authorizing#APIKey) for the application.", | |
| 581 "httpMethod": "POST", | |
| 582 "id": "proximitybeacon.beaconinfo.getforobserved", | |
| 583 "path": "v1beta1/beaconinfo:getforobserved", | |
| 584 "request": { | |
| 585 "$ref": "GetInfoForObservedBeaconsRequest" | |
| 586 }, | |
| 587 "response": { | |
| 588 "$ref": "GetInfoForObservedBeaconsResponse" | |
| 589 } | |
| 590 } | |
| 591 } | |
| 592 } | 636 } |
| 593 }, | 637 }, |
| 594 "revision": "20160429", | 638 "revision": "20170320", |
| 595 "rootUrl": "https://proximitybeacon.googleapis.com/", | 639 "rootUrl": "https://proximitybeacon.googleapis.com/", |
| 596 "schemas": { | 640 "schemas": { |
| 641 "Observation": { |
| 642 "description": "Represents one beacon observed once.", |
| 643 "id": "Observation", |
| 644 "properties": { |
| 645 "timestampMs": { |
| 646 "description": "Time when the beacon was observed.", |
| 647 "format": "google-datetime", |
| 648 "type": "string" |
| 649 }, |
| 650 "advertisedId": { |
| 651 "$ref": "AdvertisedId", |
| 652 "description": "The ID advertised by the beacon the client h
as encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then
the client\nmust be authorized to resolve the given beacon. Otherwise no data wi
ll be\nreturned for that beacon.\nRequired." |
| 653 }, |
| 654 "telemetry": { |
| 655 "description": "The array of telemetry bytes received from t
he beacon. The server is\nresponsible for parsing it. This field may frequently
be empty, as\nwith a beacon that transmits telemetry only occasionally.", |
| 656 "format": "byte", |
| 657 "type": "string" |
| 658 } |
| 659 }, |
| 660 "type": "object" |
| 661 }, |
| 662 "ListDiagnosticsResponse": { |
| 663 "description": "Response that contains the requested diagnostics.", |
| 664 "id": "ListDiagnosticsResponse", |
| 665 "properties": { |
| 666 "diagnostics": { |
| 667 "description": "The diagnostics matching the given request."
, |
| 668 "items": { |
| 669 "$ref": "Diagnostics" |
| 670 }, |
| 671 "type": "array" |
| 672 }, |
| 673 "nextPageToken": { |
| 674 "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.", |
| 675 "type": "string" |
| 676 } |
| 677 }, |
| 678 "type": "object" |
| 679 }, |
| 680 "GetInfoForObservedBeaconsResponse": { |
| 681 "description": "Information about the requested beacons, optionally
including attachment\ndata.", |
| 682 "id": "GetInfoForObservedBeaconsResponse", |
| 683 "properties": { |
| 684 "beacons": { |
| 685 "description": "Public information about beacons.\nMay be em
pty if the request matched no beacons.", |
| 686 "items": { |
| 687 "$ref": "BeaconInfo" |
| 688 }, |
| 689 "type": "array" |
| 690 } |
| 691 }, |
| 692 "type": "object" |
| 693 }, |
| 597 "Beacon": { | 694 "Beacon": { |
| 598 "description": "Details of a beacon device.", | 695 "description": "Details of a beacon device.", |
| 599 "id": "Beacon", | 696 "id": "Beacon", |
| 600 "properties": { | 697 "properties": { |
| 601 "beaconName": { | 698 "beaconName": { |
| 602 "description": "Resource name of this beacon. A beacon name
has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadc
ast by the beacon and N is a code for the beacon's type. Possible values are `3`
for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left e
mpty when registering. After reading a beacon, clients can use the name for futu
re operations.", | 699 "description": "Resource name of this beacon. A beacon name
has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broad
cast by\nthe beacon and N is a code for the beacon's type. Possible values are\n
`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be
left empty when registering. After reading a beacon,\nclients can use the name f
or future operations.", |
| 603 "type": "string" | 700 "type": "string" |
| 604 }, | |
| 605 "advertisedId": { | |
| 606 "$ref": "AdvertisedId", | |
| 607 "description": "The identifier of a beacon as advertised by
it. This field must be populated when registering. It may be empty when updating
a beacon record because it is ignored in updates. When registering a beacon tha
t broadcasts Eddystone-EID, this field should contain a \"stable\" Eddystone-UID
that identifies the beacon and links it to its attachments. The stable Eddyston
e-UID is only used for administering the beacon." | |
| 608 }, | |
| 609 "status": { | |
| 610 "description": "Current status of the beacon. Required.", | |
| 611 "enum": [ | |
| 612 "STATUS_UNSPECIFIED", | |
| 613 "ACTIVE", | |
| 614 "DECOMMISSIONED", | |
| 615 "INACTIVE" | |
| 616 ], | |
| 617 "type": "string" | |
| 618 }, | |
| 619 "placeId": { | |
| 620 "description": "The [Google Places API](/places/place-id) Pl
ace ID of the place where the beacon is deployed. This is given when the beacon
is registered or updated, not automatically detected in any way. Optional.", | |
| 621 "type": "string" | |
| 622 }, | |
| 623 "latLng": { | |
| 624 "$ref": "LatLng", | |
| 625 "description": "The location of the beacon, expressed as a l
atitude and longitude pair. This location is given when the beacon is registered
or updated. It does not necessarily indicate the actual current location of the
beacon. Optional." | |
| 626 }, | |
| 627 "indoorLevel": { | |
| 628 "$ref": "IndoorLevel", | |
| 629 "description": "The indoor level information for this beacon
, if known. As returned by the Google Maps API. Optional." | |
| 630 }, | 701 }, |
| 631 "expectedStability": { | 702 "expectedStability": { |
| 632 "description": "Expected location stability. This is set whe
n the beacon is registered or updated, not automatically detected in any way. Op
tional.", | 703 "description": "Expected location stability. This is set whe
n the beacon is registered or\nupdated, not automatically detected in any way.\n
Optional.", |
| 633 "enum": [ | 704 "enum": [ |
| 634 "STABILITY_UNSPECIFIED", | 705 "STABILITY_UNSPECIFIED", |
| 635 "STABLE", | 706 "STABLE", |
| 636 "PORTABLE", | 707 "PORTABLE", |
| 637 "MOBILE", | 708 "MOBILE", |
| 638 "ROVING" | 709 "ROVING" |
| 639 ], | 710 ], |
| 711 "enumDescriptions": [ |
| 712 "Do not use this value.", |
| 713 "Not expected to move, for example a store's front door.
", |
| 714 "Usually stable but may move rarely, usually within a si
ngle place,\nfor example a store display.", |
| 715 "Moves frequently, for example a personal item or food t
ruck.", |
| 716 "Moves continuously in service, for example a bus or tra
in." |
| 717 ], |
| 718 "type": "string" |
| 719 }, |
| 720 "advertisedId": { |
| 721 "$ref": "AdvertisedId", |
| 722 "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." |
| 723 }, |
| 724 "provisioningKey": { |
| 725 "description": "Some beacons may require a user to provide a
n authorization key before\nchanging any of its configuration (e.g. broadcast fr
ames, transmit power).\nThis field provides a place to store and control access
to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!be
aconId`\nfrom users with write access to the given beacon. That is to say: If th
e\nuser is authorized to write the beacon's confidential data in the service,\nt
he service considers them authorized to configure the beacon. Note\nthat this ke
y grants nothing on the service, only on the beacon itself.", |
| 726 "format": "byte", |
| 727 "type": "string" |
| 728 }, |
| 729 "ephemeralIdRegistration": { |
| 730 "$ref": "EphemeralIdRegistration", |
| 731 "description": "Write-only registration parameters for beaco
ns using Eddystone-EID\n(remotely resolved ephemeral ID) format. This informatio
n will not be\npopulated in API responses. When submitting this data, the `adver
tised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type wil
l\nresult in an error." |
| 732 }, |
| 733 "latLng": { |
| 734 "$ref": "LatLng", |
| 735 "description": "The location of the beacon, expressed as a l
atitude and longitude pair.\nThis location is given when the beacon is registere
d or updated. It does\nnot necessarily indicate the actual current location of t
he beacon.\nOptional." |
| 736 }, |
| 737 "placeId": { |
| 738 "description": "The [Google Places API](/places/place-id) Pl
ace ID of the place where\nthe beacon is deployed. This is given when the beacon
is registered or\nupdated, not automatically detected in any way.\nOptional.", |
| 640 "type": "string" | 739 "type": "string" |
| 641 }, | 740 }, |
| 642 "description": { | 741 "description": { |
| 643 "description": "Free text used to identify and describe the
beacon. Maximum length 140 characters. Optional.", | 742 "description": "Free text used to identify and describe the
beacon. Maximum length 140\ncharacters.\nOptional.", |
| 644 "type": "string" | 743 "type": "string" |
| 645 }, | 744 }, |
| 646 "properties": { | 745 "properties": { |
| 647 "additionalProperties": { | 746 "additionalProperties": { |
| 648 "type": "string" | 747 "type": "string" |
| 649 }, | 748 }, |
| 650 "description": "Properties of the beacon device, for example
battery type or firmware version. Optional.", | 749 "description": "Properties of the beacon device, for example
battery type or firmware\nversion.\nOptional.", |
| 651 "type": "object" | 750 "type": "object" |
| 652 }, | 751 }, |
| 653 "ephemeralIdRegistration": { | 752 "status": { |
| 654 "$ref": "EphemeralIdRegistration", | 753 "description": "Current status of the beacon.\nRequired.", |
| 655 "description": "Write-only registration parameters for beaco
ns using Eddystone-EID (remotely resolved ephemeral ID) format. This information
will not be populated in API responses. When submitting this data, the `adverti
sed_id` field must contain an ID of type Eddystone-UID. Any other ID type will r
esult in an error." | 754 "enum": [ |
| 656 }, | 755 "STATUS_UNSPECIFIED", |
| 657 "provisioningKey": { | 756 "ACTIVE", |
| 658 "description": "Some beacons may require a user to provide a
n authorization key before changing any of its configuration (e.g. broadcast fra
mes, transmit power). This field provides a place to store and control access to
that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaco
nId` from users with write access to the given beacon. That is to say: If the us
er is authorized to write the beacon's confidential data in the service, the ser
vice considers them authorized to configure the beacon. Note that this key grant
s nothing on the service, only on the beacon itself.", | 757 "DECOMMISSIONED", |
| 659 "format": "byte", | 758 "INACTIVE" |
| 660 "type": "string" | 759 ], |
| 760 "enumDescriptions": [ |
| 761 "Do not use this value.", |
| 762 "The \"normal\" in-use state of a beacon.", |
| 763 "Beacon should no longer be used for any purpose. This i
s irreversible.", |
| 764 "The beacon should not be visible to mobile devices. Thi
s is reversible." |
| 765 ], |
| 766 "type": "string" |
| 767 }, |
| 768 "indoorLevel": { |
| 769 "$ref": "IndoorLevel", |
| 770 "description": "The indoor level information for this beacon
, if known. As returned by the\nGoogle Maps API.\nOptional." |
| 661 } | 771 } |
| 662 }, | 772 }, |
| 663 "type": "object" | 773 "type": "object" |
| 664 }, | 774 }, |
| 665 "AdvertisedId": { | 775 "AdvertisedId": { |
| 666 "description": "Defines a unique identifier of a beacon as broadcast
by the device.", | 776 "description": "Defines a unique identifier of a beacon as broadcast
by the device.", |
| 667 "id": "AdvertisedId", | 777 "id": "AdvertisedId", |
| 668 "properties": { | 778 "properties": { |
| 779 "id": { |
| 780 "description": "The actual beacon identifier, as broadcast b
y the beacon hardware. Must be\n[base64](http://tools.ietf.org/html/rfc4648#sect
ion-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in respo
nses. The base64\nencoding should be of the binary byte-stream and not any textu
al (such as\nhex) representation thereof.\nRequired.", |
| 781 "format": "byte", |
| 782 "type": "string" |
| 783 }, |
| 669 "type": { | 784 "type": { |
| 670 "description": "Specifies the identifier type. Required.", | 785 "description": "Specifies the identifier type.\nRequired.", |
| 671 "enum": [ | 786 "enum": [ |
| 672 "TYPE_UNSPECIFIED", | 787 "TYPE_UNSPECIFIED", |
| 673 "EDDYSTONE", | 788 "EDDYSTONE", |
| 674 "IBEACON", | 789 "IBEACON", |
| 675 "ALTBEACON", | 790 "ALTBEACON", |
| 676 "EDDYSTONE_EID" | 791 "EDDYSTONE_EID" |
| 677 ], | 792 ], |
| 678 "type": "string" | 793 "enumDescriptions": [ |
| 679 }, | 794 "Do not use this value.", |
| 680 "id": { | 795 "Eddystone, an open beacon format that supports Android
and iOS devices\nhttps://github.com/google/eddystone/wiki/Beacon-Specification", |
| 681 "description": "The actual beacon identifier, as broadcast b
y the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#secti
on-4) encoded in HTTP requests, and will be so encoded (with padding) in respons
es. The base64 encoding should be of the binary byte-stream and not any textual
(such as hex) representation thereof. Required.", | 796 "Apple iBeacon compatible beacon", |
| 682 "format": "byte", | 797 "See http://altbeacon.org and/or https://github.com/AltB
eacon/spec.", |
| 683 "type": "string" | 798 "Eddystone Ephemeral ID" |
| 684 } | 799 ], |
| 685 }, | 800 "type": "string" |
| 686 "type": "object" | |
| 687 }, | |
| 688 "LatLng": { | |
| 689 "description": "An object representing a latitude/longitude pair. Th
is is expressed as a pair of doubles representing degrees latitude and degrees l
ongitude. Unless specified otherwise, this must conform to the WGS84 standard. V
alues must be within normalized ranges. Example of normalization code in Python:
def NormalizeLongitude(longitude): \"\"\"Wraps decimal degrees longitude to [-1
80.0, 180.0].\"\"\" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0
and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitud
e): \"\"\"Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-18
0.0, 180.0], respectively.\"\"\" r = latitude % 360.0 if r = 270.0: return r - 3
60, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longi
tude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == Normali
zeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0)
== NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0
) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == N
ormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) a
ssert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == No
rmalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == Nor
malizeLatLng(-270.0, 10.0)", | |
| 690 "id": "LatLng", | |
| 691 "properties": { | |
| 692 "latitude": { | |
| 693 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", | |
| 694 "format": "double", | |
| 695 "type": "number" | |
| 696 }, | |
| 697 "longitude": { | |
| 698 "description": "The longitude in degrees. It must be in the
range [-180.0, +180.0].", | |
| 699 "format": "double", | |
| 700 "type": "number" | |
| 701 } | 801 } |
| 702 }, | 802 }, |
| 703 "type": "object" | 803 "type": "object" |
| 704 }, | 804 }, |
| 705 "IndoorLevel": { | 805 "IndoorLevel": { |
| 706 "description": "Indoor level, a human-readable string as returned by
Google Maps APIs, useful to indicate which floor of a building a beacon is loca
ted on.", | 806 "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.", |
| 707 "id": "IndoorLevel", | 807 "id": "IndoorLevel", |
| 708 "properties": { | 808 "properties": { |
| 709 "name": { | 809 "name": { |
| 710 "description": "The name of this level.", | 810 "description": "The name of this level.", |
| 711 "type": "string" | 811 "type": "string" |
| 712 } | 812 } |
| 713 }, | 813 }, |
| 714 "type": "object" | 814 "type": "object" |
| 715 }, | 815 }, |
| 716 "EphemeralIdRegistration": { | 816 "Date": { |
| 717 "description": "Write-only registration parameters for beacons using
Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon
with the service are supported: 1. Perform an ECDH key exchange via this API, in
cluding a previous call to `GET /v1beta1/eidparams`. In this case the fields `be
acon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `bea
con_identity_key` should not be populated. This method ensures that only the two
parties in the ECDH key exchange can compute the identity key, which becomes a
secret between them. 2. Derive or obtain the beacon's identity key via other sec
ure means (perhaps an ECDH key exchange between the beacon and a mobile device o
r any other secure method), and then submit the resulting identity key to the se
rvice. In this case `beacon_identity_key` field should be populated, and neither
of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The
security of this method depends on how securely the parties involved (in partic
ular the bluetooth client) handle the identity key, and obviously on how securel
y the identity key was generated. See [the Eddystone specification](https://gith
ub.com/google/eddystone/tree/master/eddystone-eid) at GitHub.", | 817 "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`.", |
| 718 "id": "EphemeralIdRegistration", | 818 "id": "Date", |
| 719 "properties": { | 819 "properties": { |
| 720 "beaconEcdhPublicKey": { | 820 "month": { |
| 721 "description": "The beacon's public key used for the Ellipti
c curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh
_public_key` must also be populated, and `beacon_identity_key` must not be.", | 821 "description": "Month of year. Must be from 1 to 12.", |
| 722 "format": "byte", | |
| 723 "type": "string" | |
| 724 }, | |
| 725 "serviceEcdhPublicKey": { | |
| 726 "description": "The service's public key used for the Ellipt
ic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh
_public_key` must also be populated, and `beacon_identity_key` must not be.", | |
| 727 "format": "byte", | |
| 728 "type": "string" | |
| 729 }, | |
| 730 "beaconIdentityKey": { | |
| 731 "description": "The private key of the beacon. If this field
is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not b
e populated.", | |
| 732 "format": "byte", | |
| 733 "type": "string" | |
| 734 }, | |
| 735 "rotationPeriodExponent": { | |
| 736 "description": "Indicates the nominal period between each ro
tation of the beacon's ephemeral ID. \"Nominal\" because the beacon should rando
mize the actual interval. See [the spec at github](https://github.com/google/edd
ystone/tree/master/eddystone-eid) for details. This value corresponds to a power
-of-two scaler on the beacon's clock: when the scaler value is K, the beacon wil
l begin broadcasting a new ephemeral ID on average every 2^K seconds.", | |
| 737 "format": "uint32", | |
| 738 "type": "integer" | |
| 739 }, | |
| 740 "initialClockValue": { | |
| 741 "description": "The initial clock value of the beacon. The b
eacon's clock must have begun counting at this value immediately prior to transm
itting this value to the resolving service. Significant delay in transmitting th
is value to the service risks registration or resolution failures. If a value is
not provided, the default is zero.", | |
| 742 "format": "uint64", | |
| 743 "type": "string" | |
| 744 }, | |
| 745 "initialEid": { | |
| 746 "description": "An initial ephemeral ID calculated using the
clock value submitted as `initial_clock_value`, and the secret key generated by
the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ec
dh_public_key`. This initial EID value will be used by the service to confirm th
at the key exchange process was successful.", | |
| 747 "format": "byte", | |
| 748 "type": "string" | |
| 749 } | |
| 750 }, | |
| 751 "type": "object" | |
| 752 }, | |
| 753 "Empty": { | |
| 754 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", | |
| 755 "id": "Empty", | |
| 756 "type": "object" | |
| 757 }, | |
| 758 "ListBeaconsResponse": { | |
| 759 "description": "Response that contains list beacon results and pagin
ation help.", | |
| 760 "id": "ListBeaconsResponse", | |
| 761 "properties": { | |
| 762 "beacons": { | |
| 763 "description": "The beacons that matched the search criteria
.", | |
| 764 "items": { | |
| 765 "$ref": "Beacon" | |
| 766 }, | |
| 767 "type": "array" | |
| 768 }, | |
| 769 "nextPageToken": { | |
| 770 "description": "An opaque pagination token that the client m
ay provide in their next request to retrieve the next page of results.", | |
| 771 "type": "string" | |
| 772 }, | |
| 773 "totalCount": { | |
| 774 "description": "Estimate of the total number of beacons matc
hed by the query. Higher values may be less accurate.", | |
| 775 "format": "int64", | |
| 776 "type": "string" | |
| 777 } | |
| 778 }, | |
| 779 "type": "object" | |
| 780 }, | |
| 781 "BeaconAttachment": { | |
| 782 "description": "Project-specific data associated with a beacon.", | |
| 783 "id": "BeaconAttachment", | |
| 784 "properties": { | |
| 785 "attachmentName": { | |
| 786 "description": "Resource name of this attachment. Attachment
names have the format: beacons/beacon_id/attachments/attachment_id. Leave this
empty on creation.", | |
| 787 "type": "string" | |
| 788 }, | |
| 789 "namespacedType": { | |
| 790 "description": "Specifies what kind of attachment this is. T
ells a client how to interpret the `data` field. Format is namespace/type. Names
pace provides type separation between clients. Type describes the type of `data`
, for use by the client when parsing the `data` field. Required.", | |
| 791 "type": "string" | |
| 792 }, | |
| 793 "data": { | |
| 794 "description": "An opaque data container for client-provided
data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in
HTTP requests, and will be so encoded (with padding) in responses. Required.", | |
| 795 "format": "byte", | |
| 796 "type": "string" | |
| 797 } | |
| 798 }, | |
| 799 "type": "object" | |
| 800 }, | |
| 801 "ListBeaconAttachmentsResponse": { | |
| 802 "description": "Response to ListBeaconAttachments that contains the
requested attachments.", | |
| 803 "id": "ListBeaconAttachmentsResponse", | |
| 804 "properties": { | |
| 805 "attachments": { | |
| 806 "description": "The attachments that corresponded to the req
uest params.", | |
| 807 "items": { | |
| 808 "$ref": "BeaconAttachment" | |
| 809 }, | |
| 810 "type": "array" | |
| 811 } | |
| 812 }, | |
| 813 "type": "object" | |
| 814 }, | |
| 815 "DeleteAttachmentsResponse": { | |
| 816 "description": "Response for a request to delete attachments.", | |
| 817 "id": "DeleteAttachmentsResponse", | |
| 818 "properties": { | |
| 819 "numDeleted": { | |
| 820 "description": "The number of attachments that were deleted.
", | |
| 821 "format": "int32", | 822 "format": "int32", |
| 822 "type": "integer" | 823 "type": "integer" |
| 823 } | 824 }, |
| 825 "year": { |
| 826 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
| 827 "format": "int32", |
| 828 "type": "integer" |
| 829 }, |
| 830 "day": { |
| 831 "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.", |
| 832 "format": "int32", |
| 833 "type": "integer" |
| 834 } |
| 824 }, | 835 }, |
| 825 "type": "object" | 836 "type": "object" |
| 826 }, | 837 }, |
| 827 "ListNamespacesResponse": { | 838 "ListNamespacesResponse": { |
| 828 "description": "Response to ListNamespacesRequest that contains all
the project's namespaces.", | 839 "description": "Response to ListNamespacesRequest that contains all
the project's namespaces.", |
| 829 "id": "ListNamespacesResponse", | 840 "id": "ListNamespacesResponse", |
| 830 "properties": { | 841 "properties": { |
| 831 "namespaces": { | 842 "namespaces": { |
| 832 "description": "The attachments that corresponded to the req
uest params.", | 843 "description": "The attachments that corresponded to the req
uest params.", |
| 833 "items": { | 844 "items": { |
| 834 "$ref": "Namespace" | 845 "$ref": "Namespace" |
| 835 }, | 846 }, |
| 836 "type": "array" | 847 "type": "array" |
| 837 } | 848 } |
| 838 }, | 849 }, |
| 839 "type": "object" | 850 "type": "object" |
| 840 }, | 851 }, |
| 841 "Namespace": { | 852 "ListBeaconsResponse": { |
| 842 "description": "An attachment namespace defines read and write acces
s for all the attachments created under it. Each namespace is globally unique, a
nd owned by one project which is the only project that can create attachments un
der it.", | 853 "description": "Response that contains list beacon results and pagin
ation help.", |
| 843 "id": "Namespace", | 854 "id": "ListBeaconsResponse", |
| 844 "properties": { | 855 "properties": { |
| 845 "namespaceName": { | 856 "nextPageToken": { |
| 846 "description": "Resource name of this namespace. Namespaces
names have the format: namespaces/namespace.", | 857 "description": "An opaque pagination token that the client m
ay provide in their next\nrequest to retrieve the next page of results.", |
| 847 "type": "string" | 858 "type": "string" |
| 848 }, | 859 }, |
| 849 "servingVisibility": { | 860 "beacons": { |
| 850 "description": "Specifies what clients may receive attachmen
ts under this namespace via `beaconinfo.getforobserved`.", | 861 "description": "The beacons that matched the search criteria
.", |
| 851 "enum": [ | 862 "items": { |
| 852 "VISIBILITY_UNSPECIFIED", | 863 "$ref": "Beacon" |
| 853 "UNLISTED", | 864 }, |
| 854 "PUBLIC" | 865 "type": "array" |
| 855 ], | 866 }, |
| 867 "totalCount": { |
| 868 "description": "Estimate of the total number of beacons matc
hed by the query. Higher\nvalues may be less accurate.", |
| 869 "format": "int64", |
| 856 "type": "string" | 870 "type": "string" |
| 857 } | 871 } |
| 858 }, | 872 }, |
| 859 "type": "object" | |
| 860 }, | |
| 861 "EphemeralIdRegistrationParams": { | |
| 862 "description": "Information a client needs to provision and register
beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Di
ffie-Hellman key exchange. See [the Eddystone specification](https://github.com/
google/eddystone/tree/master/eddystone-eid) at GitHub.", | |
| 863 "id": "EphemeralIdRegistrationParams", | |
| 864 "properties": { | |
| 865 "serviceEcdhPublicKey": { | |
| 866 "description": "The beacon service's public key for use by a
beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key excha
nge.", | |
| 867 "format": "byte", | |
| 868 "type": "string" | |
| 869 }, | |
| 870 "minRotationPeriodExponent": { | |
| 871 "description": "Indicates the minimum rotation period suppor
ted by the service. See EddystoneEidRegistration.rotation_period_exponent", | |
| 872 "format": "uint32", | |
| 873 "type": "integer" | |
| 874 }, | |
| 875 "maxRotationPeriodExponent": { | |
| 876 "description": "Indicates the maximum rotation period suppor
ted by the service. See EddystoneEidRegistration.rotation_period_exponent", | |
| 877 "format": "uint32", | |
| 878 "type": "integer" | |
| 879 } | |
| 880 }, | |
| 881 "type": "object" | |
| 882 }, | |
| 883 "ListDiagnosticsResponse": { | |
| 884 "description": "Response that contains the requested diagnostics.", | |
| 885 "id": "ListDiagnosticsResponse", | |
| 886 "properties": { | |
| 887 "diagnostics": { | |
| 888 "description": "The diagnostics matching the given request."
, | |
| 889 "items": { | |
| 890 "$ref": "Diagnostics" | |
| 891 }, | |
| 892 "type": "array" | |
| 893 }, | |
| 894 "nextPageToken": { | |
| 895 "description": "Token that can be used for pagination. Retur
ned only if the request matches more beacons than can be returned in this respon
se.", | |
| 896 "type": "string" | |
| 897 } | |
| 898 }, | |
| 899 "type": "object" | 873 "type": "object" |
| 900 }, | 874 }, |
| 901 "Diagnostics": { | 875 "Diagnostics": { |
| 902 "description": "Diagnostics for a single beacon.", | 876 "description": "Diagnostics for a single beacon.", |
| 903 "id": "Diagnostics", | 877 "id": "Diagnostics", |
| 904 "properties": { | 878 "properties": { |
| 905 "beaconName": { | 879 "beaconName": { |
| 906 "description": "Resource name of the beacon. For Eddystone-E
ID beacons, this may be the beacon's current EID, or the beacon's \"stable\" Edd
ystone-UID.", | 880 "description": "Resource name of the beacon. For Eddystone-E
ID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Ed
dystone-UID.", |
| 907 "type": "string" | 881 "type": "string" |
| 908 }, | 882 }, |
| 909 "estimatedLowBatteryDate": { | |
| 910 "$ref": "Date", | |
| 911 "description": "The date when the battery is expected to be
low. If the value is missing then there is no estimate for when the battery will
be low. This value is only an estimate, not an exact date." | |
| 912 }, | |
| 913 "alerts": { | 883 "alerts": { |
| 914 "description": "An unordered list of Alerts that the beacon
has.", | 884 "description": "An unordered list of Alerts that the beacon
has.", |
| 915 "enumDescriptions": [ | 885 "enumDescriptions": [ |
| 916 "Invalid value. Should never appear.", | 886 "Invalid value. Should never appear.", |
| 917 "The beacon has been reported in a location different th
an its registered location. This may indicate that the beacon has been moved. Th
is signal is not 100% accurate, but indicates that further investigation is wort
h while.", | 887 "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.", |
| 918 "The battery level for the beacon is low enough that, gi
ven the beacon's current use, its battery will run out with in the next 60 days.
This indicates that the battery should be replaced soon." | 888 "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." |
| 919 ], | 889 ], |
| 920 "items": { | 890 "items": { |
| 921 "enum": [ | 891 "enum": [ |
| 922 "ALERT_UNSPECIFIED", | 892 "ALERT_UNSPECIFIED", |
| 923 "WRONG_LOCATION", | 893 "WRONG_LOCATION", |
| 924 "LOW_BATTERY" | 894 "LOW_BATTERY" |
| 925 ], | 895 ], |
| 926 "type": "string" | 896 "type": "string" |
| 927 }, | 897 }, |
| 928 "type": "array" | 898 "type": "array" |
| 929 } | |
| 930 }, | |
| 931 "type": "object" | |
| 932 }, | |
| 933 "Date": { | |
| 934 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and time zone are either specified elsewhere or are not signif
icant. The date is relative to the Proleptic Gregorian Calendar. The day may be
0 to represent a year and month where the day is not significant, e.g. credit ca
rd expiration date. The year may be 0 to represent a month and day independent o
f year, e.g. anniversary date. Related types are google.type.TimeOfDay and `goog
le.protobuf.Timestamp`.", | |
| 935 "id": "Date", | |
| 936 "properties": { | |
| 937 "year": { | |
| 938 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without a year.", | |
| 939 "format": "int32", | |
| 940 "type": "integer" | |
| 941 }, | 899 }, |
| 942 "month": { | 900 "estimatedLowBatteryDate": { |
| 943 "description": "Month of year. Must be from 1 to 12.", | 901 "$ref": "Date", |
| 944 "format": "int32", | 902 "description": "The date when the battery is expected to be
low. If the value is missing\nthen there is no estimate for when the battery wil
l be low.\nThis value is only an estimate, not an exact date." |
| 945 "type": "integer" | |
| 946 }, | |
| 947 "day": { | |
| 948 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0 if specifying a year/month where the day is not si
gnificant.", | |
| 949 "format": "int32", | |
| 950 "type": "integer" | |
| 951 } | 903 } |
| 952 }, | 904 }, |
| 953 "type": "object" | 905 "type": "object" |
| 954 }, | 906 }, |
| 955 "GetInfoForObservedBeaconsRequest": { | 907 "GetInfoForObservedBeaconsRequest": { |
| 956 "description": "Request for beacon and attachment information about
beacons that a mobile client has encountered \"in the wild\".", | 908 "description": "Request for beacon and attachment information about
beacons that\na mobile client has encountered \"in the wild\".", |
| 957 "id": "GetInfoForObservedBeaconsRequest", | 909 "id": "GetInfoForObservedBeaconsRequest", |
| 958 "properties": { | 910 "properties": { |
| 959 "observations": { | 911 "observations": { |
| 960 "description": "The beacons that the client has encountered.
At least one must be given.", | 912 "description": "The beacons that the client has encountered.
\nAt least one must be given.", |
| 961 "items": { | 913 "items": { |
| 962 "$ref": "Observation" | 914 "$ref": "Observation" |
| 963 }, | 915 }, |
| 964 "type": "array" | 916 "type": "array" |
| 965 }, | 917 }, |
| 966 "namespacedTypes": { | 918 "namespacedTypes": { |
| 967 "description": "Specifies what kind of attachments to includ
e in the response. When given, the response will include only attachments of the
given types. When empty, no attachments will be returned. Must be in the format
namespace/type. Accepts `*` to specify all types in all namespaces. Optional.", | 919 "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.", |
| 968 "items": { | 920 "items": { |
| 969 "type": "string" | 921 "type": "string" |
| 970 }, | 922 }, |
| 971 "type": "array" | 923 "type": "array" |
| 972 } | 924 } |
| 973 }, | 925 }, |
| 974 "type": "object" | 926 "type": "object" |
| 975 }, | 927 }, |
| 976 "Observation": { | 928 "Empty": { |
| 977 "description": "Represents one beacon observed once.", | 929 "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 `{}`.", |
| 978 "id": "Observation", | 930 "id": "Empty", |
| 931 "properties": {}, |
| 932 "type": "object" |
| 933 }, |
| 934 "BeaconAttachment": { |
| 935 "description": "Project-specific data associated with a beacon.", |
| 936 "id": "BeaconAttachment", |
| 979 "properties": { | 937 "properties": { |
| 980 "advertisedId": { | 938 "namespacedType": { |
| 981 "$ref": "AdvertisedId", | 939 "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."
, |
| 982 "description": "The ID advertised by the beacon the client h
as encountered. Clients may submit an Eddystone-EID `advertised_id`. If the clie
nt is not authorized to resolve the given Eddystone-EID, no data will be returne
d for that beacon. Required." | 940 "type": "string" |
| 983 }, | 941 }, |
| 984 "telemetry": { | 942 "data": { |
| 985 "description": "The array of telemetry bytes received from t
he beacon. The server is responsible for parsing it. This field may frequently b
e empty, as with a beacon that transmits telemetry only occasionally.", | 943 "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.
", |
| 986 "format": "byte", | 944 "format": "byte", |
| 987 "type": "string" | 945 "type": "string" |
| 988 }, | 946 }, |
| 989 "timestampMs": { | 947 "creationTimeMs": { |
| 990 "description": "Time when the beacon was observed.", | 948 "description": "The UTC time when this attachment was create
d, in milliseconds since the\nUNIX epoch.", |
| 949 "format": "google-datetime", |
| 950 "type": "string" |
| 951 }, |
| 952 "attachmentName": { |
| 953 "description": "Resource name of this attachment. Attachment
names have the format:\n<code>beacons/<var>beacon_id</var>/attachments/<var>att
achment_id</var></code>.\nLeave this empty on creation.", |
| 991 "type": "string" | 954 "type": "string" |
| 992 } | 955 } |
| 993 }, | 956 }, |
| 994 "type": "object" | 957 "type": "object" |
| 995 }, | 958 }, |
| 996 "GetInfoForObservedBeaconsResponse": { | 959 "EphemeralIdRegistration": { |
| 997 "description": "Information about the requested beacons, optionally
including attachment data.", | 960 "description": "Write-only registration parameters for beacons using
Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon
with the service\nare supported:\n\n1. Perform an ECDH key exchange via this AP
I, including a previous call\n to `GET /v1beta1/eidparams`. In this case the f
ields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n p
opulated and `beacon_identity_key` should not be populated. This\n method ensu
res that only the two parties in the ECDH key exchange can\n compute the ident
ity key, which becomes a secret between them.\n2. Derive or obtain the beacon's
identity key via other secure means\n (perhaps an ECDH key exchange between th
e beacon and a mobile device\n or any other secure method), and then submit th
e resulting identity key\n to the service. In this case `beacon_identity_key`
field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `
service_ecdh_public_key` fields should be. The security of this method\n depen
ds on how securely the parties involved (in particular the\n bluetooth client)
handle the identity key, and obviously on how\n securely the identity key was
generated.\n\nSee [the Eddystone specification](https://github.com/google/eddys
tone/tree/master/eddystone-eid) at GitHub.", |
| 998 "id": "GetInfoForObservedBeaconsResponse", | 961 "id": "EphemeralIdRegistration", |
| 999 "properties": { | 962 "properties": { |
| 1000 "beacons": { | 963 "serviceEcdhPublicKey": { |
| 1001 "description": "Public information about beacons. May be emp
ty if the request matched no beacons.", | 964 "description": "The service's public key used for the Ellipt
ic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecd
h_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", |
| 965 "format": "byte", |
| 966 "type": "string" |
| 967 }, |
| 968 "beaconIdentityKey": { |
| 969 "description": "The private key of the beacon. If this field
is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not
be\npopulated.", |
| 970 "format": "byte", |
| 971 "type": "string" |
| 972 }, |
| 973 "initialEid": { |
| 974 "description": "An initial ephemeral ID calculated using the
clock value submitted as\n`initial_clock_value`, and the secret key generated b
y the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service
_ecdh_public_key`. This initial EID value will be used by the\nservice to confir
m that the key exchange process was successful.", |
| 975 "format": "byte", |
| 976 "type": "string" |
| 977 }, |
| 978 "initialClockValue": { |
| 979 "description": "The initial clock value of the beacon. The b
eacon's clock must have\nbegun counting at this value immediately prior to trans
mitting this\nvalue to the resolving service. Significant delay in transmitting
this\nvalue to the service risks registration or resolution failures. If a\nvalu
e is not provided, the default is zero.", |
| 980 "format": "uint64", |
| 981 "type": "string" |
| 982 }, |
| 983 "beaconEcdhPublicKey": { |
| 984 "description": "The beacon's public key used for the Ellipti
c curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecd
h_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", |
| 985 "format": "byte", |
| 986 "type": "string" |
| 987 }, |
| 988 "rotationPeriodExponent": { |
| 989 "description": "Indicates the nominal period between each ro
tation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should rand
omize the\nactual interval. See [the spec at github](https://github.com/google/e
ddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a po
wer-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon
will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.", |
| 990 "format": "uint32", |
| 991 "type": "integer" |
| 992 } |
| 993 }, |
| 994 "type": "object" |
| 995 }, |
| 996 "LatLng": { |
| 997 "description": "An object representing a latitude/longitude pair. Th
is is expressed as a pair\nof doubles representing degrees latitude and degrees
longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http
://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values
must be within normalized ranges.\n\nExample of normalization code in Python:\n
\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees long
itude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if
r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n retur
n r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal
degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], resp
ectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return
r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 36
0, NormalizeLongitude(longitude)\n else:\n return 180 - r, Normalize
Longitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n
assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLo
ngitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert
(0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == Normali
zeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\
n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.
0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng
(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n as
sert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == N
ormalizeLatLng(-270.0, 10.0)\n\nThe code in logs/storage/validator/logs_validato
r_traits.cc treats this type\nas if it were annotated as ST_LOCATION.", |
| 998 "id": "LatLng", |
| 999 "properties": { |
| 1000 "latitude": { |
| 1001 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", |
| 1002 "format": "double", |
| 1003 "type": "number" |
| 1004 }, |
| 1005 "longitude": { |
| 1006 "description": "The longitude in degrees. It must be in the
range [-180.0, +180.0].", |
| 1007 "format": "double", |
| 1008 "type": "number" |
| 1009 } |
| 1010 }, |
| 1011 "type": "object" |
| 1012 }, |
| 1013 "ListBeaconAttachmentsResponse": { |
| 1014 "description": "Response to `ListBeaconAttachments` that contains th
e requested attachments.", |
| 1015 "id": "ListBeaconAttachmentsResponse", |
| 1016 "properties": { |
| 1017 "attachments": { |
| 1018 "description": "The attachments that corresponded to the req
uest params.", |
| 1002 "items": { | 1019 "items": { |
| 1003 "$ref": "BeaconInfo" | 1020 "$ref": "BeaconAttachment" |
| 1004 }, | 1021 }, |
| 1005 "type": "array" | 1022 "type": "array" |
| 1006 } | 1023 } |
| 1007 }, | 1024 }, |
| 1008 "type": "object" | 1025 "type": "object" |
| 1009 }, | 1026 }, |
| 1027 "Namespace": { |
| 1028 "description": "An attachment namespace defines read and write acces
s for all the attachments\ncreated under it. Each namespace is globally unique,
and owned by one\nproject which is the only project that can create attachments
under it.", |
| 1029 "id": "Namespace", |
| 1030 "properties": { |
| 1031 "servingVisibility": { |
| 1032 "description": "Specifies what clients may receive attachmen
ts under this namespace\nvia `beaconinfo.getforobserved`.", |
| 1033 "enum": [ |
| 1034 "VISIBILITY_UNSPECIFIED", |
| 1035 "UNLISTED", |
| 1036 "PUBLIC" |
| 1037 ], |
| 1038 "enumDescriptions": [ |
| 1039 "Do not use this value.", |
| 1040 "Served only to the project that owns the namespace.", |
| 1041 "Any project can subscribe to attachments under the name
space." |
| 1042 ], |
| 1043 "type": "string" |
| 1044 }, |
| 1045 "namespaceName": { |
| 1046 "description": "Resource name of this namespace. Namespaces
names have the format:\n<code>namespaces/<var>namespace</var></code>.", |
| 1047 "type": "string" |
| 1048 } |
| 1049 }, |
| 1050 "type": "object" |
| 1051 }, |
| 1010 "BeaconInfo": { | 1052 "BeaconInfo": { |
| 1011 "description": "A subset of beacon information served via the `beaco
ninfo.getforobserved` method, which you call when users of your app encounter yo
ur beacons.", | 1053 "description": "A subset of beacon information served via the `beaco
ninfo.getforobserved`\nmethod, which you call when users of your app encounter y
our beacons.", |
| 1012 "id": "BeaconInfo", | 1054 "id": "BeaconInfo", |
| 1013 "properties": { | 1055 "properties": { |
| 1056 "beaconName": { |
| 1057 "description": "The name under which the beacon is registere
d.", |
| 1058 "type": "string" |
| 1059 }, |
| 1014 "advertisedId": { | 1060 "advertisedId": { |
| 1015 "$ref": "AdvertisedId", | 1061 "$ref": "AdvertisedId", |
| 1016 "description": "The ID advertised by the beacon." | 1062 "description": "The ID advertised by the beacon." |
| 1017 }, | 1063 }, |
| 1018 "beaconName": { | |
| 1019 "description": "The name under which the beacon is registere
d.", | |
| 1020 "type": "string" | |
| 1021 }, | |
| 1022 "attachments": { | 1064 "attachments": { |
| 1023 "description": "Attachments matching the type(s) requested.
May be empty if no attachment types were requested, or if none matched.", | 1065 "description": "Attachments matching the type(s) requested.\
nMay be empty if no attachment types were requested.", |
| 1024 "items": { | 1066 "items": { |
| 1025 "$ref": "AttachmentInfo" | 1067 "$ref": "AttachmentInfo" |
| 1026 }, | 1068 }, |
| 1027 "type": "array" | 1069 "type": "array" |
| 1028 } | 1070 } |
| 1029 }, | 1071 }, |
| 1030 "type": "object" | 1072 "type": "object" |
| 1031 }, | 1073 }, |
| 1032 "AttachmentInfo": { | 1074 "AttachmentInfo": { |
| 1033 "description": "A subset of attachment information served via the `b
eaconinfo.getforobserved` method, used when your users encounter your beacons.", | 1075 "description": "A subset of attachment information served via the\n`
beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.
", |
| 1034 "id": "AttachmentInfo", | 1076 "id": "AttachmentInfo", |
| 1035 "properties": { | 1077 "properties": { |
| 1036 "namespacedType": { | |
| 1037 "description": "Specifies what kind of attachment this is. T
ells a client how to interpret the `data` field. Format is namespace/type, for e
xample scrupulous-wombat-12345/welcome-message", | |
| 1038 "type": "string" | |
| 1039 }, | |
| 1040 "data": { | 1078 "data": { |
| 1041 "description": "An opaque data container for client-provided
data.", | 1079 "description": "An opaque data container for client-provided
data.", |
| 1042 "format": "byte", | 1080 "format": "byte", |
| 1043 "type": "string" | 1081 "type": "string" |
| 1082 }, |
| 1083 "namespacedType": { |
| 1084 "description": "Specifies what kind of attachment this is. T
ells a client how to\ninterpret the `data` field. Format is <var>namespace/type<
/var>, for\nexample <code>scrupulous-wombat-12345/welcome-message</code>", |
| 1085 "type": "string" |
| 1044 } | 1086 } |
| 1087 }, |
| 1088 "type": "object" |
| 1089 }, |
| 1090 "DeleteAttachmentsResponse": { |
| 1091 "description": "Response for a request to delete attachments.", |
| 1092 "id": "DeleteAttachmentsResponse", |
| 1093 "properties": { |
| 1094 "numDeleted": { |
| 1095 "description": "The number of attachments that were deleted.
", |
| 1096 "format": "int32", |
| 1097 "type": "integer" |
| 1098 } |
| 1099 }, |
| 1100 "type": "object" |
| 1101 }, |
| 1102 "EphemeralIdRegistrationParams": { |
| 1103 "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.", |
| 1104 "id": "EphemeralIdRegistrationParams", |
| 1105 "properties": { |
| 1106 "minRotationPeriodExponent": { |
| 1107 "description": "Indicates the minimum rotation period suppor
ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", |
| 1108 "format": "uint32", |
| 1109 "type": "integer" |
| 1110 }, |
| 1111 "maxRotationPeriodExponent": { |
| 1112 "description": "Indicates the maximum rotation period suppor
ted by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", |
| 1113 "format": "uint32", |
| 1114 "type": "integer" |
| 1115 }, |
| 1116 "serviceEcdhPublicKey": { |
| 1117 "description": "The beacon service's public key for use by a
beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exch
ange.", |
| 1118 "format": "byte", |
| 1119 "type": "string" |
| 1120 } |
| 1045 }, | 1121 }, |
| 1046 "type": "object" | 1122 "type": "object" |
| 1047 } | 1123 } |
| 1048 }, | 1124 }, |
| 1049 "servicePath": "", | 1125 "servicePath": "", |
| 1050 "title": "Google Proximity Beacon API", | 1126 "title": "Google Proximity Beacon API", |
| 1051 "version": "v1beta1" | 1127 "version": "v1beta1" |
| 1052 } | 1128 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2779563003:
Api-roll 47: 2017-03-27 (Closed)
