Class: Google::Apis::PolyV1::PolyServiceService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::PolyV1::PolyServiceService
- Defined in:
- generated/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.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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.
-
#initialize ⇒ PolyServiceService
constructor
A new instance of PolyServiceService.
-
#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.
-
#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.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ PolyServiceService
Returns a new instance of PolyServiceService
47 48 49 50 |
# File 'generated/google/apis/poly_v1/service.rb', line 47 def initialize super('https://poly.googleapis.com/', '') @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.
40 41 42 |
# File 'generated/google/apis/poly_v1/service.rb', line 40 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.
45 46 47 |
# File 'generated/google/apis/poly_v1/service.rb', line 45 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.
74 75 76 77 78 79 80 81 82 |
# File 'generated/google/apis/poly_v1/service.rb', line 74 def get_asset(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'generated/google/apis/poly_v1/service.rb', line 135 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', ) 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.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'generated/google/apis/poly_v1/service.rb', line 197 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', ) 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.
251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'generated/google/apis/poly_v1/service.rb', line 251 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', ) 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 |