google_api_you_tube

v0.23.0

google_api_you_tube v0.23.0 GoogleApi.YouTube.V3.Api.CommentThreads View Source

API calls for all endpoints tagged CommentThreads.

Link to this section Summary

Functions

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

Inserts a new resource into this collection.

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

Retrieves a list of resources, possibly filtered.

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

Updates an existing resource.

Link to this section Functions

Link to this function

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

View Source

Specs

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

Inserts a new resource into this collection.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: list(String.t)) - The <code><strong>part</strong></code> parameter identifies the properties that the API response will include. Set the parameter value to <code>snippet</code>. The <code>snippet</code> part has a quota cost of 2 units.
  • 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").
    • :body (type: GoogleApi.YouTube.V3.Model.CommentThread.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.YouTube.V3.Model.CommentThread{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

youtube_comment_threads_list(
  Tesla.Env.client(),
  [String.t()],
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.CommentThreadListResponse.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>commentThread</code> resource properties that the API response will include.
  • 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").
    • :allThreadsRelatedToChannelId (type: String.t) - Returns the comment threads of all videos of the channel and the channel comments as well.
    • :channelId (type: String.t) - Returns the comment threads for all the channel comments (ie does not include comments left on videos).
    • :id (type: list(String.t)) - Returns the comment threads with the given IDs for Stubby or Apiary.
    • :maxResults (type: integer()) - The <code><strong>maxResults</strong></code> parameter specifies the maximum number of items that should be returned in the result set.
    • :moderationStatus (type: String.t) - Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.
    • :order (type: String.t) -
    • :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.
    • :searchTerms (type: String.t) - Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.
    • :textFormat (type: String.t) - The requested text format for the returned comments.
    • :videoId (type: String.t) - Returns the comment threads of the specified video.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.YouTube.V3.Model.CommentThreadListResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Updates an existing resource.

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 <code>commentThread</code> resource properties that the API response will include. You must at least include the <code>snippet</code> part in the parameter value since that part contains all of the properties that the API request can update.
  • 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").
    • :body (type: GoogleApi.YouTube.V3.Model.CommentThread.t) -
  • opts (type: keyword()) - Call options

Returns

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