google_api_you_tube v0.21.0 GoogleApi.YouTube.V3.Api.Activities View Source

API calls for all endpoints tagged Activities.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source

Specs

youtube_activities_list(Tesla.Env.client(), [String.t()], keyword(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.ActivityListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a list of resources, possibly filtered.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: list(String.t)) - The <code><strong>part</strong></code> parameter specifies a comma-separated list of one or more <code>activity</code> resource properties that the API response will include.<br><br>If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an <code>activity</code> resource, the <code>snippet</code> property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set <code><strong>part=snippet</strong></code>, the API response will also contain all of those nested properties.
  • 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").
    • :channelId (type: String.t) -
    • :home (type: boolean()) -
    • :maxResults (type: integer()) - The <code><strong>maxResults</strong></code> parameter specifies the maximum number of items that should be returned in the result set.
    • :mine (type: boolean()) -
    • :pageToken (type: String.t) - The <code><strong>pageToken</strong></code> parameter identifies a specific page in the result set that should be returned. In an API response, the <code>nextPageToken</code> and <code>prevPageToken</code> properties identify other pages that could be retrieved.
    • :publishedAfter (type: DateTime.t) -
    • :publishedBefore (type: DateTime.t) -
    • :regionCode (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

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