GoogleApi.YouTube.V3.Api.Members (google_api_you_tube v0.54.0)

View Source

API calls for all endpoints tagged Members.

Summary

Functions

Retrieves a list of members that match the request criteria for a channel.

Functions

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

@spec youtube_members_list(Tesla.Env.client(), [String.t()], keyword(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.MemberListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of members that match the request criteria for a channel.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: list(String.t)) - The part parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filterByMemberChannelId (type: String.t) - Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response.
    • :hasAccessToLevel (type: String.t) - Filter members in the results set to the ones that have access to a 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) - Parameter that 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