google_youtube_api_v3 - v2.0.0

google_youtube_api_v3/youtube/channel

Types

BillingStatus

</>

The current billing profile status.

pub type BillingStatus {
  BillingStatusBillingStatusUnspecified
  BillingStatusBillingStatusPending
  BillingStatusBillingStatusActive
  BillingStatusBillingStatusInactive
}

Constructors 

  • BillingStatusBillingStatusUnspecified
  • BillingStatusBillingStatusPending
  • BillingStatusBillingStatusActive
  • BillingStatusBillingStatusInactive

Channel

</>

A channel resource contains information about a YouTube channel.

pub type Channel {
  Channel(
    audit_details: option.Option(ChannelAuditDetails),
    branding_settings: option.Option(ChannelBrandingSettings),
    content_details: option.Option(ChannelContentDetails),
    content_owner_details: option.Option(
      ChannelContentOwnerDetails,
    ),
    conversion_pings: option.Option(ChannelConversionPings),
    etag: option.Option(String),
    id: option.Option(String),
    kind: option.Option(String),
    localizations: option.Option(
      dict.Dict(String, ChannelLocalization),
    ),
    snippet: option.Option(ChannelSnippet),
    statistics: option.Option(ChannelStatistics),
    status: option.Option(ChannelStatus),
    topic_details: option.Option(ChannelTopicDetails),
  )
}

Constructors

ChannelAuditDetails

</>

The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process.

pub type ChannelAuditDetails {
  ChannelAuditDetails(
    community_guidelines_good_standing: option.Option(Bool),
    content_id_claims_good_standing: option.Option(Bool),
    copyright_strikes_good_standing: option.Option(Bool),
  )
}

Constructors

ChannelBannerResource

</>

A channel banner returned as the response to a channel_banner.insert call.

pub type ChannelBannerResource {
  ChannelBannerResource(
    etag: option.Option(String),
    kind: option.Option(String),
    url: option.Option(String),
  )
}

Constructors

ChannelBrandingSettings

</>

Branding properties of a YouTube channel.

pub type ChannelBrandingSettings {
  ChannelBrandingSettings(
    channel: option.Option(ChannelSettings),
    hints: option.Option(List(PropertyValue)),
    image: option.Option(ImageSettings),
    watch: option.Option(WatchSettings),
  )
}

Constructors

ChannelContentDetails

</>

Details about the content of a channel.

pub type ChannelContentDetails {
  ChannelContentDetails(
    related_playlists: option.Option(dict.Dict(String, String)),
  )
}

Constructors

ChannelContentOwnerDetails

</>

The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.

pub type ChannelContentOwnerDetails {
  ChannelContentOwnerDetails(
    content_owner: option.Option(String),
    time_linked: option.Option(String),
  )
}

Constructors

ChannelConversionPing

</>

Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

pub type ChannelConversionPing {
  ChannelConversionPing(
    context: option.Option(Context),
    conversion_url: option.Option(String),
  )
}

Constructors

ChannelConversionPings

</>

The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.

pub type ChannelConversionPings {
  ChannelConversionPings(
    pings: option.Option(List(ChannelConversionPing)),
  )
}

Constructors

ChannelListResponse

</> 
pub type ChannelListResponse {
  ChannelListResponse(
    etag: option.Option(String),
    event_id: option.Option(String),
    items: option.Option(List(Channel)),
    kind: option.Option(String),
    next_page_token: option.Option(String),
    page_info: option.Option(page_info.PageInfo),
    prev_page_token: option.Option(String),
    token_pagination: option.Option(
      token_pagination.TokenPagination,
    ),
    visitor_id: option.Option(String),
  )
}

Constructors

ChannelLocalization

</>

Channel localization setting

pub type ChannelLocalization {
  ChannelLocalization(
    description: option.Option(String),
    title: option.Option(String),
  )
}

Constructors

ChannelProfileDetails

</> 
pub type ChannelProfileDetails {
  ChannelProfileDetails(
    channel_id: option.Option(String),
    channel_url: option.Option(String),
    display_name: option.Option(String),
    profile_image_url: option.Option(String),
  )
}

