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

API calls for all endpoints tagged ThirdPartyLinks.

Summary

Functions

youtube_third_party_links_delete(connection, linking_token, type, optional_params \\ [], opts \\ [])

Deletes a resource.

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

Inserts a new resource into this collection.

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

Retrieves a list of resources, possibly filtered.

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

Updates an existing resource.

Functions

youtube_third_party_links_delete(connection, linking_token, type, optional_params \\ [], opts \\ [])

@spec youtube_third_party_links_delete(
  Tesla.Env.client(),
  String.t(),
  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
linking_token (type: String.t) - Delete the partner links with the given linking token.
type (type: String.t) - Type of the link to be deleted.
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").
- :externalChannelId (type: String.t) - Channel ID to which changes should be applied, for delegation.
- :part (type: list(String.t)) - Do not use. Required for compatibility.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_third_party_links_insert(
  Tesla.Env.client(),
  [String.t()],
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.ThirdPartyLink.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 thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, 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").
- :externalChannelId (type: String.t) - Channel ID to which changes should be applied, for delegation.
- :body (type: GoogleApi.YouTube.V3.Model.ThirdPartyLink.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_third_party_links_list(
  Tesla.Env.client(),
  [String.t()],
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.ThirdPartyLinkListResponse.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 the thirdPartyLink resource parts that the API response will include. Supported values are linkingToken, status, 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").
- :externalChannelId (type: String.t) - Channel ID to which changes should be applied, for delegation.
- :linkingToken (type: String.t) - Get a third party link with the given linking token.
- :type (type: String.t) - Get a third party link of the given type.
opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_third_party_links_update(
  Tesla.Env.client(),
  [String.t()],
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.ThirdPartyLink.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 the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, 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").
- :externalChannelId (type: String.t) - Channel ID to which changes should be applied, for delegation.
- :body (type: GoogleApi.YouTube.V3.Model.ThirdPartyLink.t) -
opts (type: keyword()) - Call options

Returns

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