Index: discovery/googleapis_beta/proximitybeacon__v1beta1.json |
diff --git a/discovery/googleapis_beta/proximitybeacon__v1beta1.json b/discovery/googleapis_beta/proximitybeacon__v1beta1.json |
index f60de450ee906afcd5d568d00f56e42e5d4706f1..993602d50d140b2b15669778cb6cc2c3e0b5c994 100644 |
--- a/discovery/googleapis_beta/proximitybeacon__v1beta1.json |
+++ b/discovery/googleapis_beta/proximitybeacon__v1beta1.json |
@@ -24,6 +24,27 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
+ "quotaUser": { |
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pp": { |
+ "default": "true", |
+ "description": "Pretty-print response.", |
+ "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" |
+ }, |
"upload_protocol": { |
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
"location": "query", |
@@ -79,89 +100,113 @@ |
"location": "query", |
"type": "string" |
}, |
- "access_token": { |
- "description": "OAuth access token.", |
- "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.", |
"location": "query", |
"type": "string" |
}, |
- "quotaUser": { |
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
- "location": "query", |
- "type": "string" |
- }, |
- "pp": { |
- "default": "true", |
- "description": "Pretty-print response.", |
- "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.", |
+ "access_token": { |
+ "description": "OAuth access token.", |
"location": "query", |
"type": "string" |
} |
}, |
"protocol": "rest", |
"resources": { |
- "v1beta1": { |
+ "beaconinfo": { |
"methods": { |
- "getEidparams": { |
- "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange 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\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.", |
- "httpMethod": "GET", |
- "id": "proximitybeacon.getEidparams", |
+ "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/get-started#request_a_browser_api_key)\nfor the application.", |
+ "httpMethod": "POST", |
+ "id": "proximitybeacon.beaconinfo.getforobserved", |
"parameterOrder": [], |
"parameters": {}, |
- "path": "v1beta1/eidparams", |
- "response": { |
- "$ref": "EphemeralIdRegistrationParams" |
+ "path": "v1beta1/beaconinfo:getforobserved", |
+ "request": { |
+ "$ref": "GetInfoForObservedBeaconsRequest" |
}, |
- "scopes": [ |
- "https://www.googleapis.com/auth/userlocation.beacon.registry" |
- ] |
+ "response": { |
+ "$ref": "GetInfoForObservedBeaconsResponse" |
+ } |
} |
} |
}, |
- "beacons": { |
+ "namespaces": { |
"methods": { |
- "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" |
- ], |
+ "list": { |
+ "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\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.namespaces.list", |
+ "parameterOrder": [], |
"parameters": { |
"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 to list namespaces under.\nOptional.", |
"location": "query", |
"type": "string" |
- }, |
- "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.", |
+ } |
+ }, |
+ "path": "v1beta1/namespaces", |
+ "response": { |
+ "$ref": "ListNamespacesResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/userlocation.beacon.registry" |
+ ] |
+ }, |
+ "update": { |
+ "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.", |
+ "httpMethod": "PUT", |
+ "id": "proximitybeacon.namespaces.update", |
+ "parameterOrder": [ |
+ "namespaceName" |
+ ], |
+ "parameters": { |
+ "namespaceName": { |
+ "description": "Resource name of this namespace. Namespaces names have the format:\n<code>namespaces/<var>namespace</var></code>.", |
"location": "path", |
- "pattern": "^beacons/[^/]+$", |
+ "pattern": "^namespaces/[^/]+$", |
"required": true, |
"type": "string" |
+ }, |
+ "projectId": { |
+ "description": "The project id of the namespace to update. 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}", |
+ "path": "v1beta1/{+namespaceName}", |
+ "request": { |
+ "$ref": "Namespace" |
+ }, |
"response": { |
- "$ref": "Empty" |
+ "$ref": "Namespace" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
] |
- }, |
+ } |
+ } |
+ }, |
+ "v1beta1": { |
+ "methods": { |
+ "getEidparams": { |
+ "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange 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\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.", |
+ "httpMethod": "GET", |
+ "id": "proximitybeacon.getEidparams", |
+ "parameterOrder": [], |
+ "parameters": {}, |
+ "path": "v1beta1/eidparams", |
+ "response": { |
+ "$ref": "EphemeralIdRegistrationParams" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/userlocation.beacon.registry" |
+ ] |
+ } |
+ } |
+ }, |
+ "beacons": { |
+ "methods": { |
"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", |
@@ -191,24 +236,30 @@ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
] |
}, |
- "register": { |
- "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\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.register", |
- "parameterOrder": [], |
+ "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 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 project the beacon will be registered to. If\nthe project id is not specified then the project making the request\nis used.\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/beacons:register", |
- "request": { |
- "$ref": "Beacon" |
- }, |
+ "path": "v1beta1/{+beaconName}", |
"response": { |
- "$ref": "Beacon" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
@@ -250,6 +301,29 @@ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
] |
}, |
+ "register": { |
+ "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\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.register", |
+ "parameterOrder": [], |
+ "parameters": { |
+ "projectId": { |
+ "description": "The project id of the project the beacon will be registered to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.", |
+ "location": "query", |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1beta1/beacons:register", |
+ "request": { |
+ "$ref": "Beacon" |
+ }, |
+ "response": { |
+ "$ref": "Beacon" |
+ }, |
+ "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", |
@@ -258,17 +332,17 @@ |
"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" |
- }, |
- "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", |
@@ -316,17 +390,17 @@ |
"beaconName" |
], |
"parameters": { |
- "projectId": { |
- "description": "The project id of the beacon to update. 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": "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.", |
"location": "path", |
"pattern": "^beacons/[^/]+$", |
"required": true, |
"type": "string" |
+ }, |
+ "projectId": { |
+ "description": "The project id of the beacon to update. 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}", |
@@ -381,6 +455,18 @@ |
"beaconName" |
], |
"parameters": { |
+ "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" |
+ }, |
"pageSize": { |
"description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.", |
"format": "int32", |
@@ -401,18 +487,6 @@ |
"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", |
@@ -427,130 +501,130 @@ |
}, |
"attachments": { |
"methods": { |
- "delete": { |
- "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation 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 project.", |
- "httpMethod": "DELETE", |
- "id": "proximitybeacon.beacons.attachments.delete", |
+ "create": { |
+ "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n<ul>\n<li>A namespaced 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 characters 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/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", |
+ "httpMethod": "POST", |
+ "id": "proximitybeacon.beacons.attachments.create", |
"parameterOrder": [ |
- "attachmentName" |
+ "beaconName" |
], |
"parameters": { |
- "projectId": { |
- "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.", |
- "location": "query", |
- "type": "string" |
- }, |
- "attachmentName": { |
- "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/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.", |
+ "beaconName": { |
+ "description": "Beacon on which the attachment 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.", |
"location": "path", |
- "pattern": "^beacons/[^/]+/attachments/[^/]+$", |
+ "pattern": "^beacons/[^/]+$", |
"required": true, |
"type": "string" |
+ }, |
+ "projectId": { |
+ "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
- "path": "v1beta1/{+attachmentName}", |
+ "path": "v1beta1/{+beaconName}/attachments", |
+ "request": { |
+ "$ref": "BeaconAttachment" |
+ }, |
"response": { |
- "$ref": "Empty" |
+ "$ref": "BeaconAttachment" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
] |
}, |
- "list": { |
- "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which 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 namespace must be one of\nthe ones returned from the `namespaces` endpoint.\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.attachments.list", |
+ "batchDelete": { |
+ "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally 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\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.attachments.batchDelete", |
"parameterOrder": [ |
"beaconName" |
], |
"parameters": { |
"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\".", |
+ "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 whose attachments should be fetched. 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.", |
+ "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 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.", |
+ "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", |
+ "path": "v1beta1/{+beaconName}/attachments:batchDelete", |
"response": { |
- "$ref": "ListBeaconAttachmentsResponse" |
+ "$ref": "DeleteAttachmentsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
] |
}, |
- "create": { |
- "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n<ul>\n<li>A namespaced 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 characters 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/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", |
- "httpMethod": "POST", |
- "id": "proximitybeacon.beacons.attachments.create", |
+ "delete": { |
+ "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation 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 project.", |
+ "httpMethod": "DELETE", |
+ "id": "proximitybeacon.beacons.attachments.delete", |
"parameterOrder": [ |
- "beaconName" |
+ "attachmentName" |
], |
"parameters": { |
- "beaconName": { |
- "description": "Beacon on which the attachment 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.", |
- "location": "path", |
- "pattern": "^beacons/[^/]+$", |
- "required": true, |
- "type": "string" |
- }, |
"projectId": { |
- "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.", |
+ "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.", |
"location": "query", |
"type": "string" |
+ }, |
+ "attachmentName": { |
+ "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/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.", |
+ "location": "path", |
+ "pattern": "^beacons/[^/]+/attachments/[^/]+$", |
+ "required": true, |
+ "type": "string" |
} |
}, |
- "path": "v1beta1/{+beaconName}/attachments", |
- "request": { |
- "$ref": "BeaconAttachment" |
- }, |
+ "path": "v1beta1/{+attachmentName}", |
"response": { |
- "$ref": "BeaconAttachment" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
] |
}, |
- "batchDelete": { |
- "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally 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\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.attachments.batchDelete", |
+ "list": { |
+ "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which 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 namespace must be one of\nthe ones returned from the `namespaces` endpoint.\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.attachments.list", |
"parameterOrder": [ |
"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 attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.", |
+ "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", |
"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.", |
+ "description": "Beacon whose attachments should be fetched. 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", |
+ "path": "v1beta1/{+beaconName}/attachments", |
"response": { |
- "$ref": "DeleteAttachmentsResponse" |
+ "$ref": "ListBeaconAttachmentsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/userlocation.beacon.registry" |
@@ -559,83 +633,9 @@ |
} |
} |
} |
- }, |
- "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/get-started#request_a_browser_api_key)\nfor the application.", |
- "httpMethod": "POST", |
- "id": "proximitybeacon.beaconinfo.getforobserved", |
- "parameterOrder": [], |
- "parameters": {}, |
- "path": "v1beta1/beaconinfo:getforobserved", |
- "request": { |
- "$ref": "GetInfoForObservedBeaconsRequest" |
- }, |
- "response": { |
- "$ref": "GetInfoForObservedBeaconsResponse" |
- } |
- } |
- } |
- }, |
- "namespaces": { |
- "methods": { |
- "update": { |
- "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.", |
- "httpMethod": "PUT", |
- "id": "proximitybeacon.namespaces.update", |
- "parameterOrder": [ |
- "namespaceName" |
- ], |
- "parameters": { |
- "namespaceName": { |
- "description": "Resource name of this namespace. Namespaces names have the format:\n<code>namespaces/<var>namespace</var></code>.", |
- "location": "path", |
- "pattern": "^namespaces/[^/]+$", |
- "required": true, |
- "type": "string" |
- }, |
- "projectId": { |
- "description": "The project id of the namespace to update. 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/{+namespaceName}", |
- "request": { |
- "$ref": "Namespace" |
- }, |
- "response": { |
- "$ref": "Namespace" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/userlocation.beacon.registry" |
- ] |
- }, |
- "list": { |
- "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\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.namespaces.list", |
- "parameterOrder": [], |
- "parameters": { |
- "projectId": { |
- "description": "The project id to list namespaces under.\nOptional.", |
- "location": "query", |
- "type": "string" |
- } |
- }, |
- "path": "v1beta1/namespaces", |
- "response": { |
- "$ref": "ListNamespacesResponse" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/userlocation.beacon.registry" |
- ] |
- } |
- } |
} |
}, |
- "revision": "20170517", |
+ "revision": "20170606", |
"rootUrl": "https://proximitybeacon.googleapis.com/", |
"schemas": { |
"ListBeaconAttachmentsResponse": { |
@@ -656,6 +656,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": [ |
@@ -669,10 +673,6 @@ |
"Any project can subscribe to attachments under the namespace." |
], |
"type": "string" |
- }, |
- "namespaceName": { |
- "description": "Resource name of this namespace. Namespaces names have the format:\n<code>namespaces/<var>namespace</var></code>.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -697,10 +697,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." |
@@ -711,6 +707,22 @@ |
"$ref": "AttachmentInfo" |
}, |
"type": "array" |
+ }, |
+ "beaconName": { |
+ "description": "The name under which the beacon is registered.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "DeleteAttachmentsResponse": { |
+ "description": "Response for a request to delete attachments.", |
+ "id": "DeleteAttachmentsResponse", |
+ "properties": { |
+ "numDeleted": { |
+ "description": "The number of attachments that were deleted.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"type": "object" |
@@ -737,26 +749,10 @@ |
}, |
"type": "object" |
}, |
- "DeleteAttachmentsResponse": { |
- "description": "Response for a request to delete attachments.", |
- "id": "DeleteAttachmentsResponse", |
- "properties": { |
- "numDeleted": { |
- "description": "The number of attachments that were deleted.", |
- "format": "int32", |
- "type": "integer" |
- } |
- }, |
- "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", |
@@ -766,6 +762,10 @@ |
"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." |
} |
}, |
"type": "object" |
@@ -806,18 +806,6 @@ |
"description": "Details of a beacon device.", |
"id": "Beacon", |
"properties": { |
- "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" |
- }, |
- "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": { |
"type": "string" |
@@ -879,6 +867,18 @@ |
"description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, 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!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.", |
"format": "byte", |
"type": "string" |
+ }, |
+ "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" |
+ }, |
+ "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." |
} |
}, |
"type": "object" |
@@ -960,29 +960,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", |
@@ -1015,6 +992,35 @@ |
}, |
"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" |
+ }, |
+ "Empty": { |
+ "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 it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
+ "id": "Empty", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
"GetInfoForObservedBeaconsRequest": { |
"description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".", |
"id": "GetInfoForObservedBeaconsRequest", |
@@ -1036,25 +1042,10 @@ |
}, |
"type": "object" |
}, |
- "Empty": { |
- "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 it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
- "id": "Empty", |
- "properties": {}, |
- "type": "object" |
- }, |
"BeaconAttachment": { |
"description": "Project-specific data associated with a beacon.", |
"id": "BeaconAttachment", |
"properties": { |
- "creationTimeMs": { |
- "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
- "attachmentName": { |
- "description": "Resource name of this attachment. Attachment names have the format:\n<code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.\nLeave this empty on creation.", |
- "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>. Namespace\nprovides type separation between clients. Type describes the type of\n`data`, for use by the client when parsing the `data` field.\nRequired.", |
"type": "string" |
@@ -1063,6 +1054,15 @@ |
"description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired.", |
"format": "byte", |
"type": "string" |
+ }, |
+ "creationTimeMs": { |
+ "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
+ "attachmentName": { |
+ "description": "Resource name of this attachment. Attachment names have the format:\n<code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.\nLeave this empty on creation.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -1071,6 +1071,16 @@ |
"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": { |
+ "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", |
@@ -1090,16 +1100,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" |
} |
}, |
"type": "object" |