Constructors

ChannelSection

</> 
pub type ChannelSection {
  ChannelSection(
    content_details: option.Option(ChannelSectionContentDetails),
    etag: option.Option(String),
    id: option.Option(String),
    kind: option.Option(String),
    localizations: option.Option(
      dict.Dict(String, ChannelSectionLocalization),
    ),
    snippet: option.Option(ChannelSectionSnippet),
    targeting: option.Option(ChannelSectionTargeting),
  )
}

Constructors

ChannelSectionContentDetails

</>

Details about a channelsection, including playlists and channels.

pub type ChannelSectionContentDetails {
  ChannelSectionContentDetails(
    channels: option.Option(List(String)),
    playlists: option.Option(List(String)),
  )
}

Constructors

ChannelSectionListResponse

</> 
pub type ChannelSectionListResponse {
  ChannelSectionListResponse(
    etag: option.Option(String),
    event_id: option.Option(String),
    items: option.Option(List(ChannelSection)),
    kind: option.Option(String),
    visitor_id: option.Option(String),
  )
}

Constructors

ChannelSectionLocalization

</>

ChannelSection localization setting

pub type ChannelSectionLocalization {
  ChannelSectionLocalization(title: option.Option(String))
}

Constructors

ChannelSectionSnippet

</>

Basic details about a channel section, including title, style and position.

pub type ChannelSectionSnippet {
  ChannelSectionSnippet(
    channel_id: option.Option(String),
    default_language: option.Option(String),
    localized: option.Option(ChannelSectionLocalization),
    position: option.Option(Int),
    style: option.Option(Style),
    title: option.Option(String),
    type_: option.Option(Type),
  )
}

Constructors

ChannelSectionTargeting

</>

ChannelSection targeting setting.

pub type ChannelSectionTargeting {
  ChannelSectionTargeting(
    countries: option.Option(List(String)),
    languages: option.Option(List(String)),
    regions: option.Option(List(String)),
  )
}

Constructors

ChannelSettings

</>

Branding properties for the channel view.

pub type ChannelSettings {
  ChannelSettings(
    country: option.Option(String),
    default_language: option.Option(String),
    default_tab: option.Option(String),
    description: option.Option(String),
    featured_channels_title: option.Option(String),
    featured_channels_urls: option.Option(List(String)),
    keywords: option.Option(String),
    moderate_comments: option.Option(Bool),
    profile_color: option.Option(String),
    show_browse_view: option.Option(Bool),
    show_related_channels: option.Option(Bool),
    title: option.Option(String),
    tracking_analytics_account_id: option.Option(String),
    unsubscribed_trailer: option.Option(String),
  )
}

Constructors

ChannelSnippet

</>

Basic details about a channel, including title, description and thumbnails.

pub type ChannelSnippet {
  ChannelSnippet(
    country: option.Option(String),
    custom_url: option.Option(String),
    default_language: option.Option(String),
    description: option.Option(String),
    localized: option.Option(ChannelLocalization),
    published_at: option.Option(String),
    thumbnails: option.Option(thumbnail.ThumbnailDetails),
    title: option.Option(String),
  )
}

Constructors

ChannelStatistics

</>

Statistics about a channel: number of subscribers, number of videos in the channel, etc.

pub type ChannelStatistics {
  ChannelStatistics(
    comment_count: option.Option(String),
    hidden_subscriber_count: option.Option(Bool),
    subscriber_count: option.Option(String),
    video_count: option.Option(String),
    view_count: option.Option(String),
  )
}

Constructors

ChannelStatus

</>

JSON template for the status part of a channel.

pub type ChannelStatus {
  ChannelStatus(
    is_channel_monetization_enabled: option.Option(Bool),
    is_linked: option.Option(Bool),
    long_uploads_status: option.Option(LongUploadsStatus),
    made_for_kids: option.Option(Bool),
    privacy_status: option.Option(PrivacyStatus),
    self_declared_made_for_kids: option.Option(Bool),
  )
}

Constructors

ChannelToAffiliateProgramLinkDetails

</>

