Method: beacons.attachments.batchDelete

Deletes multiple attachments on a given 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 be deleted. You also may explicitly specify */* to delete all.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

HTTP request

POST https://proximitybeacon.googleapis.com/v1beta1/{beaconName=beacons/*}/attachments:batchDelete

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
beaconName

string

The beacon whose attachments should be deleted. 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. 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 the current EID or the beacon's "stable" UID. Required.

Query parameters

Parameters
namespacedType

string

Specifies the namespace and type of attachments to delete in namespace/type format. Accepts */* to specify "all types in all namespaces". Optional.

projectId

string

The project id to delete beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for a request to delete attachments.

JSON representation
{
  "numDeleted": number,
}
Fields
numDeleted

number

The number of attachments that were deleted.

Authorization

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/userlocation.beacon.registry

For more information, see the Auth Guide.