google_api_you_tube v0.12.0 GoogleApi.YouTube.V3.Api.ChannelSections View Source
API calls for all endpoints tagged ChannelSections
.
Link to this section Summary
Functions
Deletes a channelSection.
Adds a channelSection for the authenticated user's channel.
Returns channelSection resources that match the API request criteria.
Update a channelSection.
Link to this section Functions
youtube_channel_sections_delete(connection, id, optional_params \\ [], opts \\ [])
View Sourceyoutube_channel_sections_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes a channelSection.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverid
(type:String.t
) - The id parameter specifies the YouTube channelSection ID for the resource that is being deleted. In a channelSection resource, the id property specifies the YouTube channelSection ID.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
youtube_channel_sections_insert(connection, part, optional_params \\ [], opts \\ [])
View Sourceyoutube_channel_sections_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.YouTube.V3.Model.ChannelSection.t()} | {:error, Tesla.Env.t()}
Adds a channelSection for the authenticated user's channel.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverpart
(type:String.t
) - The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.The part names that you can include in the parameter value are snippet and contentDetails.
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.
:onBehalfOfContentOwnerChannel
(type:String.t
) - This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
:body
(type:GoogleApi.YouTube.V3.Model.ChannelSection.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.YouTube.V3.Model.ChannelSection{}}
on success{:error, info}
on failure
youtube_channel_sections_list(connection, part, optional_params \\ [], opts \\ [])
View Sourceyoutube_channel_sections_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.YouTube.V3.Model.ChannelSectionListResponse.t()} | {:error, Tesla.Env.t()}
Returns channelSection resources that match the API request criteria.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverpart
(type:String.t
) - The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set part=snippet, the API response will also contain all of those nested properties.
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 specifies a YouTube channel ID. The API will only return that channel's channelSections.:hl
(type:String.t
) - The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.:id
(type:String.t
) - The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID.:mine
(type:boolean()
) - Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections.: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.ChannelSectionListResponse{}}
on success{:error, info}
on failure
youtube_channel_sections_update(connection, part, optional_params \\ [], opts \\ [])
View Sourceyoutube_channel_sections_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.YouTube.V3.Model.ChannelSection.t()} | {:error, Tesla.Env.t()}
Update a channelSection.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverpart
(type:String.t
) - The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.The part names that you can include in the parameter value are snippet and contentDetails.
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.ChannelSection.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.YouTube.V3.Model.ChannelSection{}}
on success{:error, info}
on failure