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

API calls for all endpoints tagged Members.

Link to this section Summary

Link to this section Functions

Link to this function

youtube_members_list(connection, part, optional_params \\ [], opts \\ [])

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

Lists members for a channel.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: String.t) - The part parameter specifies the member 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.
    • :hasAccessToLevel (type: String.t) - The hasAccessToLevel parameter specifies, when set, the ID of a pricing level that members from the results set should have access to. When not set, all members will be considered, regardless of their active pricing level.
    • :maxResults (type: integer()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
    • :mode (type: String.t) - The mode parameter specifies which channel members to return.
    • :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.MemberListResponse{}} on success
  • {:error, info} on failure