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

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

82

<p class="firstline">Lists all public, remixable assets. These are assets with an access level</p>

83

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

88

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

89

<pre>Returns detailed information about an asset given its name.

90

PRIVATE assets are returned only if

91

the currently authenticated user (via OAuth token) is the author of the

asset.

Args:

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

96

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

103

104

{ # Represents and describes an asset in the Poly library. An asset is a 3D model

105

# or scene created using [Tilt Brush](//www.tiltbrush.com),

106

# [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file

107

# that can be upload to Poly.

108

"updateTime": "A String", # The time when the asset was last modified. For published assets, whose

109

# contents are immutable, the update time changes only when metadata

110

# properties, such as visibility, are updated.

111

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

112

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

113

"license": "A String", # The license under which the author has made the asset available

114

# for use, if any.

115

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

116

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

117

# resource, or thumbnail file.

118

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

119

"relativePath": "A String", # The path of the resource file relative to the

120

# root file. For root or thumbnail files,

121

# this is just the filename.

122

"contentType": "A String", # The MIME content-type, such as `image/png`.

123

# For more information, see

124

# [MIME

125

# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

126

},

127

"presentationParams": { # Hints for displaying the asset, based on information available when the asset # Hints for displaying the asset. Note that these parameters are not

128

# immutable; the author of an asset may change them post-publication.

129

# was uploaded.

130

"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.

131

# More precisely, this quaternion transforms from "object space" (the space

132

# in which the object is defined) to "presentation space", a coordinate

133

# system where +Y is up, +X is right, -Z is forward. For example, if

134

# the object is the Eiffel Tower, in its local coordinate system the

135

# object might be laid out such that the base of the tower is on the

136

# YZ plane and the tip of the tower is towards positive X. In this case

137

# this quaternion would specify a rotation (of 90 degrees about the Z

138

# axis) such that in the presentation space the base of the tower is

139

# aligned with the XZ plane, and the tip of the tower lies towards +Y.

140

#

141

# This rotation is unrelated to the object's pose in the web preview,

142

# which is just a camera position setting and is *not* reflected in this

143

# rotation.

144

#

145

# Please note: this is applicable only to the gLTF.

146

# response you see "w: 1" and nothing else this is the default value of

147

# [0, 0, 0, 1] where x,y, and z are 0.

148

"y": 3.14, # The y component.

149

"x": 3.14, # The x component.

150

"z": 3.14, # The z component.

151

"w": 3.14, # The scalar component.

152

},

153

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

154

# or texture maps.

155

"backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a

156

# 'thumbnail' or 'palette' style view. Authors have the option to set this

157

# background color when publishing or editing their asset.

158

#

159

# This is represented as a six-digit hexademical triplet specifying the

160

# RGB components of the background color, e.g. #FF0000 for Red.

161

},

162

"authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the

163

# author. For more information, see [Licensing](/poly/discover/licensing).

164

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

165

"formats": [ # A list of Formats where each

166

# format describes one representation of the asset.

167

{ # The same asset can be represented in different formats, for example,

168

# a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its

169

# corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file

170

# with its corresponding .glb binary data. A format refers to a specific

171

# representation of an asset and contains all information needed to

172

# retrieve and describe this representation.

173

"formatType": "A String", # A short string that identifies the format type of this representation.

174

# Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.

175

"root": { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated.

176

# For some format_types - such as `TILT`, which are

177

# self-contained - this is all of the data.

178

#

179

# Other types - such as `OBJ` - often reference other data elements.

180

# These are contained in the resources field.

181

# resource, or thumbnail file.

182

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

183

"relativePath": "A String", # The path of the resource file relative to the

184

# root file. For root or thumbnail files,

185

# this is just the filename.

186

"contentType": "A String", # The MIME content-type, such as `image/png`.

187

# For more information, see

188

# [MIME

189

# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

190

},

191

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

192

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

193

"lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this

194

# format relative to other formats of the same asset with the same

195

# format_type.

196

# This hint allows you to sort formats from the most-detailed (0) to

197

# least-detailed (integers greater than 0).

198

},

199

"resources": [ # A list of dependencies of the root element. May include, but is not

200

# limited to, materials, textures, and shader programs.

201

{ # Represents a file in Poly, which can be a root,

202

# resource, or thumbnail file.

203

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

204

"relativePath": "A String", # The path of the resource file relative to the

205

# root file. For root or thumbnail files,

206

# this is just the filename.

207

"contentType": "A String", # The MIME content-type, such as `image/png`.

208

# For more information, see

209

# [MIME

210

# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

},

],

},

],

