GoogleApi.YouTube.V3.Api.Thumbnails (google_api_you_tube v0.54.0)

API calls for all endpoints tagged Thumbnails.

Summary

Functions

youtube_thumbnails_set(connection, video_id, optional_params \\ [], opts \\ [])

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

youtube_thumbnails_set_iodata(connection, video_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

youtube_thumbnails_set_resumable(connection, video_id, upload_type, optional_params \\ [], opts \\ [])

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

youtube_thumbnails_set_simple(connection, video_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

Functions

youtube_thumbnails_set(connection, video_id, optional_params \\ [], opts \\ [])

@spec youtube_thumbnails_set(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.ThumbnailSetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
video_id (type: String.t) - Returns the Thumbnail with the given video IDs for Stubby or Apiary.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :onBehalfOfContentOwner (type: String.t) - Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.YouTube.V3.Model.ThumbnailSetResponse{}} on success
{:error, info} on failure

youtube_thumbnails_set_iodata(connection, video_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec youtube_thumbnails_set_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.ThumbnailSetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
video_id (type: String.t) - Returns the Thumbnail with the given video IDs for Stubby or Apiary.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: String.t) - string metadata
data (type: iodata) - Content to upload, as a string or iolist
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :onBehalfOfContentOwner (type: String.t) - Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.YouTube.V3.Model.ThumbnailSetResponse{}} on success
{:error, info} on failure

youtube_thumbnails_set_resumable(connection, video_id, upload_type, optional_params \\ [], opts \\ [])

@spec youtube_thumbnails_set_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
video_id (type: String.t) - Returns the Thumbnail with the given video IDs for Stubby or Apiary.
upload_type (type: String.t) - Upload type. Must be "resumable".
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :onBehalfOfContentOwner (type: String.t) - Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

youtube_thumbnails_set_simple(connection, video_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec youtube_thumbnails_set_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.ThumbnailSetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
video_id (type: String.t) - Returns the Thumbnail with the given video IDs for Stubby or Apiary.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: String.t) - string metadata
data (type: String.t) - Path to file containing content to upload
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :onBehalfOfContentOwner (type: String.t) - Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.YouTube.V3.Model.ThumbnailSetResponse{}} on success
{:error, info} on failure