Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3fd6a1cbaf1cad64f2d317536ede294a1f030983 / . / docs / dyn / proximitybeacon_v1beta1.beaconinfo.html
blob: 41ba21be527b310121ed0280bc3d5513b450eab4 [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.beaconinfo.html">beaconinfo</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#getforobserved">getforobserved(body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Given one or more beacon observations, returns any beacon information</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="getforobserved">getforobserved(body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]83 <pre>Given one or more beacon observations, returns any beacon information
84and attachments accessible to your application. Authorize by using the
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]85[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86for the application.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]87
88Args:
89 body: object, The request body. (required)
90 The object takes the form of:
91
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92{ # Request for beacon and attachment information about beacons that
93 # a mobile client has encountered "in the wild".
94 "observations": [ # The beacons that the client has encountered.
95 # At least one must be given.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96 { # Represents one beacon observed once.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The ID advertised by the beacon the client has encountered.
98 #
99 # If the submitted `advertised_id` type is Eddystone-EID, then the client
100 # must be authorized to resolve the given beacon. Otherwise no data will be
101 # returned for that beacon.
102 # Required.
103 "type": "A String", # Specifies the identifier type.
104 # Required.
105 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be
106 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
107 # requests, and will be so encoded (with padding) in responses. The base64
108 # encoding should be of the binary byte-stream and not any textual (such as
109 # hex) representation thereof.
110 # Required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]111 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]112 "telemetry": "A String", # The array of telemetry bytes received from the beacon. The server is
113 # responsible for parsing it. This field may frequently be empty, as
114 # with a beacon that transmits telemetry only occasionally.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]115 "timestampMs": "A String", # Time when the beacon was observed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]116 },
117 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]118 "namespacedTypes": [ # Specifies what kind of attachments to include in the response.
119 # When given, the response will include only attachments of the given types.
120 # When empty, no attachments will be returned. Must be in the format
121 # <var>namespace/type</var>. Accepts `*` to specify all types in
122 # all namespaces owned by the client.
123 # Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]124 "A String",
125 ],
126 }
127
128 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]132
133Returns:
134 An object of the form:
135
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]136 { # Information about the requested beacons, optionally including attachment
137 # data.
138 "beacons": [ # Public information about beacons.
139 # May be empty if the request matched no beacons.
140 { # A subset of beacon information served via the `beaconinfo.getforobserved`
141 # method, which you call when users of your app encounter your beacons.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]142 "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The ID advertised by the beacon.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]143 "type": "A String", # Specifies the identifier type.
144 # Required.
145 "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be
146 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
147 # requests, and will be so encoded (with padding) in responses. The base64
148 # encoding should be of the binary byte-stream and not any textual (such as
149 # hex) representation thereof.
150 # Required.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]151 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]152 "attachments": [ # Attachments matching the type(s) requested.
153 # May be empty if no attachment types were requested.
154 { # A subset of attachment information served via the
155 # `beaconinfo.getforobserved` method, used when your users encounter your
156 # beacons.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 "maxDistanceMeters": 3.14, # The distance away from the beacon at which this attachment should be
158 # delivered to a mobile app.
159 #
160 # Setting this to a value greater than zero indicates that the app should
161 # behave as if the beacon is "seen" when the mobile device is less than this
162 # distance away from the beacon.
163 #
164 # Different attachments on the same beacon can have different max distances.
165 #
166 # Note that even though this value is expressed with fractional meter
167 # precision, real-world behavior is likley to be much less precise than one
168 # meter, due to the nature of current Bluetooth radio technology.
169 #
170 # Optional. When not set or zero, the attachment should be delivered at the
171 # beacon's outer limit of detection.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 "data": "A String", # An opaque data container for client-provided data.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]173 "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
174 # interpret the `data` field. Format is <var>namespace/type</var>, for
175 # example <code>scrupulous-wombat-12345/welcome-message</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]176 },
177 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178 "beaconName": "A String", # The name under which the beacon is registered.
179 },
180 ],
181 }</pre>
182</div>
183
184</body></html>