Information specific to a creator in an affiliate program linked to a YouTube channel.

pub type ChannelToAffiliateProgramLinkDetails {
  ChannelToAffiliateProgramLinkDetails(
    merchant_id: option.Option(String),
    program_status: option.Option(ProgramStatus),
    status_update_reason: option.Option(String),
    status_update_time: option.Option(String),
  )
}

Constructors

ChannelToStoreLinkDetails

</>

Information specific to a store on a merchandising platform linked to a YouTube channel.

pub type ChannelToStoreLinkDetails {
  ChannelToStoreLinkDetails(
    billing_details: option.Option(
      ChannelToStoreLinkDetailsBillingDetails,
    ),
    merchant_affiliate_program_details: option.Option(
      ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails,
    ),
    merchant_id: option.Option(String),
    store_name: option.Option(String),
    store_url: option.Option(String),
  )
}

Constructors

ChannelToStoreLinkDetailsBillingDetails

</>

Information specific to billing.

pub type ChannelToStoreLinkDetailsBillingDetails {
  ChannelToStoreLinkDetailsBillingDetails(
    billing_status: option.Option(BillingStatus),
  )
}

Constructors

ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails

</>

Information specific to merchant affiliate program.

pub type ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails {
  ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails(
    status: option.Option(Status),
  )
}

Constructors

ChannelTopicDetails

</>

Freebase topic information related to the channel.

pub type ChannelTopicDetails {
  ChannelTopicDetails(
    topic_categories: option.Option(List(String)),
    topic_ids: option.Option(List(String)),
  )
}

Constructors

Context

</>

Defines the context of the ping.

pub type Context {
  ContextSubscribe
  ContextUnsubscribe
  ContextCview
}

Constructors 

  • ContextSubscribe
  • ContextUnsubscribe
  • ContextCview

ImageSettings

</>

Branding properties for images associated with the channel.

pub type ImageSettings {
  ImageSettings(
    background_image_url: option.Option(
      localized.LocalizedProperty,
    ),
    banner_external_url: option.Option(String),
    banner_image_url: option.Option(String),
    banner_mobile_extra_hd_image_url: option.Option(String),
    banner_mobile_hd_image_url: option.Option(String),
    banner_mobile_image_url: option.Option(String),
    banner_mobile_low_image_url: option.Option(String),
    banner_mobile_medium_hd_image_url: option.Option(String),
    banner_tablet_extra_hd_image_url: option.Option(String),
    banner_tablet_hd_image_url: option.Option(String),
    banner_tablet_image_url: option.Option(String),
    banner_tablet_low_image_url: option.Option(String),
    banner_tv_high_image_url: option.Option(String),
    banner_tv_image_url: option.Option(String),
    banner_tv_low_image_url: option.Option(String),
    banner_tv_medium_image_url: option.Option(String),
    large_branded_banner_image_imap_script: option.Option(
      localized.LocalizedProperty,
    ),
    large_branded_banner_image_url: option.Option(
      localized.LocalizedProperty,
    ),
    small_branded_banner_image_imap_script: option.Option(
      localized.LocalizedProperty,
    ),
    small_branded_banner_image_url: option.Option(
      localized.LocalizedProperty,
    ),
    tracking_image_url: option.Option(String),
    watch_icon_image_url: option.Option(String),
  )
}

Constructors

LongUploadsStatus

</>

The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.

pub type LongUploadsStatus {
  LongUploadsStatusLongUploadsUnspecified
  LongUploadsStatusAllowed
  LongUploadsStatusEligible
  LongUploadsStatusDisallowed
}

Constructors 

  • LongUploadsStatusLongUploadsUnspecified
  • LongUploadsStatusAllowed
  • LongUploadsStatusEligible
  • LongUploadsStatusDisallowed

PrivacyStatus

</>

Privacy status of the channel.

pub type PrivacyStatus {
  PrivacyStatusPublic
  PrivacyStatusUnlisted
  PrivacyStatusPrivate
}

Constructors 

  • PrivacyStatusPublic
  • PrivacyStatusUnlisted
  • PrivacyStatusPrivate

ProgramStatus

