google_api_you_tube v0.12.0 GoogleApi.YouTube.V3.Api.Sponsors View Source
API calls for all endpoints tagged Sponsors
.
Link to this section Summary
Functions
Lists sponsors for a channel.
Link to this section Functions
Link to this function
youtube_sponsors_list(connection, part, optional_params \\ [], opts \\ [])
View Sourceyoutube_sponsors_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.YouTube.V3.Model.SponsorListResponse.t()} | {:error, Tesla.Env.t()}
Lists sponsors for a channel.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverpart
(type:String.t
) - The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.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.:filter
(type:String.t
) - The filter parameter specifies which channel sponsors to return.:maxResults
(type:integer()
) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.:pageToken
(type:String.t
) - The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.YouTube.V3.Model.SponsorListResponse{}}
on success{:error, info}
on failure