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-07-22 17:02:09 -0700

[diff] [blame]

115

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

116

# for use, if any.

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

119

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

120

# was uploaded.

Bu Sun Kim

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

[diff] [blame]

121

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

122

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

123

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

Bu Sun Kim

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

[diff] [blame]

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

#

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

# rotation.

135

#

136

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

Bu Sun Kim

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

[diff] [blame]

137

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

138

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

Bu Sun Kim

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

[diff] [blame]

139

"x": 3.14, # The x component.

Bu Sun Kim

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

[diff] [blame]

140

"z": 3.14, # The z component.

Bu Sun Kim

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

[diff] [blame]

141

"y": 3.14, # The y component.

142

"w": 3.14, # The scalar component.

Bu Sun Kim

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

[diff] [blame]

143

},

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

# background color when publishing or editing their asset.

147

#

148

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

149

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

Bu Sun Kim

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

[diff] [blame]

150

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

151

# or texture maps.

Bu Sun Kim

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

[diff] [blame]

152

},

Bu Sun Kim

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

[diff] [blame]

153

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

154

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

155

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

156

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

157

# properties, such as visibility, are updated.

Bu Sun Kim

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

[diff] [blame]

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

# `assets/{ASSET_ID}`.

168

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

169

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

170

# resource, or thumbnail file.

171

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

172

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

173

# root file. For root or thumbnail files,

174

# this is just the filename.

175

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

176

# For more information, see

177

# [MIME

178

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

179

},

180

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

181

# format describes one representation of the asset.

182

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

183

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

184

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

185

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

186

# representation of an asset and contains all information needed to

187

# retrieve and describe this representation.

188

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

189

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

190

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

191

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

192

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

193

# resource, or thumbnail file.

194

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

195

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

196

# root file. For root or thumbnail files,

197

# this is just the filename.

198

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

199

# For more information, see

200

# [MIME

201

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

202

},

203

],

204

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

205

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

206

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

207

#

208

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

209

# These are contained in the resources field.

210

# resource, or thumbnail file.

211

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

212

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

213

# root file. For root or thumbnail files,

214

# this is just the filename.

215

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

216

# For more information, see

217

# [MIME

218

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

219

},

220

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

221

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

222

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

223

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

224

# format_type.

225

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

226

# least-detailed (integers greater than 0).

227

},

228

},

229

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

234

<code class="details" id="list">list(pageSize=None, pageToken=None, category=None, keywords=None, format=None, orderBy=None, maxComplexity=None, curated=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

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

[diff] [blame]

240

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

241

and `100`. Defaults to `20`.

Bu Sun Kim

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

[diff] [blame]

242

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

243

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

244

specifying the value from

245

next_page_token.

246

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

247

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

248

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

253

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

254

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

255

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

256

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

257

based on a combination of popularity and other features.

258

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

259

COMPLEX. For example, a request for

260

MEDIUM assets also includes

261

SIMPLE assets.

262

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

Bu Sun Kim

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

[diff] [blame]

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

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

273

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

274

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

275

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

276

# that can be upload to Poly.

Bu Sun Kim

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

[diff] [blame]

277

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

278

# create this asset).

279

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

280

# `assets/{ASSET_ID}`

281

"A String",

282

],

283

},

Bu Sun Kim

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

[diff] [blame]

284

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

285

# for use, if any.

286

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

Bu Sun Kim

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

[diff] [blame]

287

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

288

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

289

# was uploaded.

Bu Sun Kim

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

[diff] [blame]

290

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

291

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

292

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

Bu Sun Kim

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

[diff] [blame]

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

#

Bu Sun Kim

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

[diff] [blame]

301

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

302

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

303

# rotation.

304

#

305

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

Bu Sun Kim

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

[diff] [blame]

306

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

307

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

Bu Sun Kim

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

[diff] [blame]

308

"x": 3.14, # The x component.

Bu Sun Kim

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

[diff] [blame]

309

"z": 3.14, # The z component.

Bu Sun Kim

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

[diff] [blame]

310

"y": 3.14, # The y component.

311

"w": 3.14, # The scalar component.

Bu Sun Kim

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

[diff] [blame]

312

},

Bu Sun Kim

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

[diff] [blame]

313

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

314

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

Bu Sun Kim

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

[diff] [blame]

315

# background color when publishing or editing their asset.

316

#

317

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

318

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

Bu Sun Kim

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

[diff] [blame]

319

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

320

# or texture maps.

Bu Sun Kim

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

[diff] [blame]

321

},

Bu Sun Kim

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

[diff] [blame]

322

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

323

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

324

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

325

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

326

# properties, such as visibility, are updated.

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

# `assets/{ASSET_ID}`.

337

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

338

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

339

# resource, or thumbnail file.

340

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

341

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

342

# root file. For root or thumbnail files,

343

# this is just the filename.

344

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

345

# For more information, see

346

# [MIME

347

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

348

},

349

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

350

# format describes one representation of the asset.

351

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

352

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

353

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

354

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

355

# representation of an asset and contains all information needed to

356

# retrieve and describe this representation.

357

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

358

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

359

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

360

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

361

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

362

# resource, or thumbnail file.

363

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

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

371

},

372

],

373

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

374

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

375

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

376

#

377

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

378

# These are contained in the resources field.

379

# resource, or thumbnail file.

380

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

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

388

},

389

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

390

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

391

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

392

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

393

# format_type.

394

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

395

# least-detailed (integers greater than 0).

396

},

397

},

398

],

Bu Sun Kim

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

[diff] [blame]

399

},

400

],

Bu Sun Kim

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

[diff] [blame]

401

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

Bu Sun Kim

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

[diff] [blame]

402

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

403

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

404

# same request specifying this value as the

405

# page_token.

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