google_api_you_tube

v0.0.1

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

API calls for all endpoints tagged SuperChatEvents.

Link to this section Summary

Functions

youtube_super_chat_events_list(connection, part, opts \\ [])

Lists Super Chat events for a channel

Link to this section Functions

Link to this function youtube_super_chat_events_list(connection, part, opts \\ []) View Source 
youtube_super_chat_events_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.SuperChatEventListResponse.t()} |
  {:error, Tesla.Env.t()}

Lists Super Chat events for a channel.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter specifies the superChatEvent resource parts that the API response will include. Supported values are id and snippet.

  • 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.
    • :hl (String.t): The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.
    • :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.SuperChatEventListResponse{}} on success {:error, info} on failure