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.
Scopes
You will need authorization for the https://www.googleapis.com/auth/userlocation.beacon.registry scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/userlocation.beacon.registry.
You can set the scope for this method like this: proximitybeacon1-beta1 --scope <scope> beacons attachments-list ...
Required Scalar Argument
- <beacon-name> (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, or5
for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
- 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
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p namespaced-type=string
- Specifies the namespace and type of attachment to include in response in
<var>namespace/type</var> format. Accepts
*/*
to specify "all types in all namespaces".
- Specifies the namespace and type of attachment to include in response in
<var>namespace/type</var> format. Accepts
-
-p project-id=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.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- 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.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- 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.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").