google_api_you_tube v0.4.0 GoogleApi.YouTube.V3.Api.Sponsors View Source

API calls for all endpoints tagged Sponsors.

Link to this section Summary

Link to this section Functions

Link to this function

youtube_sponsors_list(connection, part, optional_params \\ [], opts \\ []) View Source

Lists sponsors for a channel.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.
  • optional_params (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): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :filter (String.t): The filter parameter specifies which channel sponsors to return.
    • :maxResults (integer()): The maxResults parameter specifies the maximum number of items that should be returned in the result set.
    • :pageToken (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.

Returns

{:ok, %GoogleApi.YouTube.V3.Model.SponsorListResponse{}} on success {:error, info} on failure