"description":"The Poly API provides read-only access to assets hosted on \u003ca href=\"https://poly.google.com\"\u003epoly.google.com\u003c/a\u003e.\n",
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query",
"type":"string"
},
"bearer_token":{
"description":"OAuth bearer token.",
"location":"query",
"type":"string"
},
"callback":{
"description":"JSONP",
"location":"query",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"location":"query",
"type":"string"
},
"key":{
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location":"query",
"type":"string"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"pp":{
"default":"true",
"description":"Pretty-print response.",
"location":"query",
"type":"boolean"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"quotaUser":{
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location":"query",
"type":"string"
},
"uploadType":{
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location":"query",
"type":"string"
},
"upload_protocol":{
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"description":"Returns detailed information about an asset given its name.\nPRIVATE assets are returned only if\n the currently authenticated user (via OAuth token) is the author of the asset.",
"description":"Filter assets based on the specified category. Supported values are:\n`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`,\n`technology`, and `transport`.",
"description":"One or more search terms to be matched against all text that Poly has\nindexed for assets, which includes display_name,\ndescription, and tags. Multiple keywords should be\nseparated by spaces.",
"description":"Returns assets that are of the specified complexity or less. Defaults to\nCOMPLEX. For example, a request for\nMEDIUM assets also includes\nSIMPLE assets.",
"description":"Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.",
"description":"Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from next_page_token.",
"description":"Lists assets authored by the given user. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of PRIVATE or\nUNLISTED and assets which are\nAll Rights Reserved for the\ncurrently-authenticated user.",
"description":"A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.",
"description":"Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.",
"description":"Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\nnext_page_token.",
"location":"query",
"type":"string"
},
"visibility":{
"description":"The visibility of the assets to be returned.\nDefaults to VISIBILITY_UNSPECIFIED which returns all assets.",
"description":"Lists assets that the user has liked. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of UNLISTED.",
"description":"A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.",
"description":"Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which\nranks assets based on how recently they were liked.",
"description":"Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\nnext_page_token.",
"description":"Represents and describes an asset in the Poly library. An asset is a 3D model\nor scene created using [Tilt Brush](//www.tiltbrush.com),\n[Blocks](//vr.google.com/blocks/), or any 3D program that produces a file\nthat can be upload to Poly.",
"id":"Asset",
"properties":{
"authorName":{
"description":"The author's publicly visible name. Use this name when giving credit to the\nauthor. For more information, see [Licensing](/poly/discover/licensing).",
"type":"string"
},
"createTime":{
"description":"For published assets, the time when the asset was published.\nFor unpublished assets, the time when the asset was created.",
"format":"google-datetime",
"type":"string"
},
"description":{
"description":"The human-readable description, set by the asset's author.",
"type":"string"
},
"displayName":{
"description":"The human-readable name, set by the asset's author.",
"type":"string"
},
"formats":{
"description":"A list of Formats where each\nformat describes one representation of the asset.",
"items":{
"$ref":"Format"
},
"type":"array"
},
"isCurated":{
"description":"Whether this asset has been curated by the Poly team.",
"type":"boolean"
},
"license":{
"description":"The license under which the author has made the asset available\nfor use, if any.",
"Unlicensed: All Rights Reserved by the author. Unlicensed assets are\n**not** returned by List Assets."
],
"type":"string"
},
"metadata":{
"description":"Application-defined opaque metadata for this asset. This field is only\nreturned when querying for the signed-in user's own assets, not for public\nassets. This string is limited to 1K chars. It is up to the creator of\nthe asset to define the format for this string (for example, JSON).",
"type":"string"
},
"name":{
"description":"The unique identifier for the asset in the form:\n`assets/{ASSET_ID}`.",
"type":"string"
},
"presentationParams":{
"$ref":"PresentationParams",
"description":"Hints for displaying the asset. Note that these parameters are not\nimmutable; the author of an asset may change them post-publication."
},
"thumbnail":{
"$ref":"File",
"description":"The thumbnail image for the asset."
},
"updateTime":{
"description":"The time when the asset was last modified. For published assets, whose\ncontents are immutable, the update time changes only when metadata\nproperties, such as visibility, are updated.",
"format":"google-datetime",
"type":"string"
},
"visibility":{
"description":"The visibility of the asset and who can access it.",
"enum":[
"VISIBILITY_UNSPECIFIED",
"PRIVATE",
"UNLISTED",
"PUBLIC"
],
"enumDescriptions":[
"Unknown (and invalid) visibility.",
"Access to the asset and its underlying files and resources is restricted to\nthe author.\n**Authentication:** You must supply an OAuth token that corresponds to the\nauthor's account.",
"Access to the asset and its underlying files and resources is available to\nanyone with the asset's name. Unlisted assets are **not**\nreturned by List Assets.",
"Access to the asset and its underlying files and resources is available\nto anyone."
],
"type":"string"
}
},
"type":"object"
},
"AssetImportMessage":{
"description":"A message generated by the asset import process.",
"id":"AssetImportMessage",
"properties":{
"code":{
"description":"The code associated with this message.",
"enum":[
"CODE_UNSPECIFIED",
"NO_IMPORTABLE_FILE",
"EMPTY_MODEL",
"OBJ_PARSE_ERROR",
"EXPIRED",
"IMAGE_ERROR",
"EXTRA_FILES_WITH_ARCHIVE",
"DEFAULT_MATERIALS",
"FATAL_ERROR",
"INVALID_ELEMENT_TYPE"
],
"enumDescriptions":[
"Unknown error code.",
"The asset import did not include any file that we can import (i.e. an OBJ\nfile).",
"When generating the preview for the import, no geometry was found.",
"A problem was encountered while parsing the OBJ file. The converter makes\na 'best effort' attempt to continue when encountering such issues. In\nsome cases the resulting preview model may still be acceptable. The\ndetails can be found in the parse error message.",
"The importer was not able to import the model before the expiration time.",
"The importer encountered a problem reading an image file.",
"Multiple files were encountered in addition to a ZIP archive. When\nuploading an archive only one file is permitted.",
"Default materials are used in the model. This means that one or more\nfaces is using default materials either because no usemtl statement was\nspecified or because the requested material was not found due to a\nmissing material file or bad material name. This does not cover the case\nof missing textures.",
"The importer encountered a fatal error and was unable to import the\nmodel.",
"The import includes a file of an unsupported element type. The file path\nis specified."
],
"type":"string"
},
"filePath":{
"description":"An optional file path. Only present for those error codes that specify it.",
"type":"string"
},
"imageError":{
"$ref":"ImageError",
"description":"An optional image error. Only present for INVALID_IMAGE_FILE."
},
"objParseError":{
"$ref":"ObjParseError",
"description":"An optional OBJ parse error. Only present for OBJ_PARSE_ERROR."
"description":"The MIME content-type, such as `image/png`.\nFor more information, see\n[MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).",
"type":"string"
},
"relativePath":{
"description":"The path of the resource file relative to the root file.\nFor root or thumbnail files, this is just the filename.",
"type":"string"
},
"url":{
"description":"The URL where the file data can be retrieved.",
"description":"The same asset can be represented in different formats, for example,\na [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its\ncorresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file\nwith its corresponding .glb binary data. A format refers to a specific\nrepresentation of an asset and contains all information needed to\nretrieve and describe this representation.",
"description":"Complexity stats about this representation of the asset."
},
"formatType":{
"description":"A short string that identifies the format type of this representation.\nPossible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.",
"description":"The root of the file hierarchy. This will always be populated.\nFor some format_types - such as `TILT`, which are self-contained -\nthis is all of the data.\n\nOther types - such as `OBJ` - often reference other data elements.\nThese are contained in the resources field."
}
},
"type":"object"
},
"FormatComplexity":{
"description":"Information on the complexity of this Format.",
"id":"FormatComplexity",
"properties":{
"lodHint":{
"description":"A non-negative integer that represents the level of detail (LOD) of this\nformat relative to other formats of the same asset with the same\nformat_type.\nThis hint allows you to sort formats from the most-detailed (0) to\nleast-detailed (integers greater than 0).",
"description":"The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
"description":"The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
"description":"The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
"description":"The text of the line. Note that this may be truncated if the line was very\nlong. This may not include the error if it occurs after line truncation.",
"description":"A rotation that should be applied to the object root to make it upright.\nMore precisely, this quaternion transforms from \"object space\" (the space\nin which the object is defined) to \"presentation space\", a coordinate\nsystem where +Y is up, +X is right, -Z is forward. For example, if\nthe object is the Eiffel Tower, in its local coordinate system the\nobject might be laid out such that the base of the tower is on the\nYZ plane and the tip of the tower is towards positive X. In this case\nthis quaternion would specify a rotation (of 90 degrees about the Z\naxis) such that in the presentation space the base of the tower is\naligned with the XZ plane, and the tip of the tower lies towards +Y.\n\nThis rotation is unrelated to the object's pose in the web preview,\nwhich is just a camera position setting and is *not* reflected in this\nrotation.\n\nPlease note: this is applicable only to the gLTF."
"description":"A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the\nresponse you see \"w: 1\" and nothing else this is the default value of\n[0, 0, 0, 1] where x,y, and z are 0.",
"description":"The id of newly created asset. If this is empty when the operation is\ncomplete it means the import failed. Please refer to the\nasset_import_message field to understand what went wrong.",
"description":"The message from the asset import. This will contain any warnings\n(or - in the case of failure - errors) that occurred during import.",