"metadata": "A String", # Application-defined opaque metadata for this asset. This field is only

216

# returned when querying for the signed-in user's own assets, not for public

217

# assets. This string is limited to 1K chars. It is up to the creator of

218

# the asset to define the format for this string (for example, JSON).

219

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

220

# For unpublished assets, the time when the asset was created.

221

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

222

# create this asset).

223

"sourceAsset": [ # Resource ids for the sources of this remix, of the form:

224

# `assets/{ASSET_ID}`

"A String",

],

},

"name": "A String", # The unique identifier for the asset in the form:

229

# `assets/{ASSET_ID}`.

}</pre>

</div>

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

235

<pre>Lists all public, remixable assets. These are assets with an access level

236

of PUBLIC and published under the

CC-By license.

Args:

orderBy: string, Specifies an ordering for assets. Acceptable values are:

241

`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets

242

based on a combination of popularity and other features.

243

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

244

and `100`. Defaults to `20`.

245

maxComplexity: string, Returns assets that are of the specified complexity or less. Defaults to

246

COMPLEX. For example, a request for

247

MEDIUM assets also includes

248

SIMPLE assets.

249

keywords: string, One or more search terms to be matched against all text that Poly has

250

indexed for assets, which includes display_name,

251

description, and tags. Multiple keywords should be

252

separated by spaces.

253

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

category: string, Filter assets based on the specified category. Supported values are:

258

`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`,

259

`scenes`, `technology`, and `transport`.

260

pageToken: string, Specifies a continuation token from a previous search whose results were

261

split into multiple pages. To get the next page, submit the same request

262

specifying the value from

263

next_page_token.

264

format: string, Return only assets with the matching format. Acceptable values are:

265

`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.

266

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

267

268

Returns:

269

An object of the form:

270

271

{ # A response message from a request to list.

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame^]

272

"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]

273

"nextPageToken": "A String", # The continuation token for retrieving the next page. If empty,

274

# indicates that there are no more pages. To get the next page, submit the

275

# same request specifying this value as the

276

# page_token.

Bu Sun Kim

715bd7f

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

[diff] [blame]

277

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

278

{ # Represents and describes an asset in the Poly library. An asset is a 3D model

279

# or scene created using [Tilt Brush](//www.tiltbrush.com),

280

# [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file

281

# that can be upload to Poly.

282

"updateTime": "A String", # The time when the asset was last modified. For published assets, whose

283

# contents are immutable, the update time changes only when metadata

284

# properties, such as visibility, are updated.

285

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

286

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

287

"license": "A String", # The license under which the author has made the asset available

288

# for use, if any.

289

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

290

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

291

# resource, or thumbnail file.

292

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

293

"relativePath": "A String", # The path of the resource file relative to the

294

# root file. For root or thumbnail files,

295

# this is just the filename.

296

"contentType": "A String", # The MIME content-type, such as `image/png`.

297

# For more information, see

298

# [MIME

299

# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

300

},

301

