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

API calls for all endpoints tagged Subscriptions.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source
youtube_subscriptions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a subscription.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • id (type: String.t) - The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID.
  • 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
Link to this function

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

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

Adds a subscription for the authenticated user's channel.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: 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.
  • 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.Subscription.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.YouTube.V3.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

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

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

Returns subscription resources that match the API request criteria.

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 subscription resource properties that the API response will include.

    If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties.

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

    • :channelId (type: String.t) - The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions.

    • :forChannelId (type: String.t) - The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels.

    • :id (type: String.t) - The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.

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

    • :mine (type: boolean()) - Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions.

    • :myRecentSubscribers (type: boolean()) - Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in reverse chronological order (newest first).

    • :mySubscribers (type: boolean()) - Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in no particular order.

    • :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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

    • :onBehalfOfContentOwnerChannel (type: String.t) - This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

      The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

      This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

    • :order (type: String.t) - The order parameter specifies the method that will be used to sort resources in the API response.

    • :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 and prevPageToken properties identify other pages that could be retrieved.

  • opts (type: keyword()) - Call options

Returns

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