google_api_you_tube v0.12.0 GoogleApi.YouTube.V3.Api.ChannelBanners View Source

API calls for all endpoints tagged ChannelBanners.

Link to this section Summary

Functions

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel

Link to this section Functions

Link to this function

youtube_channel_banners_insert(connection, optional_params \\ [], opts \\ [])

View Source
youtube_channel_banners_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.ChannelBannerResource.t()}
  | {:error, Tesla.Env.t()}

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:

  • Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.
  • Extract the url property's value from the response that the API returns for step 1.
  • Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server

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

    • :channelId (type: String.t) - The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced.

    • :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.ChannelBannerResource.t) -

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.YouTube.V3.Model.ChannelBannerResource{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:

  • Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.
  • Extract the url property's value from the response that the API returns for step 1.
  • Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server

  • upload_type (type: String.t) - Upload type. Must be "multipart".

  • metadata (type: GoogleApi.YouTube.V3.Model.ChannelBannerResource.t) - object metadata

  • data (type: iodata) - Content to upload, as a string or iolist

  • 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.
    • :channelId (type: String.t) - The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced.
    • :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, %GoogleApi.YouTube.V3.Model.ChannelBannerResource{}} on success
  • {:error, info} on failure
Link to this function

youtube_channel_banners_insert_resumable(connection, upload_type, optional_params \\ [], opts \\ [])

View Source
youtube_channel_banners_insert_resumable(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:

  • Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.
  • Extract the url property's value from the response that the API returns for step 1.
  • Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server

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

    • :channelId (type: String.t) - The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced.

    • :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.ChannelBannerResource.t) -

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:

  • Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.
  • Extract the url property's value from the response that the API returns for step 1.
  • Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server

  • upload_type (type: String.t) - Upload type. Must be "multipart".

  • metadata (type: GoogleApi.YouTube.V3.Model.ChannelBannerResource.t) - object metadata

  • data (type: String.t) - Path to file containing content to upload

  • 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.
    • :channelId (type: String.t) - The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced.
    • :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, %GoogleApi.YouTube.V3.Model.ChannelBannerResource{}} on success
  • {:error, info} on failure