GoogleApi.YouTube.V3.Api.Captions (google_api_you_tube v0.54.0)

@spec youtube_captions_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes a resource.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
id (type: String.t) -
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is be on behalf of
- :onBehalfOfContentOwner (type: 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.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_download(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Downloads a caption track.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
id (type: String.t) - The ID of the caption track to download, required for One Platform.
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is be on behalf of
- :onBehalfOfContentOwner (type: 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 (type: String.t) - Convert the captions into this format. Supported options are sbv, srt, and vtt.
- :tlang (type: String.t) - tlang is the language code; machine translate the captions into this language.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_insert(Tesla.Env.client(), [String.t()], keyword(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is be on behalf of
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
- :body (type: GoogleApi.YouTube.V3.Model.Caption.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_insert_iodata(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  GoogleApi.YouTube.V3.Model.Caption.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.YouTube.V3.Model.Caption.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is be on behalf of
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_insert_resumable(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {: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 part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
upload_type (type: String.t) - Upload type. Must be "resumable".
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is be on behalf of
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
- :body (type: GoogleApi.YouTube.V3.Model.Caption.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_insert_simple(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  GoogleApi.YouTube.V3.Model.Caption.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.YouTube.V3.Model.Caption.t) - object metadata
data (type: String.t) - Path to file containing content to upload
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is be on behalf of
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_list(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.CaptionListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 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 (type: String.t) - Returns the captions for the specified video.
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").
- :id (type: list(String.t)) - Returns the captions with the given IDs for Stubby or Apiary.
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is on behalf of.
- :onBehalfOfContentOwner (type: 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.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_update(Tesla.Env.client(), [String.t()], keyword(), keyword()) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing resource.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
part (type: list(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.
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is on behalf of.
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
- :body (type: GoogleApi.YouTube.V3.Model.Caption.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_update_iodata(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  GoogleApi.YouTube.V3.Model.Caption.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing resource.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
part (type: list(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.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.YouTube.V3.Model.Caption.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is on behalf of.
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_update_resumable(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Updates an existing resource.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
part (type: list(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.
upload_type (type: String.t) - Upload type. Must be "resumable".
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is on behalf of.
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
- :body (type: GoogleApi.YouTube.V3.Model.Caption.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_captions_update_simple(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  GoogleApi.YouTube.V3.Model.Caption.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.Caption.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing resource.

Parameters

connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
part (type: list(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.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.YouTube.V3.Model.Caption.t) - object metadata
data (type: String.t) - Path to file containing content to upload
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").
- :onBehalfOf (type: String.t) - ID of the Google+ Page for the channel that the request is on behalf of.
- :onBehalfOfContentOwner (type: 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 (type: boolean()) - Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
opts (type: keyword()) - Call options

Returns

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