</>

Required. Affiliate program status.

pub type ProgramStatus {
  ProgramStatusAffiliateProgramStatusUnspecified
  ProgramStatusActive
  ProgramStatusInactive
}

Constructors 

  • ProgramStatusAffiliateProgramStatusUnspecified
  • ProgramStatusActive
  • ProgramStatusInactive

PropertyValue

</>

A pair Property / Value.

pub type PropertyValue {
  PropertyValue(
    property: option.Option(String),
    value: option.Option(String),
  )
}

Constructors

Status

</>

The current merchant affiliate program status.

pub type Status {
  StatusMerchantAffiliateProgramStatusUnspecified
  StatusMerchantAffiliateProgramStatusEligible
  StatusMerchantAffiliateProgramStatusActive
  StatusMerchantAffiliateProgramStatusPaused
}

Constructors 

  • StatusMerchantAffiliateProgramStatusUnspecified
  • StatusMerchantAffiliateProgramStatusEligible
  • StatusMerchantAffiliateProgramStatusActive
  • StatusMerchantAffiliateProgramStatusPaused

Style

</>

The style of the channel section.

pub type Style {
  StyleChannelsectionStyleUnspecified
  StyleHorizontalRow
  StyleVerticalList
}

Constructors 

  • StyleChannelsectionStyleUnspecified
  • StyleHorizontalRow
  • StyleVerticalList

Type

</>

The type of the channel section.

pub type Type {
  TypeChannelsectionTypeUndefined
  TypeSinglePlaylist
  TypeMultiplePlaylists
  TypePopularUploads
  TypeRecentUploads
  TypeLikes
  TypeAllPlaylists
  TypeLikedPlaylists
  TypeRecentPosts
  TypeRecentActivity
  TypeLiveEvents
  TypeUpcomingEvents
  TypeCompletedEvents
  TypeMultipleChannels
  TypePostedVideos
  TypePostedPlaylists
  TypeSubscriptions
}

Constructors 

  • TypeChannelsectionTypeUndefined
  • TypeSinglePlaylist
  • TypeMultiplePlaylists
  • TypePopularUploads
  • TypeRecentUploads
  • TypeLikes
  • TypeAllPlaylists
  • TypeLikedPlaylists
  • TypeRecentPosts
  • TypeRecentActivity
  • TypeLiveEvents
  • TypeUpcomingEvents
  • TypeCompletedEvents
  • TypeMultipleChannels
  • TypePostedVideos
  • TypePostedPlaylists
  • TypeSubscriptions

WatchSettings

</>

Branding properties for the watch. All deprecated.

pub type WatchSettings {
  WatchSettings(
    background_color: option.Option(String),
    featured_playlist_id: option.Option(String),
    text_color: option.Option(String),
  )
}

Constructors

Values

billing_status_decoder

</> 
pub fn billing_status_decoder() -> decode.Decoder(BillingStatus)

billing_status_to_string

</> 
pub fn billing_status_to_string(value: BillingStatus) -> String

channel_audit_details_decoder

</> 
pub fn channel_audit_details_decoder() -> decode.Decoder(
  ChannelAuditDetails,
)

channel_audit_details_to_json

</> 
pub fn channel_audit_details_to_json(
  value: ChannelAuditDetails,
) -> json.Json

channel_banner_resource_decoder

</> 
pub fn channel_banner_resource_decoder() -> decode.Decoder(
  ChannelBannerResource,
)

channel_banner_resource_to_json

</> 
pub fn channel_banner_resource_to_json(
  value: ChannelBannerResource,
) -> json.Json

channel_branding_settings_decoder

</> 
pub fn channel_branding_settings_decoder() -> decode.Decoder(
  ChannelBrandingSettings,
)

channel_branding_settings_to_json

</> 
pub fn channel_branding_settings_to_json(
  value: ChannelBrandingSettings,
) -> json.Json

channel_content_details_decoder

</> 
pub fn channel_content_details_decoder() -> decode.Decoder(
  ChannelContentDetails,
)

channel_content_details_to_json

</> 
pub fn channel_content_details_to_json(
  value: ChannelContentDetails,
) -> json.Json

