Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / poly_v1.users.assets.html
blob: 0d77477bdc9c81c1d650d72a18904e79b3cc7636 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]78 <code><a href="#list">list(name, format=None, pageToken=None, pageSize=None, visibility=None, orderBy=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Lists assets authored by the given user. Only the value 'me', representing</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]85 <code class="details" id="list">list(name, format=None, pageToken=None, pageSize=None, visibility=None, orderBy=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86 <pre>Lists assets authored by the given user. Only the value &#x27;me&#x27;, representing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87the currently-authenticated user, is supported. May include assets with an
88access level of PRIVATE or
89UNLISTED and assets which are
90All Rights Reserved for the
91currently-authenticated user.
92
93Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94 name: string, A valid user id. Currently, only the special value &#x27;me&#x27;, representing the
95currently-authenticated user is supported. To use &#x27;me&#x27;, you must pass
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96an OAuth token with the request. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]97 format: string, Return only assets with the matching format. Acceptable values are:
98`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
99 pageToken: string, Specifies a continuation token from a previous search whose results were
100split into multiple pages. To get the next page, submit the same request
101specifying the value from
102next_page_token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 pageSize: integer, The maximum number of assets to be returned. This value must be between `1`
104and `100`. Defaults to `20`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 visibility: string, The visibility of the assets to be returned.
106Defaults to
107VISIBILITY_UNSPECIFIED
108which returns all assets.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117Returns:
118 An object of the form:
119
120 { # A response message from a request to list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;totalSize&quot;: 42, # The total number of assets in the list, without pagination.
122 &quot;userAssets&quot;: [ # A list of UserAssets matching the request.
123 { # Data about the user&#x27;s asset.
124 &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 -0700[diff] [blame]125 # or scene created using [Tilt Brush](//www.tiltbrush.com),
126 # [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file
127 # that can be upload to Poly.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]128 &quot;remixInfo&quot;: { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset.
129 # create this asset).
130 &quot;sourceAsset&quot;: [ # Resource ids for the sources of this remix, of the form:
131 # `assets/{ASSET_ID}`
132 &quot;A String&quot;,
133 ],
134 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;thumbnail&quot;: { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 # resource, or thumbnail file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;relativePath&quot;: &quot;A String&quot;, # The path of the resource file relative to the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 # root file. For root or thumbnail files,
139 # this is just the filename.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;contentType&quot;: &quot;A String&quot;, # The MIME content-type, such as `image/png`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 # For more information, see
142 # [MIME
143 # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 &quot;url&quot;: &quot;A String&quot;, # The URL where the file data can be retrieved.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of the asset and who can access it.
147 &quot;name&quot;: &quot;A String&quot;, # The unique identifier for the asset in the form:
148 # `assets/{ASSET_ID}`.
149 &quot;isCurated&quot;: True or False, # Whether this asset has been curated by the Poly team.
150 &quot;description&quot;: &quot;A String&quot;, # The human-readable description, set by the asset&#x27;s author.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]151 &quot;createTime&quot;: &quot;A String&quot;, # For published assets, the time when the asset was published.
152 # For unpublished assets, the time when the asset was created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;metadata&quot;: &quot;A String&quot;, # Application-defined opaque metadata for this asset. This field is only
154 # returned when querying for the signed-in user&#x27;s own assets, not for public
155 # assets. This string is limited to 1K chars. It is up to the creator of
156 # the asset to define the format for this string (for example, JSON).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 &quot;formats&quot;: [ # A list of Formats where each
158 # format describes one representation of the asset.
159 { # The same asset can be represented in different formats, for example,
160 # a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its
161 # corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file
162 # with its corresponding .glb binary data. A format refers to a specific
163 # representation of an asset and contains all information needed to
164 # retrieve and describe this representation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;root&quot;: { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated.
166 # For some format_types - such as `TILT`, which are
167 # self-contained - this is all of the data.
168 #
169 # Other types - such as `OBJ` - often reference other data elements.
170 # These are contained in the resources field.
171 # resource, or thumbnail file.
172 &quot;relativePath&quot;: &quot;A String&quot;, # The path of the resource file relative to the
173 # root file. For root or thumbnail files,
174 # this is just the filename.
175 &quot;contentType&quot;: &quot;A String&quot;, # The MIME content-type, such as `image/png`.
176 # For more information, see
177 # [MIME
178 # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
179 &quot;url&quot;: &quot;A String&quot;, # The URL where the file data can be retrieved.
180 },
181 &quot;formatComplexity&quot;: { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.
182 &quot;triangleCount&quot;: &quot;A String&quot;, # The estimated number of triangles.
183 &quot;lodHint&quot;: 42, # A non-negative integer that represents the level of detail (LOD) of this
184 # format relative to other formats of the same asset with the same
185 # format_type.
186 # This hint allows you to sort formats from the most-detailed (0) to
187 # least-detailed (integers greater than 0).
188 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 &quot;resources&quot;: [ # A list of dependencies of the root element. May include, but is not
190 # limited to, materials, textures, and shader programs.
191 { # Represents a file in Poly, which can be a root,
192 # resource, or thumbnail file.
193 &quot;relativePath&quot;: &quot;A String&quot;, # The path of the resource file relative to the
194 # root file. For root or thumbnail files,
195 # this is just the filename.
196 &quot;contentType&quot;: &quot;A String&quot;, # The MIME content-type, such as `image/png`.
197 # For more information, see
198 # [MIME
199 # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
200 &quot;url&quot;: &quot;A String&quot;, # The URL where the file data can be retrieved.
201 },
202 ],
203 &quot;formatType&quot;: &quot;A String&quot;, # A short string that identifies the format type of this representation.
204 # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 },
206 ],
207 &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 -0700[diff] [blame]208 # immutable; the author of an asset may change them post-publication.
209 # was uploaded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 &quot;colorSpace&quot;: &quot;A String&quot;, # The materials&#x27; diffuse/albedo color. This does not apply to vertex colors
211 # or texture maps.
212 &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.
213 # More precisely, this quaternion transforms from &quot;object space&quot; (the space
214 # in which the object is defined) to &quot;presentation space&quot;, a coordinate
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 # system where +Y is up, +X is right, -Z is forward. For example, if
216 # the object is the Eiffel Tower, in its local coordinate system the
217 # object might be laid out such that the base of the tower is on the
218 # YZ plane and the tip of the tower is towards positive X. In this case
219 # this quaternion would specify a rotation (of 90 degrees about the Z
220 # axis) such that in the presentation space the base of the tower is
221 # aligned with the XZ plane, and the tip of the tower lies towards +Y.
222 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 # This rotation is unrelated to the object&#x27;s pose in the web preview,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 # which is just a camera position setting and is *not* reflected in this
225 # rotation.
226 #
227 # Please note: this is applicable only to the gLTF.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]228 # response you see &quot;w: 1&quot; and nothing else this is the default value of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 # [0, 0, 0, 1] where x,y, and z are 0.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]230 &quot;x&quot;: 3.14, # The x component.
231 &quot;w&quot;: 3.14, # The scalar component.
232 &quot;y&quot;: 3.14, # The y component.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]233 &quot;z&quot;: 3.14, # The z component.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 &quot;backgroundColor&quot;: &quot;A String&quot;, # A background color which could be used for displaying the 3D asset in a
236 # &#x27;thumbnail&#x27; or &#x27;palette&#x27; style view. Authors have the option to set this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 # background color when publishing or editing their asset.
238 #
239 # This is represented as a six-digit hexademical triplet specifying the
240 # RGB components of the background color, e.g. #FF0000 for Red.
241 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 &quot;license&quot;: &quot;A String&quot;, # The license under which the author has made the asset available
243 # for use, if any.
244 &quot;authorName&quot;: &quot;A String&quot;, # The author&#x27;s publicly visible name. Use this name when giving credit to the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245 # author. For more information, see [Licensing](/poly/discover/licensing).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]246 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name, set by the asset&#x27;s author.
247 &quot;updateTime&quot;: &quot;A String&quot;, # The time when the asset was last modified. For published assets, whose
248 # contents are immutable, the update time changes only when metadata
249 # properties, such as visibility, are updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 },
251 },
252 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token for retrieving the next page. If empty,
254 # indicates that there are no more pages. To get the next page, submit the
255 # same request specifying this value as the
256 # page_token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 }</pre>
258</div>
259
260<div class="method">
261 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
262 <pre>Retrieves the next page of results.
263
264Args:
265 previous_request: The request for the previous page. (required)
266 previous_response: The response from the request for the previous page. (required)
267
268Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 page. Returns None if there are no more items in the collection.
271 </pre>
272</div>
273
274</body></html>