"presentationParams": { # Hints for displaying the asset, based on information available when the asset # Hints for displaying the asset. Note that these parameters are not

302

# immutable; the author of an asset may change them post-publication.

303

# was uploaded.

304

"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.

305

# More precisely, this quaternion transforms from "object space" (the space

306

# in which the object is defined) to "presentation space", a coordinate

307

# system where +Y is up, +X is right, -Z is forward. For example, if

308

# the object is the Eiffel Tower, in its local coordinate system the

309

# object might be laid out such that the base of the tower is on the

310

# YZ plane and the tip of the tower is towards positive X. In this case

311

# this quaternion would specify a rotation (of 90 degrees about the Z

312

# axis) such that in the presentation space the base of the tower is

313

# aligned with the XZ plane, and the tip of the tower lies towards +Y.

314

#

315

# This rotation is unrelated to the object's pose in the web preview,

316

# which is just a camera position setting and is *not* reflected in this

317

# rotation.

318

#

319

# Please note: this is applicable only to the gLTF.

320

# response you see "w: 1" and nothing else this is the default value of

321

# [0, 0, 0, 1] where x,y, and z are 0.

322

"y": 3.14, # The y component.

323

"x": 3.14, # The x component.

324

"z": 3.14, # The z component.

325

"w": 3.14, # The scalar component.

326

},

327

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

328

# or texture maps.

329

"backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a

330

# 'thumbnail' or 'palette' style view. Authors have the option to set this

331

# background color when publishing or editing their asset.

332

#

333

# This is represented as a six-digit hexademical triplet specifying the

334

# RGB components of the background color, e.g. #FF0000 for Red.

335

},

336

"authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the

337

# author. For more information, see [Licensing](/poly/discover/licensing).

338

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

339

"formats": [ # A list of Formats where each

340

# format describes one representation of the asset.

341

{ # The same asset can be represented in different formats, for example,

342

# a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its

343

# corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file

344

# with its corresponding .glb binary data. A format refers to a specific

345

# representation of an asset and contains all information needed to

346

# retrieve and describe this representation.

347

"formatType": "A String", # A short string that identifies the format type of this representation.

348

# Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.

349

"root": { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated.

350

# For some format_types - such as `TILT`, which are

351

# self-contained - this is all of the data.

352

#

353

# Other types - such as `OBJ` - often reference other data elements.

354

# These are contained in the resources field.

355

# resource, or thumbnail file.

356

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

357

"relativePath": "A String", # The path of the resource file relative to the

358

# root file. For root or thumbnail files,

359

# this is just the filename.

360

"contentType": "A String", # The MIME content-type, such as `image/png`.

361

# For more information, see

362

# [MIME

363

# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

364

},

365

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

366

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

367

"lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this

368

# format relative to other formats of the same asset with the same

369

# format_type.

370

# This hint allows you to sort formats from the most-detailed (0) to

371

# least-detailed (integers greater than 0).

372

},

373

"resources": [ # A list of dependencies of the root element. May include, but is not

374

# limited to, materials, textures, and shader programs.

375

{ # Represents a file in Poly, which can be a root,

376

# resource, or thumbnail file.

377

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

378

"relativePath": "A String", # The path of the resource file relative to the

379

# root file. For root or thumbnail files,

380

# this is just the filename.

381

"contentType": "A String", # The MIME content-type, such as `image/png`.

382

# For more information, see

383

# [MIME

384

# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

},

],

},

],

"metadata": "A String", # Application-defined opaque metadata for this asset. This field is only

390

# returned when querying for the signed-in user's own assets, not for public

391

# assets. This string is limited to 1K chars. It is up to the creator of

392

# the asset to define the format for this string (for example, JSON).

393

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

394

# For unpublished assets, the time when the asset was created.

395

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

396

# create this asset).

397

"sourceAsset": [ # Resource ids for the sources of this remix, of the form:

398

# `assets/{ASSET_ID}`

"A String",

],

},

"name": "A String", # The unique identifier for the asset in the form:

403

# `assets/{ASSET_ID}`.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

411

<pre>Retrieves the next page of results.

412

413

Args:

414

previous_request: The request for the previous page. (required)

415

previous_response: The response from the request for the previous page. (required)

416

417

Returns:

418

A request object that you can call 'execute()' on to request the next

419

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>