Blame - docs/dyn/poly_v1.assets.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

83

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

84

<code><a href="#list">list(pageSize=None, orderBy=None, category=None, pageToken=None, curated=None, maxComplexity=None, format=None, keywords=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

85

<p class="firstline">Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

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

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>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

96

<code class="details" id="get">get(name, x__xgafv=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

97

<pre>Returns detailed information about an asset given its name. PRIVATE assets are returned only if the currently authenticated user (via OAuth token) is the author of the asset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

98

99

Args:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

100

name: string, Required. An asset's name in the form `assets/{ASSET_ID}`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

108

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

109

{ # Represents and describes an asset in the Poly library. An asset is a 3D model or scene created using [Tilt Brush](//www.tiltbrush.com), [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file that can be upload to Poly.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

110

"presentationParams": { # Hints for displaying the asset, based on information available when the asset was uploaded. # Hints for displaying the asset. Note that these parameters are not immutable; the author of an asset may change them post-publication.

111

"orientingRotation": { # A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the response you see "w: 1" and nothing else this is the default value of [0, 0, 0, 1] where x,y, and z are 0. # A rotation that should be applied to the object root to make it upright. More precisely, this quaternion transforms from "object space" (the space in which the object is defined) to "presentation space", a coordinate system where +Y is up, +X is right, -Z is forward. For example, if the object is the Eiffel Tower, in its local coordinate system the object might be laid out such that the base of the tower is on the YZ plane and the tip of the tower is towards positive X. In this case this quaternion would specify a rotation (of 90 degrees about the Z axis) such that in the presentation space the base of the tower is aligned with the XZ plane, and the tip of the tower lies towards +Y. This rotation is unrelated to the object's pose in the web preview, which is just a camera position setting and is *not* reflected in this rotation. Please note: this is applicable only to the gLTF.

112

"w": 3.14, # The scalar component.

113

"z": 3.14, # The z component.

114

"y": 3.14, # The y component.

115

"x": 3.14, # The x component.

116

},

117

"colorSpace": "A String", # The materials' diffuse/albedo color. This does not apply to vertex colors or texture maps.

118

"backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a 'thumbnail' or 'palette' style view. Authors have the option to set this background color when publishing or editing their asset. This is represented as a six-digit hexademical triplet specifying the RGB components of the background color, e.g. #FF0000 for Red.

119

},

120

"license": "A String", # The license under which the author has made the asset available for use, if any.

121

"visibility": "A String", # The visibility of the asset and who can access it.

122

"description": "A String", # The human-readable description, set by the asset's author.

123

"updateTime": "A String", # The time when the asset was last modified. For published assets, whose contents are immutable, the update time changes only when metadata properties, such as visibility, are updated.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

124

"remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to create this asset). # The remix info for the asset.

125

"sourceAsset": [ # Resource ids for the sources of this remix, of the form: `assets/{ASSET_ID}`

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

126

"A String",

127

],

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

128

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

129

"isCurated": True or False, # Whether this asset has been curated by the Poly team.

130

"displayName": "A String", # The human-readable name, set by the asset's author.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

131

"thumbnail": { # Represents a file in Poly, which can be a root, resource, or thumbnail file. # The thumbnail image for the asset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

132

"url": "A String", # The URL where the file data can be retrieved.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

133

"contentType": "A String", # The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

134

"relativePath": "A String", # The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

135

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

136

"name": "A String", # The unique identifier for the asset in the form: `assets/{ASSET_ID}`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

137

"metadata": "A String", # Application-defined opaque metadata for this asset. This field is only returned when querying for the signed-in user's own assets, not for public assets. This string is limited to 1K chars. It is up to the creator of the asset to define the format for this string (for example, JSON).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

138

"formats": [ # A list of Formats where each format describes one representation of the asset.

139

{ # The same asset can be represented in different formats, for example, a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file with its corresponding .glb binary data. A format refers to a specific representation of an asset and contains all information needed to retrieve and describe this representation.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

140

"formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.

141

"triangleCount": "A String", # The estimated number of triangles.

142

"lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this format relative to other formats of the same asset with the same format_type. This hint allows you to sort formats from the most-detailed (0) to least-detailed (integers greater than 0).

143

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

144

"resources": [ # A list of dependencies of the root element. May include, but is not limited to, materials, textures, and shader programs.

145

{ # Represents a file in Poly, which can be a root, resource, or thumbnail file.

146

"url": "A String", # The URL where the file data can be retrieved.

147

"contentType": "A String", # The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

148

"relativePath": "A String", # The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.

149

},

150

],

151

"root": { # Represents a file in Poly, which can be a root, resource, or thumbnail file. # The root of the file hierarchy. This will always be populated. For some format_types - such as `TILT`, which are self-contained - this is all of the data. Other types - such as `OBJ` - often reference other data elements. These are contained in the resources field.

152

"url": "A String", # The URL where the file data can be retrieved.

153

"contentType": "A String", # The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

154

"relativePath": "A String", # The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.

155

},

156

"formatType": "A String", # A short string that identifies the format type of this representation. Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

157

},

158

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

159

"authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the author. For more information, see [Licensing](/poly/discover/licensing).

160

"createTime": "A String", # For published assets, the time when the asset was published. For unpublished assets, the time when the asset was created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

165

<code class="details" id="list">list(pageSize=None, orderBy=None, category=None, pageToken=None, curated=None, maxComplexity=None, format=None, keywords=None, x__xgafv=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

166

<pre>Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

167

168

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

169

pageSize: integer, The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

170

orderBy: string, Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.

171

category: string, Filter assets based on the specified category. Supported values are: `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`, `technology`, and `transport`.

172

pageToken: string, Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.

173

curated: boolean, Return only assets that have been curated by the Poly team.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

174

maxComplexity: string, Returns assets that are of the specified complexity or less. Defaults to COMPLEX. For example, a request for MEDIUM assets also includes SIMPLE assets.

175

Allowed values

176

COMPLEXITY_UNSPECIFIED - No complexity specified. This is equivalent to omitting the filter.

177

COMPLEX - Highly-complex.

178

MEDIUM - Averagely-complex.

179

SIMPLE - Simple.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

180

format: string, Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.

181

keywords: string, One or more search terms to be matched against all text that Poly has indexed for assets, which includes display_name, description, and tags. Multiple keywords should be separated by spaces.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

182

x__xgafv: string, V1 error format.

183

Allowed values

184

1 - v1 error format

185

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

186

187

Returns:

188

An object of the form:

189

190

{ # A response message from a request to list.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

191

"assets": [ # A list of assets that match the criteria specified in the request.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

192

{ # Represents and describes an asset in the Poly library. An asset is a 3D model or scene created using [Tilt Brush](//www.tiltbrush.com), [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file that can be upload to Poly.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

193

"presentationParams": { # Hints for displaying the asset, based on information available when the asset was uploaded. # Hints for displaying the asset. Note that these parameters are not immutable; the author of an asset may change them post-publication.

194

"orientingRotation": { # A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the response you see "w: 1" and nothing else this is the default value of [0, 0, 0, 1] where x,y, and z are 0. # A rotation that should be applied to the object root to make it upright. More precisely, this quaternion transforms from "object space" (the space in which the object is defined) to "presentation space", a coordinate system where +Y is up, +X is right, -Z is forward. For example, if the object is the Eiffel Tower, in its local coordinate system the object might be laid out such that the base of the tower is on the YZ plane and the tip of the tower is towards positive X. In this case this quaternion would specify a rotation (of 90 degrees about the Z axis) such that in the presentation space the base of the tower is aligned with the XZ plane, and the tip of the tower lies towards +Y. This rotation is unrelated to the object's pose in the web preview, which is just a camera position setting and is *not* reflected in this rotation. Please note: this is applicable only to the gLTF.

195

"w": 3.14, # The scalar component.

196

"z": 3.14, # The z component.

197

"y": 3.14, # The y component.

198

"x": 3.14, # The x component.

199

},

200

"colorSpace": "A String", # The materials' diffuse/albedo color. This does not apply to vertex colors or texture maps.

201

"backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a 'thumbnail' or 'palette' style view. Authors have the option to set this background color when publishing or editing their asset. This is represented as a six-digit hexademical triplet specifying the RGB components of the background color, e.g. #FF0000 for Red.

202

},

203

"license": "A String", # The license under which the author has made the asset available for use, if any.

204

"visibility": "A String", # The visibility of the asset and who can access it.

205

"description": "A String", # The human-readable description, set by the asset's author.

206

"updateTime": "A String", # The time when the asset was last modified. For published assets, whose contents are immutable, the update time changes only when metadata properties, such as visibility, are updated.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

207

"remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to create this asset). # The remix info for the asset.

208

"sourceAsset": [ # Resource ids for the sources of this remix, of the form: `assets/{ASSET_ID}`

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

209

"A String",

210

],

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

211

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

212

"isCurated": True or False, # Whether this asset has been curated by the Poly team.

213

"displayName": "A String", # The human-readable name, set by the asset's author.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

214

"thumbnail": { # Represents a file in Poly, which can be a root, resource, or thumbnail file. # The thumbnail image for the asset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

215

"url": "A String", # The URL where the file data can be retrieved.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

216

"contentType": "A String", # The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

217

"relativePath": "A String", # The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

218

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

219

"name": "A String", # The unique identifier for the asset in the form: `assets/{ASSET_ID}`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

220

"metadata": "A String", # Application-defined opaque metadata for this asset. This field is only returned when querying for the signed-in user's own assets, not for public assets. This string is limited to 1K chars. It is up to the creator of the asset to define the format for this string (for example, JSON).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

221

"formats": [ # A list of Formats where each format describes one representation of the asset.

222

{ # The same asset can be represented in different formats, for example, a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file with its corresponding .glb binary data. A format refers to a specific representation of an asset and contains all information needed to retrieve and describe this representation.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

223

"formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.

224

"triangleCount": "A String", # The estimated number of triangles.

225

"lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this format relative to other formats of the same asset with the same format_type. This hint allows you to sort formats from the most-detailed (0) to least-detailed (integers greater than 0).

226

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

227

"resources": [ # A list of dependencies of the root element. May include, but is not limited to, materials, textures, and shader programs.

228

{ # Represents a file in Poly, which can be a root, resource, or thumbnail file.

229

"url": "A String", # The URL where the file data can be retrieved.

230

"contentType": "A String", # The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

231

"relativePath": "A String", # The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.

232

},

233

],

234

"root": { # Represents a file in Poly, which can be a root, resource, or thumbnail file. # The root of the file hierarchy. This will always be populated. For some format_types - such as `TILT`, which are self-contained - this is all of the data. Other types - such as `OBJ` - often reference other data elements. These are contained in the resources field.

235

"url": "A String", # The URL where the file data can be retrieved.

236

"contentType": "A String", # The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

237

"relativePath": "A String", # The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.

238

},

239

"formatType": "A String", # A short string that identifies the format type of this representation. Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

240

},

241

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

242

"authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the author. For more information, see [Licensing](/poly/discover/licensing).

243

"createTime": "A String", # For published assets, the time when the asset was published. For unpublished assets, the time when the asset was created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

244

},

245

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

246

"nextPageToken": "A String", # The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token.

247

"totalSize": 42, # The total number of assets in the list, without pagination.

Bu Sun Kim