google_api_you_tube

v0.0.1

google_api_you_tube v0.0.1 GoogleApi.YouTube.V3.Api.Captions View Source

API calls for all endpoints tagged Captions.

Link to this section Summary

Functions

youtube_captions_delete(connection, id, opts \\ [])

Deletes a specified caption track

youtube_captions_download(connection, id, opts \\ [])

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter

youtube_captions_insert(connection, part, opts \\ [])

Uploads a caption track

youtube_captions_insert_resumable(connection, part, upload_type, opts \\ [])

Uploads a caption track

youtube_captions_insert_simple(connection, part, upload_type, metadata, data, opts \\ [])

Uploads a caption track

youtube_captions_list(connection, part, video_id, opts \\ [])

Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track

youtube_captions_update(connection, part, opts \\ [])

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both

youtube_captions_update_resumable(connection, part, upload_type, opts \\ [])

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both

youtube_captions_update_simple(connection, part, upload_type, metadata, data, opts \\ [])

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both

Link to this section Functions

Link to this function youtube_captions_delete(connection, id, opts \\ []) View Source 
youtube_captions_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Deletes a specified caption track.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • id (String.t): The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function youtube_captions_download(connection, id, opts \\ []) View Source 
youtube_captions_download(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • id (String.t): The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
    • :tfmt (String.t): The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.
    • :tlang (String.t): The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function youtube_captions_insert(connection, part, opts \\ []) View Source 
youtube_captions_insert(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()} |
  {:error, Tesla.Env.t()}

Uploads a caption track.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
    • :sync (boolean()): The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions. You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.
    • :body (Caption):

Returns

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

Link to this function youtube_captions_insert_resumable(connection, part, upload_type, opts \\ []) View Source 
youtube_captions_insert_resumable(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Uploads a caption track.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
  • upload_type (String.t): Upload type. Must be "resumable".

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
    • :sync (boolean()): The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions. You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.
    • :body (Caption):

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function youtube_captions_insert_simple(connection, part, upload_type, metadata, data, opts \\ []) View Source 
youtube_captions_insert_simple(Tesla.Env.client(), String.t(), String.t(), GoogleApi.YouTube.V3.Model.Caption.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()} |
  {:error, Tesla.Env.t()}

Uploads a caption track.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
  • upload_type (String.t): Upload type. Must be "multipart".
  • metadata (Caption): Caption metadata.
  • data (String.t): The file to upload.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
    • :sync (boolean()): The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions. You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.

Returns

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

Link to this function youtube_captions_list(connection, part, video_id, opts \\ []) View Source 
youtube_captions_list(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.CaptionListResponse.t()} |
  {:error, Tesla.Env.t()}

Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.
  • video_id (String.t): The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :id (String.t): The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is on behalf of.
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns

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

Link to this function youtube_captions_update(connection, part, opts \\ []) View Source 
youtube_captions_update(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()} |
  {:error, Tesla.Env.t()}

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
    • :sync (boolean()): Note: The API server only processes the parameter value if the request contains an updated caption file. The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.
    • :body (Caption):

Returns

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

Link to this function youtube_captions_update_resumable(connection, part, upload_type, opts \\ []) View Source 
youtube_captions_update_resumable(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} |
  {:error, Tesla.Env.t()}

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.
  • upload_type (String.t): Upload type. Must be "resumable".

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
    • :sync (boolean()): Note: The API server only processes the parameter value if the request contains an updated caption file. The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.
    • :body (Caption):

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function youtube_captions_update_simple(connection, part, upload_type, metadata, data, opts \\ []) View Source 
youtube_captions_update_simple(Tesla.Env.client(), String.t(), String.t(), GoogleApi.YouTube.V3.Model.Caption.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()} |
  {:error, Tesla.Env.t()}

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

Parameters

  • connection (GoogleApi.YouTube.V3.Connection): Connection to server
  • part (String.t): The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.
  • upload_type (String.t): Upload type. Must be "multipart".
  • metadata (Caption): Caption metadata.
  • data (String.t): The file to upload.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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. Overrides userIp if both are provided.
    • :userIp (String.t): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :onBehalfOf (String.t): ID of the Google+ Page for the channel that the request is be on behalf of
    • :onBehalfOfContentOwner (String.t): Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
    • :sync (boolean()): Note: The API server only processes the parameter value if the request contains an updated caption file. The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.

Returns

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