| Index: discovery/googleapis_beta/proximitybeacon__v1beta1.json
|
| diff --git a/discovery/googleapis_beta/proximitybeacon__v1beta1.json b/discovery/googleapis_beta/proximitybeacon__v1beta1.json
|
| index 86a780e5ecdc86a56a278d72d6d0a9b29368702a..e6b88593cec07ea57049bd43a8589e4f1918cde9 100644
|
| --- a/discovery/googleapis_beta/proximitybeacon__v1beta1.json
|
| +++ b/discovery/googleapis_beta/proximitybeacon__v1beta1.json
|
| @@ -24,32 +24,6 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "upload_protocol": {
|
| - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "prettyPrint": {
|
| - "default": "true",
|
| - "description": "Returns response with indentations and line breaks.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "callback": {
|
| - "description": "JSONP",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "$.xgafv": {
|
| "description": "V1 error format.",
|
| "enum": [
|
| @@ -63,6 +37,11 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "callback": {
|
| + "description": "JSONP",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| @@ -79,13 +58,13 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -100,13 +79,34 @@
|
| "location": "query",
|
| "type": "boolean"
|
| },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "bearer_token": {
|
| "description": "OAuth bearer token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| + "upload_protocol": {
|
| + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "prettyPrint": {
|
| + "default": "true",
|
| + "description": "Returns response with indentations and line breaks.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| @@ -116,7 +116,7 @@
|
| "beaconinfo": {
|
| "methods": {
|
| "getforobserved": {
|
| - "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/how-tos/authorizing#APIKey)\nfor the application.",
|
| + "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application.",
|
| "httpMethod": "POST",
|
| "id": "proximitybeacon.beaconinfo.getforobserved",
|
| "parameterOrder": [],
|
| @@ -207,35 +207,6 @@
|
| },
|
| "beacons": {
|
| "methods": {
|
| - "activate": {
|
| - "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill return a successful response code).\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 project.",
|
| - "httpMethod": "POST",
|
| - "id": "proximitybeacon.beacons.activate",
|
| - "parameterOrder": [
|
| - "beaconName"
|
| - ],
|
| - "parameters": {
|
| - "beaconName": {
|
| - "description": "Beacon that should be activated. 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. 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.",
|
| - "location": "path",
|
| - "pattern": "^beacons/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "projectId": {
|
| - "description": "The project id of the beacon to activate. 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.",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1beta1/{+beaconName}:activate",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| - ]
|
| - },
|
| "get": {
|
| "description": "Returns detailed information about the specified beacon.\n\nAuthenticate 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.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
|
| "httpMethod": "GET",
|
| @@ -326,28 +297,28 @@
|
| "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| ]
|
| },
|
| - "delete": {
|
| - "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\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 project.",
|
| - "httpMethod": "DELETE",
|
| - "id": "proximitybeacon.beacons.delete",
|
| + "deactivate": {
|
| + "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\nbeacon will do nothing (but will return a successful response code).\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 project.",
|
| + "httpMethod": "POST",
|
| + "id": "proximitybeacon.beacons.deactivate",
|
| "parameterOrder": [
|
| "beaconName"
|
| ],
|
| "parameters": {
|
| "beaconName": {
|
| - "description": "Beacon that should be deleted. 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. 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.",
|
| + "description": "Beacon that should be deactivated. 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. 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.",
|
| "location": "path",
|
| "pattern": "^beacons/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "projectId": {
|
| - "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
|
| + "description": "The project id of the beacon to deactivate. 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.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1beta1/{+beaconName}",
|
| + "path": "v1beta1/{+beaconName}:deactivate",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| @@ -355,28 +326,28 @@
|
| "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| ]
|
| },
|
| - "deactivate": {
|
| - "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\nbeacon will do nothing (but will return a successful response code).\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 project.",
|
| - "httpMethod": "POST",
|
| - "id": "proximitybeacon.beacons.deactivate",
|
| + "delete": {
|
| + "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\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 project.",
|
| + "httpMethod": "DELETE",
|
| + "id": "proximitybeacon.beacons.delete",
|
| "parameterOrder": [
|
| "beaconName"
|
| ],
|
| "parameters": {
|
| "beaconName": {
|
| - "description": "Beacon that should be deactivated. 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. 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.",
|
| + "description": "Beacon that should be deleted. 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. 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.",
|
| "location": "path",
|
| "pattern": "^beacons/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "projectId": {
|
| - "description": "The project id of the beacon to deactivate. 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.",
|
| + "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1beta1/{+beaconName}:deactivate",
|
| + "path": "v1beta1/{+beaconName}",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| @@ -442,9 +413,92 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| ]
|
| + },
|
| + "activate": {
|
| + "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill return a successful response code).\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 project.",
|
| + "httpMethod": "POST",
|
| + "id": "proximitybeacon.beacons.activate",
|
| + "parameterOrder": [
|
| + "beaconName"
|
| + ],
|
| + "parameters": {
|
| + "projectId": {
|
| + "description": "The project id of the beacon to activate. 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.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "beaconName": {
|
| + "description": "Beacon that should be activated. 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. 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.",
|
| + "location": "path",
|
| + "pattern": "^beacons/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1beta1/{+beaconName}:activate",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| + ]
|
| }
|
| },
|
| "resources": {
|
| + "diagnostics": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate 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.",
|
| + "httpMethod": "GET",
|
| + "id": "proximitybeacon.beacons.diagnostics.list",
|
| + "parameterOrder": [
|
| + "beaconName"
|
| + ],
|
| + "parameters": {
|
| + "pageSize": {
|
| + "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "alertFilter": {
|
| + "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
|
| + "enum": [
|
| + "ALERT_UNSPECIFIED",
|
| + "WRONG_LOCATION",
|
| + "LOW_BATTERY"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "projectId": {
|
| + "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "beaconName": {
|
| + "description": "Beacon that the diagnostics are for.",
|
| + "location": "path",
|
| + "pattern": "^beacons/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1beta1/{+beaconName}/diagnostics",
|
| + "response": {
|
| + "$ref": "ListDiagnosticsResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| "attachments": {
|
| "methods": {
|
| "delete": {
|
| @@ -484,11 +538,6 @@
|
| "beaconName"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "namespacedType": {
|
| "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\".",
|
| "location": "query",
|
| @@ -500,6 +549,11 @@
|
| "pattern": "^beacons/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "projectId": {
|
| + "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1beta1/{+beaconName}/attachments",
|
| @@ -550,81 +604,27 @@
|
| "beaconName"
|
| ],
|
| "parameters": {
|
| - "namespacedType": {
|
| - "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "beaconName": {
|
| - "description": "The beacon whose attachments should be deleted. 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.",
|
| - "location": "path",
|
| - "pattern": "^beacons/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "projectId": {
|
| "description": "The project id to delete beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
|
| "location": "query",
|
| "type": "string"
|
| - }
|
| - },
|
| - "path": "v1beta1/{+beaconName}/attachments:batchDelete",
|
| - "response": {
|
| - "$ref": "DeleteAttachmentsResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| - ]
|
| - }
|
| - }
|
| - },
|
| - "diagnostics": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate 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.",
|
| - "httpMethod": "GET",
|
| - "id": "proximitybeacon.beacons.diagnostics.list",
|
| - "parameterOrder": [
|
| - "beaconName"
|
| - ],
|
| - "parameters": {
|
| - "pageSize": {
|
| - "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "alertFilter": {
|
| - "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
|
| - "enum": [
|
| - "ALERT_UNSPECIFIED",
|
| - "WRONG_LOCATION",
|
| - "LOW_BATTERY"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| },
|
| - "projectId": {
|
| - "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
|
| + "namespacedType": {
|
| + "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| "beaconName": {
|
| - "description": "Beacon that the diagnostics are for.",
|
| + "description": "The beacon whose attachments should be deleted. 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.",
|
| "location": "path",
|
| "pattern": "^beacons/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| - "path": "v1beta1/{+beaconName}/diagnostics",
|
| + "path": "v1beta1/{+beaconName}/attachments:batchDelete",
|
| "response": {
|
| - "$ref": "ListDiagnosticsResponse"
|
| + "$ref": "DeleteAttachmentsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/userlocation.beacon.registry"
|
| @@ -635,30 +635,9 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170320",
|
| + "revision": "20170403",
|
| "rootUrl": "https://proximitybeacon.googleapis.com/",
|
| "schemas": {
|
| - "Observation": {
|
| - "description": "Represents one beacon observed once.",
|
| - "id": "Observation",
|
| - "properties": {
|
| - "timestampMs": {
|
| - "description": "Time when the beacon was observed.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "advertisedId": {
|
| - "$ref": "AdvertisedId",
|
| - "description": "The ID advertised by the beacon the client has 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 will be\nreturned for that beacon.\nRequired."
|
| - },
|
| - "telemetry": {
|
| - "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
|
| - "format": "byte",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "ListDiagnosticsResponse": {
|
| "description": "Response that contains the requested diagnostics.",
|
| "id": "ListDiagnosticsResponse",
|
| @@ -695,6 +674,26 @@
|
| "description": "Details of a beacon device.",
|
| "id": "Beacon",
|
| "properties": {
|
| + "indoorLevel": {
|
| + "$ref": "IndoorLevel",
|
| + "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
|
| + },
|
| + "status": {
|
| + "description": "Current status of the beacon.\nRequired.",
|
| + "enum": [
|
| + "STATUS_UNSPECIFIED",
|
| + "ACTIVE",
|
| + "DECOMMISSIONED",
|
| + "INACTIVE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Do not use this value.",
|
| + "The \"normal\" in-use state of a beacon.",
|
| + "Beacon should no longer be used for any purpose. This is irreversible.",
|
| + "The beacon should not be visible to mobile devices. This is reversible."
|
| + ],
|
| + "type": "string"
|
| + },
|
| "beaconName": {
|
| "description": "Resource name of this beacon. 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. 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 for future operations.",
|
| "type": "string"
|
| @@ -730,17 +729,17 @@
|
| "$ref": "EphemeralIdRegistration",
|
| "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error."
|
| },
|
| - "latLng": {
|
| - "$ref": "LatLng",
|
| - "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional."
|
| + "description": {
|
| + "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
|
| + "type": "string"
|
| },
|
| "placeId": {
|
| "description": "The [Google Places API](/places/place-id) Place 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.",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
|
| - "type": "string"
|
| + "latLng": {
|
| + "$ref": "LatLng",
|
| + "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional."
|
| },
|
| "properties": {
|
| "additionalProperties": {
|
| @@ -748,26 +747,6 @@
|
| },
|
| "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
|
| "type": "object"
|
| - },
|
| - "status": {
|
| - "description": "Current status of the beacon.\nRequired.",
|
| - "enum": [
|
| - "STATUS_UNSPECIFIED",
|
| - "ACTIVE",
|
| - "DECOMMISSIONED",
|
| - "INACTIVE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Do not use this value.",
|
| - "The \"normal\" in-use state of a beacon.",
|
| - "Beacon should no longer be used for any purpose. This is irreversible.",
|
| - "The beacon should not be visible to mobile devices. This is reversible."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "indoorLevel": {
|
| - "$ref": "IndoorLevel",
|
| - "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
|
| }
|
| },
|
| "type": "object"
|
| @@ -849,29 +828,6 @@
|
| },
|
| "type": "object"
|
| },
|
| - "ListBeaconsResponse": {
|
| - "description": "Response that contains list beacon results and pagination help.",
|
| - "id": "ListBeaconsResponse",
|
| - "properties": {
|
| - "nextPageToken": {
|
| - "description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
|
| - "type": "string"
|
| - },
|
| - "beacons": {
|
| - "description": "The beacons that matched the search criteria.",
|
| - "items": {
|
| - "$ref": "Beacon"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "totalCount": {
|
| - "description": "Estimate of the total number of beacons matched by the query. Higher\nvalues may be less accurate.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "Diagnostics": {
|
| "description": "Diagnostics for a single beacon.",
|
| "id": "Diagnostics",
|
| @@ -904,6 +860,29 @@
|
| },
|
| "type": "object"
|
| },
|
| + "ListBeaconsResponse": {
|
| + "description": "Response that contains list beacon results and pagination help.",
|
| + "id": "ListBeaconsResponse",
|
| + "properties": {
|
| + "beacons": {
|
| + "description": "The beacons that matched the search criteria.",
|
| + "items": {
|
| + "$ref": "Beacon"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "totalCount": {
|
| + "description": "Estimate of the total number of beacons matched by the query. Higher\nvalues may be less accurate.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "GetInfoForObservedBeaconsRequest": {
|
| "description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".",
|
| "id": "GetInfoForObservedBeaconsRequest",
|
| @@ -960,6 +939,21 @@
|
| "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 API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity 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 the beacon and a mobile device\n or any other secure method), and then submit the 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 depends 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/eddystone/tree/master/eddystone-eid) at GitHub.",
|
| "id": "EphemeralIdRegistration",
|
| "properties": {
|
| + "beaconEcdhPublicKey": {
|
| + "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "initialClockValue": {
|
| + "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
|
| + "format": "uint64",
|
| + "type": "string"
|
| + },
|
| + "rotationPeriodExponent": {
|
| + "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-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.",
|
| + "format": "uint32",
|
| + "type": "integer"
|
| + },
|
| "serviceEcdhPublicKey": {
|
| "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
|
| "format": "byte",
|
| @@ -974,21 +968,6 @@
|
| "description": "An initial ephemeral ID calculated using the clock value submitted as\n`initial_clock_value`, and the secret key generated by 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 confirm that the key exchange process was successful.",
|
| "format": "byte",
|
| "type": "string"
|
| - },
|
| - "initialClockValue": {
|
| - "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
|
| - "format": "uint64",
|
| - "type": "string"
|
| - },
|
| - "beaconEcdhPublicKey": {
|
| - "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
|
| - "format": "byte",
|
| - "type": "string"
|
| - },
|
| - "rotationPeriodExponent": {
|
| - "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-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.",
|
| - "format": "uint32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1028,6 +1007,10 @@
|
| "description": "An attachment namespace defines read and write access 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.",
|
| "id": "Namespace",
|
| "properties": {
|
| + "namespaceName": {
|
| + "description": "Resource name of this namespace. Namespaces names have the format:\n<code>namespaces/<var>namespace</var></code>.",
|
| + "type": "string"
|
| + },
|
| "servingVisibility": {
|
| "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
|
| "enum": [
|
| @@ -1041,9 +1024,21 @@
|
| "Any project can subscribe to attachments under the namespace."
|
| ],
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "AttachmentInfo": {
|
| + "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
|
| + "id": "AttachmentInfo",
|
| + "properties": {
|
| + "namespacedType": {
|
| + "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is <var>namespace/type</var>, for\nexample <code>scrupulous-wombat-12345/welcome-message</code>",
|
| + "type": "string"
|
| },
|
| - "namespaceName": {
|
| - "description": "Resource name of this namespace. Namespaces names have the format:\n<code>namespaces/<var>namespace</var></code>.",
|
| + "data": {
|
| + "description": "An opaque data container for client-provided data.",
|
| + "format": "byte",
|
| "type": "string"
|
| }
|
| },
|
| @@ -1053,10 +1048,6 @@
|
| "description": "A subset of beacon information served via the `beaconinfo.getforobserved`\nmethod, which you call when users of your app encounter your beacons.",
|
| "id": "BeaconInfo",
|
| "properties": {
|
| - "beaconName": {
|
| - "description": "The name under which the beacon is registered.",
|
| - "type": "string"
|
| - },
|
| "advertisedId": {
|
| "$ref": "AdvertisedId",
|
| "description": "The ID advertised by the beacon."
|
| @@ -1067,21 +1058,9 @@
|
| "$ref": "AttachmentInfo"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AttachmentInfo": {
|
| - "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
|
| - "id": "AttachmentInfo",
|
| - "properties": {
|
| - "data": {
|
| - "description": "An opaque data container for client-provided data.",
|
| - "format": "byte",
|
| - "type": "string"
|
| },
|
| - "namespacedType": {
|
| - "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is <var>namespace/type</var>, for\nexample <code>scrupulous-wombat-12345/welcome-message</code>",
|
| + "beaconName": {
|
| + "description": "The name under which the beacon is registered.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -1120,6 +1099,27 @@
|
| }
|
| },
|
| "type": "object"
|
| + },
|
| + "Observation": {
|
| + "description": "Represents one beacon observed once.",
|
| + "id": "Observation",
|
| + "properties": {
|
| + "advertisedId": {
|
| + "$ref": "AdvertisedId",
|
| + "description": "The ID advertised by the beacon the client has 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 will be\nreturned for that beacon.\nRequired."
|
| + },
|
| + "telemetry": {
|
| + "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "timestampMs": {
|
| + "description": "Time when the beacon was observed.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| }
|
| },
|
| "servicePath": "",
|
|
|
Chromium Code Reviews
Issue 2824163002:
Api-roll 48: 2017-04-18 (Closed)
