Class: Google::Apis::PolyV1::PolyServiceService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/poly_v1/service.rb

Overview

Poly API

The Poly API provides read access to assets hosted on poly.google.com to all, and upload access to poly.google.com for whitelisted accounts.

Examples:

require 'google/apis/poly_v1'

Poly = Google::Apis::PolyV1 # Alias the module
service = Poly::PolyServiceService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://poly.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PolyServiceService

Returns a new instance of PolyServiceService.



48
49
50
51
52
53
 
# File 'lib/google/apis/poly_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-poly_v1',
        client_version: Google::Apis::PolyV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

    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.



41
42
43
 
# File 'lib/google/apis/poly_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

    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.



46
47
48
 
# File 'lib/google/apis/poly_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#get_asset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PolyV1::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.

Parameters:

  • name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/poly_v1/service.rb', line 77

def get_asset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::PolyV1::Asset::Representation
  command.response_class = Google::Apis::PolyV1::Asset
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_assets(category: nil, curated: nil, format: nil, keywords: nil, max_complexity: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PolyV1::ListAssetsResponse

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

Parameters:

  • category (String) (defaults to: nil) —

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

  • curated (Boolean) (defaults to: nil) —

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

  • format (String) (defaults to: nil) —

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

  • keywords (String) (defaults to: nil) —

    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.

  • max_complexity (String) (defaults to: nil) —

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

  • order_by (String) (defaults to: nil) —

    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.

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/google/apis/poly_v1/service.rb', line 133

def list_assets(category: nil, curated: nil, format: nil, keywords: nil, max_complexity: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/assets', options)
  command.response_representation = Google::Apis::PolyV1::ListAssetsResponse::Representation
  command.response_class = Google::Apis::PolyV1::ListAssetsResponse
  command.query['category'] = category unless category.nil?
  command.query['curated'] = curated unless curated.nil?
  command.query['format'] = format unless format.nil?
  command.query['keywords'] = keywords unless keywords.nil?
  command.query['maxComplexity'] = max_complexity unless max_complexity.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_assets(name, format: nil, order_by: nil, page_size: nil, page_token: nil, visibility: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PolyV1::ListUserAssetsResponse

Lists assets authored by the given user. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of PRIVATE or UNLISTED and assets which are All Rights Reserved for the currently-authenticated user.

Parameters:

  • name (String) —

    A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.

  • format (String) (defaults to: nil) —

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

  • order_by (String) (defaults to: nil) —

    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.

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

    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.

  • visibility (String) (defaults to: nil) —

    The visibility of the assets to be returned. Defaults to VISIBILITY_UNSPECIFIED which returns all assets.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/google/apis/poly_v1/service.rb', line 192

def list_user_assets(name, format: nil, order_by: nil, page_size: nil, page_token: nil, visibility: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/assets', options)
  command.response_representation = Google::Apis::PolyV1::ListUserAssetsResponse::Representation
  command.response_class = Google::Apis::PolyV1::ListUserAssetsResponse
  command.params['name'] = name unless name.nil?
  command.query['format'] = format unless format.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['visibility'] = visibility unless visibility.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_likedassets(name, format: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PolyV1::ListLikedAssetsResponse

Lists assets that the user has liked. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of UNLISTED.

Parameters:

  • name (String) —

    A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.

  • format (String) (defaults to: nil) —

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

  • order_by (String) (defaults to: nil) —

    Specifies an ordering for assets. Acceptable values are: BEST, NEWEST, OLDEST, 'LIKED_TIME'. Defaults to LIKED_TIME, which ranks assets based on how recently they were liked.

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/apis/poly_v1/service.rb', line 245

def list_user_likedassets(name, format: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/likedassets', options)
  command.response_representation = Google::Apis::PolyV1::ListLikedAssetsResponse::Representation
  command.response_class = Google::Apis::PolyV1::ListLikedAssetsResponse
  command.params['name'] = name unless name.nil?
  command.query['format'] = format unless format.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end