google_api_you_tube v0.12.0 GoogleApi.YouTube.V3.Api.Comments View Source
API calls for all endpoints tagged Comments
.
Link to this section Summary
Functions
Deletes a comment.
Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.
Returns a list of comments that match the API request parameters.
Expresses the caller's opinion that one or more comments should be flagged as spam.
Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.
Modifies a comment.
Link to this section Functions
youtube_comments_delete(connection, id, optional_params \\ [], opts \\ [])
View Sourceyoutube_comments_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes a comment.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverid
(type:String.t
) - The id parameter specifies the comment ID for the resource that is being deleted.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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
youtube_comments_insert(connection, part, optional_params \\ [], opts \\ [])
View Sourceyoutube_comments_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.YouTube.V3.Model.Comment.t()} | {:error, Tesla.Env.t()}
Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverpart
(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.Comment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.YouTube.V3.Model.Comment{}}
on success{:error, info}
on failure
youtube_comments_list(connection, part, optional_params \\ [], opts \\ [])
View Sourceyoutube_comments_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.YouTube.V3.Model.CommentListResponse.t()} | {:error, Tesla.Env.t()}
Returns a list of comments that match the API request parameters.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverpart
(type:String.t
) - The part parameter specifies a comma-separated list of one or more comment 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.:id
(type:String.t
) - The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.: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.
: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.
:parentId
(type:String.t
) - The parentId parameter specifies the ID of the comment for which replies should be retrieved.Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.
:textFormat
(type:String.t
) - This parameter indicates whether the API should return comments formatted as HTML or as plain text.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.YouTube.V3.Model.CommentListResponse{}}
on success{:error, info}
on failure
youtube_comments_mark_as_spam(connection, id, optional_params \\ [], opts \\ [])
View Sourceyoutube_comments_mark_as_spam( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Expresses the caller's opinion that one or more comments should be flagged as spam.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverid
(type:String.t
) - The id parameter specifies a comma-separated list of IDs of comments that the caller believes should be classified as spam.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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
youtube_comments_set_moderation_status(connection, id, moderation_status, optional_params \\ [], opts \\ [])
View Sourceyoutube_comments_set_moderation_status( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverid
(type:String.t
) - The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.moderation_status
(type:String.t
) - Identifies the new moderation status of the specified comments.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.:banAuthor
(type:boolean()
) - The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author.Note: This parameter is only valid if the moderationStatus parameter is also set to rejected.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
youtube_comments_update(connection, part, optional_params \\ [], opts \\ [])
View Sourceyoutube_comments_update(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.YouTube.V3.Model.Comment.t()} | {:error, Tesla.Env.t()}
Modifies a comment.
Parameters
connection
(type:GoogleApi.YouTube.V3.Connection.t
) - Connection to serverpart
(type:String.t
) - The part parameter identifies the 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.Comment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.YouTube.V3.Model.Comment{}}
on success{:error, info}
on failure