blob: 3386b602c27a0d3a25ec25a13c19db1741489187 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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
75<h1><a href="poly_v1.html">Poly API</a> . <a href="poly_v1.users.html">users</a> . <a href="poly_v1.users.assets.html">assets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#list">list(name, pageToken=None, orderBy=None, format=None, visibility=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Lists assets authored by the given user. Only the value 'me', representing</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93 <code class="details" id="list">list(name, pageToken=None, orderBy=None, format=None, visibility=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -070094 <pre>Lists assets authored by the given user. Only the value &#x27;me&#x27;, representing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095the currently-authenticated user, is supported. May include assets with an
96access level of PRIVATE or
97UNLISTED and assets which are
98All Rights Reserved for the
99currently-authenticated user.
100
101Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700102 name: string, A valid user id. Currently, only the special value &#x27;me&#x27;, representing the
103currently-authenticated user is supported. To use &#x27;me&#x27;, you must pass
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104an OAuth token with the request. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700105 pageToken: string, Specifies a continuation token from a previous search whose results were
106split into multiple pages. To get the next page, submit the same request
107specifying the value from
108next_page_token.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109 orderBy: string, Specifies an ordering for assets. Acceptable values are:
110`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets
111based on a combination of popularity and other features.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112 format: string, Return only assets with the matching format. Acceptable values are:
113`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 visibility: string, The visibility of the assets to be returned.
115Defaults to
116VISIBILITY_UNSPECIFIED
117which returns all assets.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700118 pageSize: integer, The maximum number of assets to be returned. This value must be between `1`
119and `100`. Defaults to `20`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125Returns:
126 An object of the form:
127
128 { # A response message from a request to list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700129 &quot;userAssets&quot;: [ # A list of UserAssets matching the request.
130 { # Data about the user&#x27;s asset.
131 &quot;asset&quot;: { # Represents and describes an asset in the Poly library. An asset is a 3D model # An Asset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700132 # or scene created using [Tilt Brush](//www.tiltbrush.com),
133 # [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file
134 # that can be upload to Poly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 &quot;presentationParams&quot;: { # Hints for displaying the asset, based on information available when the asset # Hints for displaying the asset. Note that these parameters are not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700136 # immutable; the author of an asset may change them post-publication.
137 # was uploaded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700138 &quot;orientingRotation&quot;: { # A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the # A rotation that should be applied to the object root to make it upright.
139 # More precisely, this quaternion transforms from &quot;object space&quot; (the space
140 # in which the object is defined) to &quot;presentation space&quot;, a coordinate
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141 # system where +Y is up, +X is right, -Z is forward. For example, if
142 # the object is the Eiffel Tower, in its local coordinate system the
143 # object might be laid out such that the base of the tower is on the
144 # YZ plane and the tip of the tower is towards positive X. In this case
145 # this quaternion would specify a rotation (of 90 degrees about the Z
146 # axis) such that in the presentation space the base of the tower is
147 # aligned with the XZ plane, and the tip of the tower lies towards +Y.
148 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700149 # This rotation is unrelated to the object&#x27;s pose in the web preview,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700150 # which is just a camera position setting and is *not* reflected in this
151 # rotation.
152 #
153 # Please note: this is applicable only to the gLTF.
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 # response you see &quot;w: 1&quot; and nothing else this is the default value of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700155 # [0, 0, 0, 1] where x,y, and z are 0.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700156 &quot;z&quot;: 3.14, # The z component.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700157 &quot;y&quot;: 3.14, # The y component.
158 &quot;w&quot;: 3.14, # The scalar component.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700159 &quot;x&quot;: 3.14, # The x component.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700161 &quot;backgroundColor&quot;: &quot;A String&quot;, # A background color which could be used for displaying the 3D asset in a
162 # &#x27;thumbnail&#x27; or &#x27;palette&#x27; style view. Authors have the option to set this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700163 # background color when publishing or editing their asset.
164 #
165 # This is represented as a six-digit hexademical triplet specifying the
166 # RGB components of the background color, e.g. #FF0000 for Red.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700167 &quot;colorSpace&quot;: &quot;A String&quot;, # The materials&#x27; diffuse/albedo color. This does not apply to vertex colors
168 # or texture maps.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700169 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700170 &quot;isCurated&quot;: True or False, # Whether this asset has been curated by the Poly team.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700171 &quot;metadata&quot;: &quot;A String&quot;, # Application-defined opaque metadata for this asset. This field is only
172 # returned when querying for the signed-in user&#x27;s own assets, not for public
173 # assets. This string is limited to 1K chars. It is up to the creator of
174 # the asset to define the format for this string (for example, JSON).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700175 &quot;name&quot;: &quot;A String&quot;, # The unique identifier for the asset in the form:
176 # `assets/{ASSET_ID}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700177 &quot;remixInfo&quot;: { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset.
178 # create this asset).
179 &quot;sourceAsset&quot;: [ # Resource ids for the sources of this remix, of the form:
180 # `assets/{ASSET_ID}`
181 &quot;A String&quot;,
182 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700184 &quot;authorName&quot;: &quot;A String&quot;, # The author&#x27;s publicly visible name. Use this name when giving credit to the
185 # author. For more information, see [Licensing](/poly/discover/licensing).
186 &quot;license&quot;: &quot;A String&quot;, # The license under which the author has made the asset available
187 # for use, if any.
188 &quot;createTime&quot;: &quot;A String&quot;, # For published assets, the time when the asset was published.
189 # For unpublished assets, the time when the asset was created.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700190 &quot;formats&quot;: [ # A list of Formats where each
191 # format describes one representation of the asset.
192 { # The same asset can be represented in different formats, for example,
193 # a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its
194 # corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file
195 # with its corresponding .glb binary data. A format refers to a specific
196 # representation of an asset and contains all information needed to
197 # retrieve and describe this representation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700198 &quot;formatComplexity&quot;: { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.
199 &quot;triangleCount&quot;: &quot;A String&quot;, # The estimated number of triangles.
200 &quot;lodHint&quot;: 42, # A non-negative integer that represents the level of detail (LOD) of this
201 # format relative to other formats of the same asset with the same
202 # format_type.
203 # This hint allows you to sort formats from the most-detailed (0) to
204 # least-detailed (integers greater than 0).
205 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700206 &quot;resources&quot;: [ # A list of dependencies of the root element. May include, but is not
207 # limited to, materials, textures, and shader programs.
208 { # Represents a file in Poly, which can be a root,
209 # resource, or thumbnail file.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700210 &quot;relativePath&quot;: &quot;A String&quot;, # The path of the resource file relative to the
211 # root file. For root or thumbnail files,
212 # this is just the filename.
213 &quot;contentType&quot;: &quot;A String&quot;, # The MIME content-type, such as `image/png`.
214 # For more information, see
215 # [MIME
216 # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700217 &quot;url&quot;: &quot;A String&quot;, # The URL where the file data can be retrieved.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700218 },
219 ],
220 &quot;root&quot;: { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated.
221 # For some format_types - such as `TILT`, which are
222 # self-contained - this is all of the data.
223 #
224 # Other types - such as `OBJ` - often reference other data elements.
225 # These are contained in the resources field.
226 # resource, or thumbnail file.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700227 &quot;relativePath&quot;: &quot;A String&quot;, # The path of the resource file relative to the
228 # root file. For root or thumbnail files,
229 # this is just the filename.
230 &quot;contentType&quot;: &quot;A String&quot;, # The MIME content-type, such as `image/png`.
231 # For more information, see
232 # [MIME
233 # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234 &quot;url&quot;: &quot;A String&quot;, # The URL where the file data can be retrieved.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700235 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700236 &quot;formatType&quot;: &quot;A String&quot;, # A short string that identifies the format type of this representation.
237 # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700238 },
239 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700240 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of the asset and who can access it.
241 &quot;updateTime&quot;: &quot;A String&quot;, # The time when the asset was last modified. For published assets, whose
242 # contents are immutable, the update time changes only when metadata
243 # properties, such as visibility, are updated.
244 &quot;thumbnail&quot;: { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset.
245 # resource, or thumbnail file.
246 &quot;relativePath&quot;: &quot;A String&quot;, # The path of the resource file relative to the
247 # root file. For root or thumbnail files,
248 # this is just the filename.
249 &quot;contentType&quot;: &quot;A String&quot;, # The MIME content-type, such as `image/png`.
250 # For more information, see
251 # [MIME
252 # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
253 &quot;url&quot;: &quot;A String&quot;, # The URL where the file data can be retrieved.
254 },
255 &quot;description&quot;: &quot;A String&quot;, # The human-readable description, set by the asset&#x27;s author.
256 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name, set by the asset&#x27;s author.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700257 },
258 },
259 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700260 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token for retrieving the next page. If empty,
261 # indicates that there are no more pages. To get the next page, submit the
262 # same request specifying this value as the
263 # page_token.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700264 &quot;totalSize&quot;: 42, # The total number of assets in the list, without pagination.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
270 <pre>Retrieves the next page of results.
271
272Args:
273 previous_request: The request for the previous page. (required)
274 previous_response: The response from the request for the previous page. (required)
275
276Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700277 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700278 page. Returns None if there are no more items in the collection.
279 </pre>
280</div>
281
282</body></html>