google_api_you_tube v0.12.0 GoogleApi.YouTube.V3.Api.Watermarks View Source
API calls for all endpoints tagged Watermarks
.
Link to this section Summary
Functions
Uploads a watermark image to YouTube and sets it for a channel.
Uploads a watermark image to YouTube and sets it for a channel.
Uploads a watermark image to YouTube and sets it for a channel.
Uploads a watermark image to YouTube and sets it for a channel.
Deletes a channel's watermark image.
Link to this section Functions
youtube_watermarks_set(connection, channel_id, optional_params \\ [], opts \\ [])
View Sourceyoutube_watermarks_set(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Uploads a watermark image to YouTube and sets it for a channel.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverchannel_id
(type:String.t
) - The channelId parameter specifies the YouTube channel ID for which the watermark is being provided.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
:body
(type:GoogleApi.YouTube.V3.Model.InvideoBranding.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
youtube_watermarks_set_iodata(connection, channel_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])
View Sourceyoutube_watermarks_set_iodata( Tesla.Env.client(), String.t(), String.t(), GoogleApi.YouTube.V3.Model.InvideoBranding.t(), iodata(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Uploads a watermark image to YouTube and sets it for a channel.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverchannel_id
(type:String.t
) - The channelId parameter specifies the YouTube channel ID for which the watermark is being provided.upload_type
(type:String.t
) - Upload type. Must be "multipart".metadata
(type:GoogleApi.YouTube.V3.Model.InvideoBranding.t
) - object metadatadata
(type:iodata
) - Content to upload, as a string or iolistoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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 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_watermarks_set_resumable(connection, channel_id, upload_type, optional_params \\ [], opts \\ [])
View Sourceyoutube_watermarks_set_resumable( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Uploads a watermark image to YouTube and sets it for a channel.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverchannel_id
(type:String.t
) - The channelId parameter specifies the YouTube channel ID for which the watermark is being provided.upload_type
(type:String.t
) - Upload type. Must be "resumable".optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
:body
(type:GoogleApi.YouTube.V3.Model.InvideoBranding.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
youtube_watermarks_set_simple(connection, channel_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])
View Sourceyoutube_watermarks_set_simple( Tesla.Env.client(), String.t(), String.t(), GoogleApi.YouTube.V3.Model.InvideoBranding.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Uploads a watermark image to YouTube and sets it for a channel.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverchannel_id
(type:String.t
) - The channelId parameter specifies the YouTube channel ID for which the watermark is being provided.upload_type
(type:String.t
) - Upload type. Must be "multipart".metadata
(type:GoogleApi.YouTube.V3.Model.InvideoBranding.t
) - object metadatadata
(type:String.t
) - Path to file containing content to uploadoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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 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_watermarks_unset(connection, channel_id, optional_params \\ [], opts \\ [])
View Sourceyoutube_watermarks_unset(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes a channel's watermark image.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverchannel_id
(type:String.t
) - The channelId parameter specifies the YouTube channel ID for which the watermark is being unset.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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 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