channel_content_owner_details_decoder

</> 
pub fn channel_content_owner_details_decoder() -> decode.Decoder(
  ChannelContentOwnerDetails,
)

channel_content_owner_details_to_json

</> 
pub fn channel_content_owner_details_to_json(
  value: ChannelContentOwnerDetails,
) -> json.Json

channel_conversion_ping_decoder

</> 
pub fn channel_conversion_ping_decoder() -> decode.Decoder(
  ChannelConversionPing,
)

channel_conversion_ping_to_json

</> 
pub fn channel_conversion_ping_to_json(
  value: ChannelConversionPing,
) -> json.Json

channel_conversion_pings_decoder

</> 
pub fn channel_conversion_pings_decoder() -> decode.Decoder(
  ChannelConversionPings,
)

channel_conversion_pings_to_json

</> 
pub fn channel_conversion_pings_to_json(
  value: ChannelConversionPings,
) -> json.Json

channel_decoder

</> 
pub fn channel_decoder() -> decode.Decoder(Channel)

channel_list_response_decoder

</> 
pub fn channel_list_response_decoder() -> decode.Decoder(
  ChannelListResponse,
)

channel_list_response_to_json

</> 
pub fn channel_list_response_to_json(
  value: ChannelListResponse,
) -> json.Json

channel_localization_decoder

</> 
pub fn channel_localization_decoder() -> decode.Decoder(
  ChannelLocalization,
)

channel_localization_to_json

</> 
pub fn channel_localization_to_json(
  value: ChannelLocalization,
) -> json.Json

channel_profile_details_decoder

</> 
pub fn channel_profile_details_decoder() -> decode.Decoder(
  ChannelProfileDetails,
)

channel_profile_details_to_json

</> 
pub fn channel_profile_details_to_json(
  value: ChannelProfileDetails,
) -> json.Json

channel_section_content_details_decoder

</> 
pub fn channel_section_content_details_decoder() -> decode.Decoder(
  ChannelSectionContentDetails,
)

channel_section_content_details_to_json

</> 
pub fn channel_section_content_details_to_json(
  value: ChannelSectionContentDetails,
) -> json.Json

channel_section_decoder

</> 
pub fn channel_section_decoder() -> decode.Decoder(ChannelSection)

channel_section_list_response_decoder

</> 
pub fn channel_section_list_response_decoder() -> decode.Decoder(
  ChannelSectionListResponse,
)

channel_section_list_response_to_json

</> 
pub fn channel_section_list_response_to_json(
  value: ChannelSectionListResponse,
) -> json.Json

channel_section_localization_decoder

</> 
pub fn channel_section_localization_decoder() -> decode.Decoder(
  ChannelSectionLocalization,
)

channel_section_localization_to_json

</> 
pub fn channel_section_localization_to_json(
  value: ChannelSectionLocalization,
) -> json.Json

channel_section_snippet_decoder

</> 
pub fn channel_section_snippet_decoder() -> decode.Decoder(
  ChannelSectionSnippet,
)

channel_section_snippet_to_json

</> 
pub fn channel_section_snippet_to_json(
  value: ChannelSectionSnippet,
) -> json.Json

channel_section_targeting_decoder

</> 
pub fn channel_section_targeting_decoder() -> decode.Decoder(
  ChannelSectionTargeting,
)

channel_section_targeting_to_json

</> 
pub fn channel_section_targeting_to_json(
  value: ChannelSectionTargeting,
) -> json.Json

channel_section_to_json

</> 
pub fn channel_section_to_json(
  value: ChannelSection,
) -> json.Json

channel_settings_decoder

</> 
pub fn channel_settings_decoder() -> decode.Decoder(
  ChannelSettings,
)

channel_settings_to_json

</> 
pub fn channel_settings_to_json(
  value: ChannelSettings,
) -> json.Json

channel_snippet_decoder

</> 
pub fn channel_snippet_decoder() -> decode.Decoder(ChannelSnippet)

channel_snippet_to_json

</> 
pub fn channel_snippet_to_json(
  value: ChannelSnippet,
) -> json.Json

