Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / proximitybeacon_v1beta1.beacons.attachments.html
blob: edb20922233cdaca1def5be12bad1ef46fcb64d9 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]75<h1><a href="proximitybeacon_v1beta1.html">Proximity Beacon API</a> . <a href="proximitybeacon_v1beta1.beacons.html">beacons</a> . <a href="proximitybeacon_v1beta1.beacons.attachments.html">attachments</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#batchDelete">batchDelete(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Deletes multiple attachments on a given beacon. This operation is</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#create">create(beaconName, body, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Associates the given data with the specified beacon. Attachment data must</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#delete">delete(attachmentName, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Deletes the specified attachment for the given beacon. Each attachment has</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]86<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]87 <code><a href="#list">list(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Returns the attachments for the specified beacon that match the specified</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]91 <code class="details" id="batchDelete">batchDelete(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92 <pre>Deletes multiple attachments on a given beacon. This operation is
93permanent and cannot be undone.
94
95You can optionally specify `namespacedType` to choose which attachments
96should be deleted. If you do not specify `namespacedType`, all your
97attachments on the given beacon will be deleted. You also may explicitly
98specify `*/*` to delete all.
99
100Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
101from a signed-in user with **Is owner** or **Can edit** permissions in the
102Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]103
104Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105 beaconName: string, The beacon whose attachments should be deleted. A beacon name has the
106format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
107by the beacon and N is a code for the beacon's type. Possible values are
108`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
109for AltBeacon. For Eddystone-EID beacons, you may use either the
110current EID or the beacon's "stable" UID.
111Required. (required)
112 namespacedType: string, Specifies the namespace and type of attachments to delete in
113`namespace/type` format. Accepts `*/*` to specify
114"all types in all namespaces".
115Optional.
116 projectId: string, The project id to delete beacon attachments under. This field can be
117used when "*" is specified to mean all attachment namespaces. Projects
118may have multiple attachments with multiple namespaces. If "*" is
119specified and the projectId string is empty, then the project
120making the request is used.
121Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]122 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]126
127Returns:
128 An object of the form:
129
130 { # Response for a request to delete attachments.
131 "numDeleted": 42, # The number of attachments that were deleted.
132 }</pre>
133</div>
134
135<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]136 <code class="details" id="create">create(beaconName, body, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 <pre>Associates the given data with the specified beacon. Attachment data must
138contain two parts:
139<ul>
140<li>A namespaced type.</li>
141<li>The actual attachment data itself.</li>
142</ul>
143The namespaced type consists of two parts, the namespace and the type.
144The namespace must be one of the values returned by the `namespaces`
145endpoint, while the type can be a string of any characters except for the
146forward slash (`/`) up to 100 characters in length.
147
148Attachment data can be up to 1024 bytes long.
149
150Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
151from a signed-in user with **Is owner** or **Can edit** permissions in the
152Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]153
154Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]155 beaconName: string, Beacon on which the attachment should be created. A beacon name has the
156format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
157by the beacon and N is a code for the beacon's type. Possible values are
158`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
159for AltBeacon. For Eddystone-EID beacons, you may use either the
160current EID or the beacon's "stable" UID.
161Required. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]162 body: object, The request body. (required)
163 The object takes the form of:
164
165{ # Project-specific data associated with a beacon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]166 "maxDistanceMeters": 3.14, # The distance away from the beacon at which this attachment should be
167 # delivered to a mobile app.
168 #
169 # Setting this to a value greater than zero indicates that the app should
170 # behave as if the beacon is "seen" when the mobile device is less than this
171 # distance away from the beacon.
172 #
173 # Different attachments on the same beacon can have different max distances.
174 #
175 # Note that even though this value is expressed with fractional meter
176 # precision, real-world behavior is likley to be much less precise than one
177 # meter, due to the nature of current Bluetooth radio technology.
178 #
179 # Optional. When not set or zero, the attachment should be delivered at the
180 # beacon's outer limit of detection.
181 #
182 # Negative values are invalid and return an error.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]183 "data": "A String", # An opaque data container for client-provided data. Must be
184 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
185 # requests, and will be so encoded (with padding) in responses.
186 # Required.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]187 "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
188 # UNIX epoch.
189 "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
190 # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
191 # Leave this empty on creation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]192 "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
193 # interpret the `data` field. Format is <var>namespace/type</var>. Namespace
194 # provides type separation between clients. Type describes the type of
195 # `data`, for use by the client when parsing the `data` field.
196 # Required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]197 }
198
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]199 projectId: string, The project id of the project the attachment will belong to. If
200the project id is not specified then the project making the request
201is used.
202Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]203 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]207
208Returns:
209 An object of the form:
210
211 { # Project-specific data associated with a beacon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]212 "maxDistanceMeters": 3.14, # The distance away from the beacon at which this attachment should be
213 # delivered to a mobile app.
214 #
215 # Setting this to a value greater than zero indicates that the app should
216 # behave as if the beacon is "seen" when the mobile device is less than this
217 # distance away from the beacon.
218 #
219 # Different attachments on the same beacon can have different max distances.
220 #
221 # Note that even though this value is expressed with fractional meter
222 # precision, real-world behavior is likley to be much less precise than one
223 # meter, due to the nature of current Bluetooth radio technology.
224 #
225 # Optional. When not set or zero, the attachment should be delivered at the
226 # beacon's outer limit of detection.
227 #
228 # Negative values are invalid and return an error.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]229 "data": "A String", # An opaque data container for client-provided data. Must be
230 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
231 # requests, and will be so encoded (with padding) in responses.
232 # Required.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]233 "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
234 # UNIX epoch.
235 "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
236 # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
237 # Leave this empty on creation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]238 "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
239 # interpret the `data` field. Format is <var>namespace/type</var>. Namespace
240 # provides type separation between clients. Type describes the type of
241 # `data`, for use by the client when parsing the `data` field.
242 # Required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]243 }</pre>
244</div>
245
246<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]247 <code class="details" id="delete">delete(attachmentName, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]248 <pre>Deletes the specified attachment for the given beacon. Each attachment has
249a unique attachment name (`attachmentName`) which is returned when you
250fetch the attachment data via this API. You specify this with the delete
251request to control which attachment is removed. This operation cannot be
252undone.
253
254Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
255from a signed-in user with **Is owner** or **Can edit** permissions in the
256Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]257
258Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]259 attachmentName: string, The attachment name (`attachmentName`) of
260the attachment to remove. For example:
261`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For
262Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the
263beacon's current EID, or its "stable" Eddystone-UID.
264Required. (required)
265 projectId: string, The project id of the attachment to delete. If not provided, the project
266that is making the request is used.
267Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]268 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]272
273Returns:
274 An object of the form:
275
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]276 { # A generic empty message that you can re-use to avoid defining duplicated
277 # empty messages in your APIs. A typical example is to use it as the request
278 # or the response type of an API method. For instance:
279 #
280 # service Foo {
281 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
282 # }
283 #
284 # The JSON representation for `Empty` is empty JSON object `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]285 }</pre>
286</div>
287
288<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]289 <code class="details" id="list">list(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]290 <pre>Returns the attachments for the specified beacon that match the specified
291namespaced-type pattern.
292
293To control which namespaced types are returned, you add the
294`namespacedType` query parameter to the request. You must either use
295`*/*`, to return all attachments, or the namespace must be one of
296the ones returned from the `namespaces` endpoint.
297
298Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
299from a signed-in user with **viewer**, **Is owner** or **Can edit**
300permissions in the Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]301
302Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]303 beaconName: string, Beacon whose attachments should be fetched. A beacon name has the
304format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
305by the beacon and N is a code for the beacon's type. Possible values are
306`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
307for AltBeacon. For Eddystone-EID beacons, you may use either the
308current EID or the beacon's "stable" UID.
309Required. (required)
310 namespacedType: string, Specifies the namespace and type of attachment to include in response in
311<var>namespace/type</var> format. Accepts `*/*` to specify
312"all types in all namespaces".
313 projectId: string, The project id to list beacon attachments under. This field can be
314used when "*" is specified to mean all attachment namespaces. Projects
315may have multiple attachments with multiple namespaces. If "*" is
316specified and the projectId string is empty, then the project
317making the request is used.
318Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]319 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]320 Allowed values
321 1 - v1 error format
322 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]323
324Returns:
325 An object of the form:
326
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]327 { # Response to `ListBeaconAttachments` that contains the requested attachments.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]328 "attachments": [ # The attachments that corresponded to the request params.
329 { # Project-specific data associated with a beacon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]330 "maxDistanceMeters": 3.14, # The distance away from the beacon at which this attachment should be
331 # delivered to a mobile app.
332 #
333 # Setting this to a value greater than zero indicates that the app should
334 # behave as if the beacon is "seen" when the mobile device is less than this
335 # distance away from the beacon.
336 #
337 # Different attachments on the same beacon can have different max distances.
338 #
339 # Note that even though this value is expressed with fractional meter
340 # precision, real-world behavior is likley to be much less precise than one
341 # meter, due to the nature of current Bluetooth radio technology.
342 #
343 # Optional. When not set or zero, the attachment should be delivered at the
344 # beacon's outer limit of detection.
345 #
346 # Negative values are invalid and return an error.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]347 "data": "A String", # An opaque data container for client-provided data. Must be
348 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
349 # requests, and will be so encoded (with padding) in responses.
350 # Required.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]351 "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
352 # UNIX epoch.
353 "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
354 # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
355 # Leave this empty on creation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]356 "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
357 # interpret the `data` field. Format is <var>namespace/type</var>. Namespace
358 # provides type separation between clients. Type describes the type of
359 # `data`, for use by the client when parsing the `data` field.
360 # Required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]361 },
362 ],
363 }</pre>
364</div>
365
366</body></html>