Documentation

Google_Service_PolyService_Resource_Assets extends Google_Service_Resource
in package

The "assets" collection of methods.

Typical usage is: $polyService = new Google_Service_PolyService(...); $assets = $polyService->assets;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_PolyService_Asset
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. (assets.get)
listAssets()  : Google_Service_PolyService_ListAssetsResponse
Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license. (assets.listAssets)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

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. (assets.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PolyService_Asset
Parameters
$name : string

Required. An asset's name in the form assets/{ASSET_ID}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_PolyService_Asset —

listAssets()

Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license. (assets.listAssets)

public listAssets([array<string|int, mixed> $optParams = array() ]) : Google_Service_PolyService_ListAssetsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

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

opt_param

string pageToken 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.

opt_param

int pageSize The maximum number of assets to be returned. This value must be between 1 and 100. Defaults to 20.

opt_param

string keywords 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.

opt_param

string orderBy 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.

opt_param

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

opt_param

bool curated Return only assets that have been curated by the Poly team.

opt_param

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

Return values
Google_Service_PolyService_ListAssetsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results