Method: beacons.attachments.list

Returns the attachments for the specified beacon that match the specified namespaced-type pattern.

To control which namespaced types are returned, you add the namespacedType query parameter to the request. You must either use */*, to return all attachments, or the namespace must be one of the ones returned from the namespaces endpoint.

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

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
beaconName

string

Beacon whose attachments should be fetched. 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 attachment to include in response in namespace/type format. Accepts */* to specify "all types in all namespaces".

projectId

string

The project id to list 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 to attachments.list that contains the requested attachments.

JSON representation
{
  "attachments": [
    {
      object(BeaconAttachment)
    }
  ],
}
Fields
attachments[]

object(BeaconAttachment)

The attachments that corresponded to the request params.

Authorization

Requires the following OAuth scope:

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

For more information, see the Auth Guide.