channel_statistics_decoder

</> 
pub fn channel_statistics_decoder() -> decode.Decoder(
  ChannelStatistics,
)

channel_statistics_to_json

</> 
pub fn channel_statistics_to_json(
  value: ChannelStatistics,
) -> json.Json

channel_status_decoder

</> 
pub fn channel_status_decoder() -> decode.Decoder(ChannelStatus)

channel_status_to_json

</> 
pub fn channel_status_to_json(value: ChannelStatus) -> json.Json
</> 
pub fn channel_to_affiliate_program_link_details_decoder() -> decode.Decoder(
  ChannelToAffiliateProgramLinkDetails,
)
</> 
pub fn channel_to_affiliate_program_link_details_to_json(
  value: ChannelToAffiliateProgramLinkDetails,
) -> json.Json

channel_to_json

</> 
pub fn channel_to_json(value: Channel) -> json.Json
</> 
pub fn channel_to_store_link_details_billing_details_decoder() -> decode.Decoder(
  ChannelToStoreLinkDetailsBillingDetails,
)
</> 
pub fn channel_to_store_link_details_billing_details_to_json(
  value: ChannelToStoreLinkDetailsBillingDetails,
) -> json.Json
</> 
pub fn channel_to_store_link_details_decoder() -> decode.Decoder(
  ChannelToStoreLinkDetails,
)
</> 
pub fn channel_to_store_link_details_merchant_affiliate_program_details_decoder() -> decode.Decoder(
  ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails,
)
</> 
pub fn channel_to_store_link_details_merchant_affiliate_program_details_to_json(
  value: ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails,
) -> json.Json
</> 
pub fn channel_to_store_link_details_to_json(
  value: ChannelToStoreLinkDetails,
) -> json.Json

channel_topic_details_decoder

</> 
pub fn channel_topic_details_decoder() -> decode.Decoder(
  ChannelTopicDetails,
)

channel_topic_details_to_json

</> 
pub fn channel_topic_details_to_json(
  value: ChannelTopicDetails,
) -> json.Json

context_decoder

</> 
pub fn context_decoder() -> decode.Decoder(Context)

context_to_string

</> 
pub fn context_to_string(value: Context) -> String

image_settings_decoder

</> 
pub fn image_settings_decoder() -> decode.Decoder(ImageSettings)

image_settings_to_json

</> 
pub fn image_settings_to_json(value: ImageSettings) -> json.Json

long_uploads_status_decoder

</> 
pub fn long_uploads_status_decoder() -> decode.Decoder(
  LongUploadsStatus,
)

long_uploads_status_to_string

</> 
pub fn long_uploads_status_to_string(
  value: LongUploadsStatus,
) -> String

privacy_status_decoder

</> 
pub fn privacy_status_decoder() -> decode.Decoder(PrivacyStatus)

privacy_status_to_string

</> 
pub fn privacy_status_to_string(value: PrivacyStatus) -> String

program_status_decoder

</> 
pub fn program_status_decoder() -> decode.Decoder(ProgramStatus)

program_status_to_string

</> 
pub fn program_status_to_string(value: ProgramStatus) -> String

property_value_decoder

</> 
pub fn property_value_decoder() -> decode.Decoder(PropertyValue)

property_value_to_json

</> 
pub fn property_value_to_json(value: PropertyValue) -> json.Json

status_decoder

</> 
pub fn status_decoder() -> decode.Decoder(Status)

status_to_string

</> 
pub fn status_to_string(value: Status) -> String

style_decoder

</> 
pub fn style_decoder() -> decode.Decoder(Style)

style_to_string

</> 
pub fn style_to_string(value: Style) -> String

type_decoder

</> 
pub fn type_decoder() -> decode.Decoder(Type)

type_to_string

</> 
pub fn type_to_string(value: Type) -> String

watch_settings_decoder

</> 
pub fn watch_settings_decoder() -> decode.Decoder(WatchSettings)

watch_settings_to_json

</> 
pub fn watch_settings_to_json(value: WatchSettings) -> json.Json
✨ Search Document