Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.assets.html">assets</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 81 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Returns detailed information about an asset given its name.</p> |
| 83 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 84 | <code><a href="#list">list(keywords=None, pageToken=None, format=None, category=None, pageSize=None, maxComplexity=None, curated=None, orderBy=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Lists all public, remixable assets. These are assets with an access level</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 96 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 97 | <pre>Returns detailed information about an asset given its name. |
| 98 | PRIVATE assets are returned only if |
| 99 | the currently authenticated user (via OAuth token) is the author of the |
| 100 | asset. |
| 101 | |
| 102 | Args: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | name: string, Required. An asset's name in the form `assets/{ASSET_ID}`. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | x__xgafv: string, V1 error format. |
| 105 | Allowed values |
| 106 | 1 - v1 error format |
| 107 | 2 - v2 error format |
| 108 | |
| 109 | Returns: |
| 110 | An object of the form: |
| 111 | |
| 112 | { # Represents and describes an asset in the Poly library. An asset is a 3D model |
| 113 | # or scene created using [Tilt Brush](//www.tiltbrush.com), |
| 114 | # [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file |
| 115 | # that can be upload to Poly. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | "presentationParams": { # 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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | # immutable; the author of an asset may change them post-publication. |
| 118 | # was uploaded. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | "orientingRotation": { # 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. |
| 120 | # More precisely, this quaternion transforms from "object space" (the space |
| 121 | # in which the object is defined) to "presentation space", a coordinate |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | # system where +Y is up, +X is right, -Z is forward. For example, if |
| 123 | # the object is the Eiffel Tower, in its local coordinate system the |
| 124 | # object might be laid out such that the base of the tower is on the |
| 125 | # YZ plane and the tip of the tower is towards positive X. In this case |
| 126 | # this quaternion would specify a rotation (of 90 degrees about the Z |
| 127 | # axis) such that in the presentation space the base of the tower is |
| 128 | # aligned with the XZ plane, and the tip of the tower lies towards +Y. |
| 129 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 130 | # This rotation is unrelated to the object's pose in the web preview, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | # which is just a camera position setting and is *not* reflected in this |
| 132 | # rotation. |
| 133 | # |
| 134 | # Please note: this is applicable only to the gLTF. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | # response you see "w: 1" and nothing else this is the default value of |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | # [0, 0, 0, 1] where x,y, and z are 0. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 137 | "z": 3.14, # The z component. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 138 | "y": 3.14, # The y component. |
| 139 | "w": 3.14, # The scalar component. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 140 | "x": 3.14, # The x component. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 141 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | "backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a |
| 143 | # 'thumbnail' or 'palette' style view. Authors have the option to set this |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 144 | # background color when publishing or editing their asset. |
| 145 | # |
| 146 | # This is represented as a six-digit hexademical triplet specifying the |
| 147 | # RGB components of the background color, e.g. #FF0000 for Red. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 148 | "colorSpace": "A String", # The materials' diffuse/albedo color. This does not apply to vertex colors |
| 149 | # or texture maps. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 150 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 151 | "isCurated": True or False, # Whether this asset has been curated by the Poly team. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 152 | "metadata": "A String", # Application-defined opaque metadata for this asset. This field is only |
| 153 | # returned when querying for the signed-in user's own assets, not for public |
| 154 | # assets. This string is limited to 1K chars. It is up to the creator of |
| 155 | # the asset to define the format for this string (for example, JSON). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 156 | "name": "A String", # The unique identifier for the asset in the form: |
| 157 | # `assets/{ASSET_ID}`. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 158 | "remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset. |
| 159 | # create this asset). |
| 160 | "sourceAsset": [ # Resource ids for the sources of this remix, of the form: |
| 161 | # `assets/{ASSET_ID}` |
| 162 | "A String", |
| 163 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 164 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 165 | "authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the |
| 166 | # author. For more information, see [Licensing](/poly/discover/licensing). |
| 167 | "license": "A String", # The license under which the author has made the asset available |
| 168 | # for use, if any. |
| 169 | "createTime": "A String", # For published assets, the time when the asset was published. |
| 170 | # For unpublished assets, the time when the asset was created. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 171 | "formats": [ # A list of Formats where each |
| 172 | # format describes one representation of the asset. |
| 173 | { # The same asset can be represented in different formats, for example, |
| 174 | # a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its |
| 175 | # corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file |
| 176 | # with its corresponding .glb binary data. A format refers to a specific |
| 177 | # representation of an asset and contains all information needed to |
| 178 | # retrieve and describe this representation. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 179 | "formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset. |
| 180 | "triangleCount": "A String", # The estimated number of triangles. |
| 181 | "lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this |
| 182 | # format relative to other formats of the same asset with the same |
| 183 | # format_type. |
| 184 | # This hint allows you to sort formats from the most-detailed (0) to |
| 185 | # least-detailed (integers greater than 0). |
| 186 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 187 | "resources": [ # A list of dependencies of the root element. May include, but is not |
| 188 | # limited to, materials, textures, and shader programs. |
| 189 | { # Represents a file in Poly, which can be a root, |
| 190 | # resource, or thumbnail file. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 191 | "relativePath": "A String", # The path of the resource file relative to the |
| 192 | # root file. For root or thumbnail files, |
| 193 | # this is just the filename. |
| 194 | "contentType": "A String", # The MIME content-type, such as `image/png`. |
| 195 | # For more information, see |
| 196 | # [MIME |
| 197 | # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 198 | "url": "A String", # The URL where the file data can be retrieved. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 199 | }, |
| 200 | ], |
| 201 | "root": { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated. |
| 202 | # For some format_types - such as `TILT`, which are |
| 203 | # self-contained - this is all of the data. |
| 204 | # |
| 205 | # Other types - such as `OBJ` - often reference other data elements. |
| 206 | # These are contained in the resources field. |
| 207 | # resource, or thumbnail file. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 208 | "relativePath": "A String", # The path of the resource file relative to the |
| 209 | # root file. For root or thumbnail files, |
| 210 | # this is just the filename. |
| 211 | "contentType": "A String", # The MIME content-type, such as `image/png`. |
| 212 | # For more information, see |
| 213 | # [MIME |
| 214 | # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 215 | "url": "A String", # The URL where the file data can be retrieved. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 216 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 217 | "formatType": "A String", # A short string that identifies the format type of this representation. |
| 218 | # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 219 | }, |
| 220 | ], |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 221 | "visibility": "A String", # The visibility of the asset and who can access it. |
| 222 | "updateTime": "A String", # The time when the asset was last modified. For published assets, whose |
| 223 | # contents are immutable, the update time changes only when metadata |
| 224 | # properties, such as visibility, are updated. |
| 225 | "thumbnail": { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset. |
| 226 | # resource, or thumbnail file. |
| 227 | "relativePath": "A String", # The path of the resource file relative to the |
| 228 | # root file. For root or thumbnail files, |
| 229 | # this is just the filename. |
| 230 | "contentType": "A String", # 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). |
| 234 | "url": "A String", # The URL where the file data can be retrieved. |
| 235 | }, |
| 236 | "description": "A String", # The human-readable description, set by the asset's author. |
| 237 | "displayName": "A String", # The human-readable name, set by the asset's author. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 238 | }</pre> |
| 239 | </div> |
| 240 | |
| 241 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 242 | <code class="details" id="list">list(keywords=None, pageToken=None, format=None, category=None, pageSize=None, maxComplexity=None, curated=None, orderBy=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 243 | <pre>Lists all public, remixable assets. These are assets with an access level |
| 244 | of PUBLIC and published under the |
| 245 | CC-By license. |
| 246 | |
| 247 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 248 | keywords: string, One or more search terms to be matched against all text that Poly has |
| 249 | indexed for assets, which includes display_name, |
| 250 | description, and tags. Multiple keywords should be |
| 251 | separated by spaces. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 252 | pageToken: string, Specifies a continuation token from a previous search whose results were |
| 253 | split into multiple pages. To get the next page, submit the same request |
| 254 | specifying the value from |
| 255 | next_page_token. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 256 | format: string, Return only assets with the matching format. Acceptable values are: |
| 257 | `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 258 | category: string, Filter assets based on the specified category. Supported values are: |
| 259 | `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, |
| 260 | `scenes`, `technology`, and `transport`. |
| 261 | pageSize: integer, The maximum number of assets to be returned. This value must be between `1` |
| 262 | and `100`. Defaults to `20`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 263 | maxComplexity: string, Returns assets that are of the specified complexity or less. Defaults to |
| 264 | COMPLEX. For example, a request for |
| 265 | MEDIUM assets also includes |
| 266 | SIMPLE assets. |
| 267 | curated: boolean, Return only assets that have been curated by the Poly team. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 268 | orderBy: string, Specifies an ordering for assets. Acceptable values are: |
| 269 | `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets |
| 270 | based on a combination of popularity and other features. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 271 | x__xgafv: string, V1 error format. |
| 272 | Allowed values |
| 273 | 1 - v1 error format |
| 274 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 275 | |
| 276 | Returns: |
| 277 | An object of the form: |
| 278 | |
| 279 | { # A response message from a request to list. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 280 | "nextPageToken": "A String", # The continuation token for retrieving the next page. If empty, |
| 281 | # indicates that there are no more pages. To get the next page, submit the |
| 282 | # same request specifying this value as the |
| 283 | # page_token. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 284 | "assets": [ # A list of assets that match the criteria specified in the request. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 285 | { # Represents and describes an asset in the Poly library. An asset is a 3D model |
| 286 | # or scene created using [Tilt Brush](//www.tiltbrush.com), |
| 287 | # [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file |
| 288 | # that can be upload to Poly. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 289 | "presentationParams": { # 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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 290 | # immutable; the author of an asset may change them post-publication. |
| 291 | # was uploaded. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 292 | "orientingRotation": { # 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. |
| 293 | # More precisely, this quaternion transforms from "object space" (the space |
| 294 | # in which the object is defined) to "presentation space", a coordinate |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 295 | # system where +Y is up, +X is right, -Z is forward. For example, if |
| 296 | # the object is the Eiffel Tower, in its local coordinate system the |
| 297 | # object might be laid out such that the base of the tower is on the |
| 298 | # YZ plane and the tip of the tower is towards positive X. In this case |
| 299 | # this quaternion would specify a rotation (of 90 degrees about the Z |
| 300 | # axis) such that in the presentation space the base of the tower is |
| 301 | # aligned with the XZ plane, and the tip of the tower lies towards +Y. |
| 302 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 303 | # This rotation is unrelated to the object's pose in the web preview, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 304 | # which is just a camera position setting and is *not* reflected in this |
| 305 | # rotation. |
| 306 | # |
| 307 | # Please note: this is applicable only to the gLTF. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 308 | # response you see "w: 1" and nothing else this is the default value of |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 309 | # [0, 0, 0, 1] where x,y, and z are 0. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 310 | "z": 3.14, # The z component. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 311 | "y": 3.14, # The y component. |
| 312 | "w": 3.14, # The scalar component. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 313 | "x": 3.14, # The x component. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 314 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 315 | "backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a |
| 316 | # 'thumbnail' or 'palette' style view. Authors have the option to set this |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 317 | # background color when publishing or editing their asset. |
| 318 | # |
| 319 | # This is represented as a six-digit hexademical triplet specifying the |
| 320 | # RGB components of the background color, e.g. #FF0000 for Red. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 321 | "colorSpace": "A String", # The materials' diffuse/albedo color. This does not apply to vertex colors |
| 322 | # or texture maps. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 323 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 324 | "isCurated": True or False, # Whether this asset has been curated by the Poly team. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 325 | "metadata": "A String", # Application-defined opaque metadata for this asset. This field is only |
| 326 | # returned when querying for the signed-in user's own assets, not for public |
| 327 | # assets. This string is limited to 1K chars. It is up to the creator of |
| 328 | # the asset to define the format for this string (for example, JSON). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 329 | "name": "A String", # The unique identifier for the asset in the form: |
| 330 | # `assets/{ASSET_ID}`. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 331 | "remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset. |
| 332 | # create this asset). |
| 333 | "sourceAsset": [ # Resource ids for the sources of this remix, of the form: |
| 334 | # `assets/{ASSET_ID}` |
| 335 | "A String", |
| 336 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 337 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 338 | "authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the |
| 339 | # author. For more information, see [Licensing](/poly/discover/licensing). |
| 340 | "license": "A String", # The license under which the author has made the asset available |
| 341 | # for use, if any. |
| 342 | "createTime": "A String", # For published assets, the time when the asset was published. |
| 343 | # For unpublished assets, the time when the asset was created. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 344 | "formats": [ # A list of Formats where each |
| 345 | # format describes one representation of the asset. |
| 346 | { # The same asset can be represented in different formats, for example, |
| 347 | # a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its |
| 348 | # corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file |
| 349 | # with its corresponding .glb binary data. A format refers to a specific |
| 350 | # representation of an asset and contains all information needed to |
| 351 | # retrieve and describe this representation. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 352 | "formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset. |
| 353 | "triangleCount": "A String", # The estimated number of triangles. |
| 354 | "lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this |
| 355 | # format relative to other formats of the same asset with the same |
| 356 | # format_type. |
| 357 | # This hint allows you to sort formats from the most-detailed (0) to |
| 358 | # least-detailed (integers greater than 0). |
| 359 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 360 | "resources": [ # A list of dependencies of the root element. May include, but is not |
| 361 | # limited to, materials, textures, and shader programs. |
| 362 | { # Represents a file in Poly, which can be a root, |
| 363 | # resource, or thumbnail file. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 364 | "relativePath": "A String", # The path of the resource file relative to the |
| 365 | # root file. For root or thumbnail files, |
| 366 | # this is just the filename. |
| 367 | "contentType": "A String", # The MIME content-type, such as `image/png`. |
| 368 | # For more information, see |
| 369 | # [MIME |
| 370 | # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 371 | "url": "A String", # The URL where the file data can be retrieved. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 372 | }, |
| 373 | ], |
| 374 | "root": { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated. |
| 375 | # For some format_types - such as `TILT`, which are |
| 376 | # self-contained - this is all of the data. |
| 377 | # |
| 378 | # Other types - such as `OBJ` - often reference other data elements. |
| 379 | # These are contained in the resources field. |
| 380 | # resource, or thumbnail file. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 381 | "relativePath": "A String", # The path of the resource file relative to the |
| 382 | # root file. For root or thumbnail files, |
| 383 | # this is just the filename. |
| 384 | "contentType": "A String", # The MIME content-type, such as `image/png`. |
| 385 | # For more information, see |
| 386 | # [MIME |
| 387 | # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 388 | "url": "A String", # The URL where the file data can be retrieved. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 389 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 390 | "formatType": "A String", # A short string that identifies the format type of this representation. |
| 391 | # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 392 | }, |
| 393 | ], |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 394 | "visibility": "A String", # The visibility of the asset and who can access it. |
| 395 | "updateTime": "A String", # The time when the asset was last modified. For published assets, whose |
| 396 | # contents are immutable, the update time changes only when metadata |
| 397 | # properties, such as visibility, are updated. |
| 398 | "thumbnail": { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset. |
| 399 | # resource, or thumbnail file. |
| 400 | "relativePath": "A String", # The path of the resource file relative to the |
| 401 | # root file. For root or thumbnail files, |
| 402 | # this is just the filename. |
| 403 | "contentType": "A String", # The MIME content-type, such as `image/png`. |
| 404 | # For more information, see |
| 405 | # [MIME |
| 406 | # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). |
| 407 | "url": "A String", # The URL where the file data can be retrieved. |
| 408 | }, |
| 409 | "description": "A String", # The human-readable description, set by the asset's author. |
| 410 | "displayName": "A String", # The human-readable name, set by the asset's author. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 411 | }, |
| 412 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 413 | "totalSize": 42, # The total number of assets in the list, without pagination. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 414 | }</pre> |
| 415 | </div> |
| 416 | |
| 417 | <div class="method"> |
| 418 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 419 | <pre>Retrieves the next page of results. |
| 420 | |
| 421 | Args: |
| 422 | previous_request: The request for the previous page. (required) |
| 423 | previous_response: The response from the request for the previous page. (required) |
| 424 | |
| 425 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 426 | A request object that you can call 'execute()' on to request the next |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 427 | page. Returns None if there are no more items in the collection. |
| 428 | </pre> |
| 429 | </div> |
| 430 | |
| 431 | </body></html> |