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

API calls for all endpoints tagged CommentThreads.

Link to this section Summary

Functions

Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead.

Returns a list of comment threads that match the API request parameters.

Link to this section Functions

Link to this function

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

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

Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: String.t) - The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.
  • 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.
    • :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
youtube_comment_threads_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.CommentThreadListResponse.t()}
  | {:error, Tesla.Env.t()}

Returns a list of comment threads that match the API request parameters.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server

  • part (type: String.t) - The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.

  • 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.

    • :allThreadsRelatedToChannelId (type: String.t) - The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos.

    • :channelId (type: String.t) - The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.)

    • :id (type: String.t) - The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.

    • :maxResults (type: integer()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.

      Note: This parameter is not supported for use in conjunction with the id parameter.

    • :moderationStatus (type: String.t) - Set this parameter to limit the returned comment threads to a particular moderation state.

      Note: This parameter is not supported for use in conjunction with the id parameter.

    • :order (type: String.t) - The order parameter specifies the order in which the API response should list comment threads. Valid values are:

      • time - Comment threads are ordered by time. This is the default behavior.
      • relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.
    • :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 property identifies the next page of the result that can be retrieved.

      Note: This parameter is not supported for use in conjunction with the id parameter.

    • :searchTerms (type: String.t) - The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.

      Note: This parameter is not supported for use in conjunction with the id parameter.

    • :textFormat (type: String.t) - Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.

    • :videoId (type: String.t) - The videoId parameter instructs the API to return comment threads associated with the specified video ID.

  • 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
youtube_comment_threads_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.CommentThread.t()} | {:error, Tesla.Env.t()}

Modifies the top-level comment in a comment thread.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: String.t) - The part parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet 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

    • :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.
    • :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