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

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

[diff] [blame]

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

92

asset.

93

94

Args:

Bu Sun Kim

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

[diff] [blame]

95

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]

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

108

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

109

# create this asset).

110

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

111

# `assets/{ASSET_ID}`

112

"A String",

113

],

114

},

Bu Sun Kim

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

# resource, or thumbnail file.

Bu Sun Kim

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

[diff] [blame]

117

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

Bu Sun Kim

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

[diff] [blame]

118

# root file. For root or thumbnail files,

119

# this is just the filename.

Bu Sun Kim

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame]

121

# For more information, see

122

# [MIME

123

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

Bu Sun Kim

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame]

125

},

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

128

# `assets/{ASSET_ID}`.

129

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

130

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

131

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

132

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

Bu Sun Kim

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

[diff] [blame]

133

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

134

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

135

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

136

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

Bu Sun Kim

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

[diff] [blame]

137

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

138

# format describes one representation of the asset.

139

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

140

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

141

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

142

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

143

# representation of an asset and contains all information needed to

144

# retrieve and describe this representation.

Bu Sun Kim

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

[diff] [blame]

145

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

146

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

147

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

148

#

149

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

150

# These are contained in the resources field.

151

# resource, or thumbnail file.

152

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

153

# root file. For root or thumbnail files,

154

# this is just the filename.

155

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

156

# For more information, see

157

# [MIME

158

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

159

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

160

},

161

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

162

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

163

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

164

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

165

# format_type.

166

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

167

# least-detailed (integers greater than 0).

168

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

169

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

170

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

171

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

172

# resource, or thumbnail file.

173

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

174

# root file. For root or thumbnail files,

175

# this is just the filename.

176

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

177

# For more information, see

178

# [MIME

179

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

180

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

181

},

182

],

183

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

184

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

Bu Sun Kim

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

[diff] [blame]

185

},

186

],

187

"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

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

[diff] [blame]

188

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

189

# was uploaded.

Bu Sun Kim

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

[diff] [blame]

190

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

191

# or texture maps.

192

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

193

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

194

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

Bu Sun Kim

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

[diff] [blame]

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

#

Bu Sun Kim

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

[diff] [blame]

203

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

Bu Sun Kim

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

[diff] [blame]

204

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

205

# rotation.

206

#

207

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

Bu Sun Kim

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

[diff] [blame]

208

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

Bu Sun Kim

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

[diff] [blame]

209

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

Bu Sun Kim

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

[diff] [blame]

210

"x": 3.14, # The x component.

211

"w": 3.14, # The scalar component.

212

"y": 3.14, # The y component.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

213

"z": 3.14, # The z component.

Bu Sun Kim

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

[diff] [blame]

214

},

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

Bu Sun Kim

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

[diff] [blame]

217

# background color when publishing or editing their asset.

218

#

219

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

220

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

221

},

Bu Sun Kim

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

[diff] [blame]

222

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

223

# for use, if any.

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

226

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

227

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

228

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

229

# properties, such as visibility, are updated.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

234

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

Bu Sun Kim

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

[diff] [blame]

235

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

236

of PUBLIC and published under the

237

CC-By license.

238

239

Args:

Bu Sun Kim

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

[diff] [blame]

240

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

241

COMPLEX. For example, a request for

242

MEDIUM assets also includes

243

SIMPLE assets.

Bu Sun Kim

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

[diff] [blame]

244

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

245

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

246

based on a combination of popularity and other features.

247

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

248

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

249

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

250

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

251

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

252

specifying the value from

253

next_page_token.

254

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

255

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

256

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

257

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

258

and `100`. Defaults to `20`.

Bu Sun Kim

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

[diff] [blame]

259

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

260

indexed for assets, which includes display_name,

261

description, and tags. Multiple keywords should be

262

separated by spaces.

263

x__xgafv: string, V1 error format.

264

Allowed values

265

1 - v1 error format

266

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

267

268

Returns:

269

An object of the form:

270

271

{ # A response message from a request to list.

Bu Sun Kim

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

[diff] [blame]

272

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

Bu Sun Kim

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

[diff] [blame]

273

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

274

# same request specifying this value as the

275

# page_token.

Bu Sun Kim

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

[diff] [blame]

276

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

Bu Sun Kim

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

[diff] [blame]

277

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

278

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

279

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

280

# that can be upload to Poly.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

281

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

282

# create this asset).

283

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

284

# `assets/{ASSET_ID}`

285

"A String",

286

],

287

},

Bu Sun Kim

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

[diff] [blame]

288

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

Bu Sun Kim

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

[diff] [blame]

289

# resource, or thumbnail file.

Bu Sun Kim

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

[diff] [blame]

290

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

Bu Sun Kim

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

[diff] [blame]

291

# root file. For root or thumbnail files,

292

# this is just the filename.

Bu Sun Kim

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

[diff] [blame]

293

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

Bu Sun Kim

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

[diff] [blame]

294

# For more information, see

295

# [MIME

296

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

Bu Sun Kim

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

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

},

Bu Sun Kim

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

[diff] [blame]

299

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

300

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

301

# `assets/{ASSET_ID}`.

302

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

303

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

304

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

305

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

Bu Sun Kim

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

[diff] [blame]

306

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

307

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

308

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

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

311

# format describes one representation of the asset.

312

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

313

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

314

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

315

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

316

# representation of an asset and contains all information needed to

317

# retrieve and describe this representation.

Bu Sun Kim

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

[diff] [blame]

318

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

319

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

320

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

321

#

322

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

323

# These are contained in the resources field.

324

# resource, or thumbnail file.

325

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

326

# root file. For root or thumbnail files,

327

# this is just the filename.

328

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

329

# For more information, see

330

# [MIME

331

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

332

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

333

},

334

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

335

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

336

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

337

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

338

# format_type.

339

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

340

# least-detailed (integers greater than 0).

341

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

342

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

343

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

344

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

345

# resource, or thumbnail file.

346

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

347

# root file. For root or thumbnail files,

348

# this is just the filename.

349

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

350

# For more information, see

351

# [MIME

352

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

353

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

354

},

355

],

356

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

357

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

Bu Sun Kim

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

[diff] [blame]

358

},

359

],

360

"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

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

[diff] [blame]

361

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

362

# was uploaded.

Bu Sun Kim

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

[diff] [blame]

363

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

364

# or texture maps.

365

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

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

#

Bu Sun Kim

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

[diff] [blame]

376

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

Bu Sun Kim

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

[diff] [blame]

377

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

378

# rotation.

379

#

380

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

Bu Sun Kim

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

[diff] [blame]

381

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

Bu Sun Kim

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

[diff] [blame]

382

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

Bu Sun Kim

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

[diff] [blame]

383

"x": 3.14, # The x component.

384

"w": 3.14, # The scalar component.

385

"y": 3.14, # The y component.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

386

"z": 3.14, # The z component.

Bu Sun Kim

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

[diff] [blame]

387

},

Bu Sun Kim

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

[diff] [blame]

388

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

389

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

Bu Sun Kim

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

[diff] [blame]

390

# background color when publishing or editing their asset.

391

#

392

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

393

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

394

},

Bu Sun Kim

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

[diff] [blame]

395

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

396

# for use, if any.

397

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

Bu Sun Kim

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

[diff] [blame]

398

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

399

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

400

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

401

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

402

# properties, such as visibility, are updated.

Bu Sun Kim

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

[diff] [blame]

403

},

404

],

Bu Sun Kim

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

[diff] [blame]

405

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

Bu Sun Kim

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

[diff] [blame]

}</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:

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim