google_api_you_tube

v0.0.1

google_api_you_tube v0.0.1 GoogleApi.YouTube.V3.Api.Watermarks View Source

API calls for all endpoints tagged Watermarks.

Link to this section Summary

Functions

youtube_watermarks_set(connection, channel_id, opts \\ [])

Uploads a watermark image to YouTube and sets it for a channel

youtube_watermarks_set_resumable(connection, channel_id, upload_type, opts \\ [])

Uploads a watermark image to YouTube and sets it for a channel

youtube_watermarks_set_simple(connection, channel_id, upload_type, metadata, data, opts \\ [])

Uploads a watermark image to YouTube and sets it for a channel

youtube_watermarks_unset(connection, channel_id, opts \\ [])

Deletes a channel's watermark image

Link to this section Functions

Link to this function youtube_watermarks_set(connection, channel_id, opts \\ []) View Source 
youtube_watermarks_set(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Uploads a watermark image to YouTube and sets it for a channel.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • channel_id (String.t): The channelId parameter specifies the YouTube channel ID for which the watermark is being provided.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOfContentOwner (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 (InvideoBranding):

Returns

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

Link to this function youtube_watermarks_set_resumable(connection, channel_id, upload_type, opts \\ []) View Source 
youtube_watermarks_set_resumable(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Uploads a watermark image to YouTube and sets it for a channel.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • channel_id (String.t): The channelId parameter specifies the YouTube channel ID for which the watermark is being provided.
  • upload_type (String.t): Upload type. Must be "resumable".

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOfContentOwner (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 (InvideoBranding):

Returns

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

Link to this function youtube_watermarks_set_simple(connection, channel_id, upload_type, metadata, data, opts \\ []) View Source 
youtube_watermarks_set_simple(Tesla.Env.client(), String.t(), String.t(), GoogleApi.YouTube.V3.Model.InvideoBranding.t(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Uploads a watermark image to YouTube and sets it for a channel.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • channel_id (String.t): The channelId parameter specifies the YouTube channel ID for which the watermark is being provided.
  • upload_type (String.t): Upload type. Must be "multipart".
  • metadata (InvideoBranding): InvideoBranding metadata.
  • data (String.t): The file to upload.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOfContentOwner (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.

Returns

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

Link to this function youtube_watermarks_unset(connection, channel_id, opts \\ []) View Source 
youtube_watermarks_unset(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Deletes a channel's watermark image.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • channel_id (String.t): The channelId parameter specifies the YouTube channel ID for which the watermark is being unset.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOfContentOwner (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.

Returns

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