google_youtube_api_v3 - v1.0.1

google_youtube_api_v3/youtube/api/search

DO NOT CHANGE, THIS IS AN AUTO GENERATED FILE FROM generate.gleam

Types

ListChannelType

</>

Add a filter on the channel search.

pub type ListChannelType {
  ListChannelTypeChannelTypeUnspecified
  ListChannelTypeAny
  ListChannelTypeShow
}

Constructors 

  • ListChannelTypeChannelTypeUnspecified
  • ListChannelTypeAny
  • ListChannelTypeShow

ListEventType

</>

Filter on the livestream status of the videos.

pub type ListEventType {
  ListEventTypeNone
  ListEventTypeUpcoming
  ListEventTypeLive
  ListEventTypeCompleted
}

Constructors 

  • ListEventTypeNone
  • ListEventTypeUpcoming
  • ListEventTypeLive
  • ListEventTypeCompleted

ListOrder

</>

Sort order of the results.

pub type ListOrder {
  ListOrderSearchSortUnspecified
  ListOrderDate
  ListOrderRating
  ListOrderViewCount
  ListOrderRelevance
  ListOrderTitle
  ListOrderVideoCount
}

Constructors 

  • ListOrderSearchSortUnspecified
  • ListOrderDate
  • ListOrderRating
  • ListOrderViewCount
  • ListOrderRelevance
  • ListOrderTitle
  • ListOrderVideoCount

ListParams

</>

Retrieves a list of search resources

pub type ListParams {
  ListParams(
    part: List(String),
    channel_id: option.Option(String),
    channel_type: option.Option(ListChannelType),
    event_type: option.Option(ListEventType),
    for_content_owner: option.Option(Bool),
    for_developer: option.Option(Bool),
    for_mine: option.Option(Bool),
    location: option.Option(String),
    location_radius: option.Option(String),
    max_results: option.Option(Int),
    on_behalf_of_content_owner: option.Option(String),
    order: option.Option(ListOrder),
    page_token: option.Option(String),
    published_after: option.Option(String),
    published_before: option.Option(String),
    q: option.Option(String),
    region_code: option.Option(String),
    relevance_language: option.Option(String),
    safe_search: option.Option(ListSafeSearch),
    topic_id: option.Option(String),
    type_: option.Option(List(String)),
    video_caption: option.Option(ListVideoCaption),
    video_category_id: option.Option(String),
    video_definition: option.Option(ListVideoDefinition),
    video_dimension: option.Option(ListVideoDimension),
    video_duration: option.Option(ListVideoDuration),
    video_embeddable: option.Option(ListVideoEmbeddable),
    video_license: option.Option(ListVideoLicense),
    video_paid_product_placement: option.Option(
      ListVideoPaidProductPlacement,
    ),
    video_syndicated: option.Option(ListVideoSyndicated),
    video_type: option.Option(ListVideoType),
  )
}

Constructors

ListSafeSearch

</>

Indicates whether the search results should include restricted content as well as standard content.

pub type ListSafeSearch {
  ListSafeSearchSafeSearchSettingUnspecified
  ListSafeSearchNone
  ListSafeSearchModerate
  ListSafeSearchStrict
}

Constructors 

  • ListSafeSearchSafeSearchSettingUnspecified
  • ListSafeSearchNone
  • ListSafeSearchModerate
  • ListSafeSearchStrict

ListVideoCaption

</>

Filter on the presence of captions on the videos.

pub type ListVideoCaption {
  ListVideoCaptionVideoCaptionUnspecified
  ListVideoCaptionAny
  ListVideoCaptionClosedCaption
  ListVideoCaptionNone
}

Constructors 

  • ListVideoCaptionVideoCaptionUnspecified
  • ListVideoCaptionAny
  • ListVideoCaptionClosedCaption
  • ListVideoCaptionNone

ListVideoDefinition

</>

Filter on the definition of the videos.

pub type ListVideoDefinition {
  ListVideoDefinitionAny
  ListVideoDefinitionStandard
  ListVideoDefinitionHigh
}

Constructors 

  • ListVideoDefinitionAny
  • ListVideoDefinitionStandard
  • ListVideoDefinitionHigh

ListVideoDimension

</>

Filter on 3d videos.

pub type ListVideoDimension {
  ListVideoDimensionAny
  ListVideoDimensionValue2d
  ListVideoDimensionValue3d
}

Constructors 

  • ListVideoDimensionAny
  • ListVideoDimensionValue2d
  • ListVideoDimensionValue3d

ListVideoDuration

</>

Filter on the duration of the videos.

pub type ListVideoDuration {
  ListVideoDurationVideoDurationUnspecified
  ListVideoDurationAny
  ListVideoDurationShort
  ListVideoDurationMedium
  ListVideoDurationLong
}

Constructors 

  • ListVideoDurationVideoDurationUnspecified
  • ListVideoDurationAny
  • ListVideoDurationShort
  • ListVideoDurationMedium
  • ListVideoDurationLong

ListVideoEmbeddable

</>

Filter on embeddable videos.

pub type ListVideoEmbeddable {
  ListVideoEmbeddableVideoEmbeddableUnspecified
  ListVideoEmbeddableAny
  ListVideoEmbeddableTrue
}

Constructors 

  • ListVideoEmbeddableVideoEmbeddableUnspecified
  • ListVideoEmbeddableAny
  • ListVideoEmbeddableTrue

ListVideoLicense

</>

Filter on the license of the videos.

pub type ListVideoLicense {
  ListVideoLicenseAny
  ListVideoLicenseYoutube
  ListVideoLicenseCreativeCommon
}

Constructors 

  • ListVideoLicenseAny
  • ListVideoLicenseYoutube
  • ListVideoLicenseCreativeCommon

ListVideoPaidProductPlacement

</> 
pub type ListVideoPaidProductPlacement {
  ListVideoPaidProductPlacementVideoPaidProductPlacementUnspecified
  ListVideoPaidProductPlacementAny
  ListVideoPaidProductPlacementTrue
}

Constructors 

  • ListVideoPaidProductPlacementVideoPaidProductPlacementUnspecified
  • ListVideoPaidProductPlacementAny
  • ListVideoPaidProductPlacementTrue

ListVideoSyndicated

</>

Filter on syndicated videos.

pub type ListVideoSyndicated {
  ListVideoSyndicatedVideoSyndicatedUnspecified
  ListVideoSyndicatedAny
  ListVideoSyndicatedTrue
}

Constructors 

  • ListVideoSyndicatedVideoSyndicatedUnspecified
  • ListVideoSyndicatedAny
  • ListVideoSyndicatedTrue

ListVideoType

</>

Filter on videos of a specific type.

pub type ListVideoType {
  ListVideoTypeVideoTypeUnspecified
  ListVideoTypeAny
  ListVideoTypeMovie
  ListVideoTypeEpisode
}

Constructors 

  • ListVideoTypeVideoTypeUnspecified
  • ListVideoTypeAny
  • ListVideoTypeMovie
  • ListVideoTypeEpisode

Values

list

</> 
pub fn list(part: List(String)) -> ListParams

list_add_part

</> 
pub fn list_add_part(
  params: ListParams,
  value: String,
) -> ListParams

list_add_type_

</> 
pub fn list_add_type_(
  params: ListParams,
  value: String,
) -> ListParams

list_channel_type_decoder

</> 
pub fn list_channel_type_decoder() -> decode.Decoder(
  ListChannelType,
)

list_channel_type_to_string

</> 
pub fn list_channel_type_to_string(
  value: ListChannelType,
) -> String

list_event_type_decoder

</> 
pub fn list_event_type_decoder() -> decode.Decoder(ListEventType)

list_event_type_to_string

</> 
pub fn list_event_type_to_string(value: ListEventType) -> String

list_order_decoder

</> 
pub fn list_order_decoder() -> decode.Decoder(ListOrder)

list_order_to_string

</> 
pub fn list_order_to_string(value: ListOrder) -> String

list_request

</> 
pub fn list_request(params: ListParams) -> request.Request

list_safe_search_decoder

</> 
pub fn list_safe_search_decoder() -> decode.Decoder(
  ListSafeSearch,
)

list_safe_search_to_string

</> 
pub fn list_safe_search_to_string(
  value: ListSafeSearch,
) -> String

list_video_caption_decoder

</> 
pub fn list_video_caption_decoder() -> decode.Decoder(
  ListVideoCaption,
)

list_video_caption_to_string

</> 
pub fn list_video_caption_to_string(
  value: ListVideoCaption,
) -> String

list_video_definition_decoder

</> 
pub fn list_video_definition_decoder() -> decode.Decoder(
  ListVideoDefinition,
)

list_video_definition_to_string

</> 
pub fn list_video_definition_to_string(
  value: ListVideoDefinition,
) -> String

list_video_dimension_decoder

</> 
pub fn list_video_dimension_decoder() -> decode.Decoder(
  ListVideoDimension,
)

list_video_dimension_to_string

</> 
pub fn list_video_dimension_to_string(
  value: ListVideoDimension,
) -> String

list_video_duration_decoder

</> 
pub fn list_video_duration_decoder() -> decode.Decoder(
  ListVideoDuration,
)

list_video_duration_to_string

</> 
pub fn list_video_duration_to_string(
  value: ListVideoDuration,
) -> String

list_video_embeddable_decoder

</> 
pub fn list_video_embeddable_decoder() -> decode.Decoder(
  ListVideoEmbeddable,
)

list_video_embeddable_to_string

</> 
pub fn list_video_embeddable_to_string(
  value: ListVideoEmbeddable,
) -> String

list_video_license_decoder

</> 
pub fn list_video_license_decoder() -> decode.Decoder(
  ListVideoLicense,
)

list_video_license_to_string

</> 
pub fn list_video_license_to_string(
  value: ListVideoLicense,
) -> String

list_video_paid_product_placement_decoder

</> 
pub fn list_video_paid_product_placement_decoder() -> decode.Decoder(
  ListVideoPaidProductPlacement,
)

list_video_paid_product_placement_to_string

</> 
pub fn list_video_paid_product_placement_to_string(
  value: ListVideoPaidProductPlacement,
) -> String

list_video_syndicated_decoder

</> 
pub fn list_video_syndicated_decoder() -> decode.Decoder(
  ListVideoSyndicated,
)

list_video_syndicated_to_string

</> 
pub fn list_video_syndicated_to_string(
  value: ListVideoSyndicated,
) -> String

list_video_type_decoder

</> 
pub fn list_video_type_decoder() -> decode.Decoder(ListVideoType)

list_video_type_to_string

</> 
pub fn list_video_type_to_string(value: ListVideoType) -> String

list_with_channel_id

</> 
pub fn list_with_channel_id(
  params: ListParams,
  value: String,
) -> ListParams

list_with_channel_type

</> 
pub fn list_with_channel_type(
  params: ListParams,
  value: ListChannelType,
) -> ListParams

list_with_event_type

</> 
pub fn list_with_event_type(
  params: ListParams,
  value: ListEventType,
) -> ListParams

list_with_for_content_owner

</> 
pub fn list_with_for_content_owner(
  params: ListParams,
  value: Bool,
) -> ListParams

list_with_for_developer

</> 
pub fn list_with_for_developer(
  params: ListParams,
  value: Bool,
) -> ListParams

list_with_for_mine

</> 
pub fn list_with_for_mine(
  params: ListParams,
  value: Bool,
) -> ListParams

list_with_location

</> 
pub fn list_with_location(
  params: ListParams,
  value: String,
) -> ListParams

list_with_location_radius

</> 
pub fn list_with_location_radius(
  params: ListParams,
  value: String,
) -> ListParams

list_with_max_results

</> 
pub fn list_with_max_results(
  params: ListParams,
  value: Int,
) -> ListParams

list_with_on_behalf_of_content_owner

</> 
pub fn list_with_on_behalf_of_content_owner(
  params: ListParams,
  value: String,
) -> ListParams

list_with_order

</> 
pub fn list_with_order(
  params: ListParams,
  value: ListOrder,
) -> ListParams

list_with_page_token

</> 
pub fn list_with_page_token(
  params: ListParams,
  value: String,
) -> ListParams

list_with_published_after

</> 
pub fn list_with_published_after(
  params: ListParams,
  value: String,
) -> ListParams

list_with_published_before

</> 
pub fn list_with_published_before(
  params: ListParams,
  value: String,
) -> ListParams

list_with_q

</> 
pub fn list_with_q(
  params: ListParams,
  value: String,
) -> ListParams

list_with_region_code

</> 
pub fn list_with_region_code(
  params: ListParams,
  value: String,
) -> ListParams

list_with_relevance_language

</> 
pub fn list_with_relevance_language(
  params: ListParams,
  value: String,
) -> ListParams
</> 
pub fn list_with_safe_search(
  params: ListParams,
  value: ListSafeSearch,
) -> ListParams

list_with_topic_id

</> 
pub fn list_with_topic_id(
  params: ListParams,
  value: String,
) -> ListParams

list_with_type_

</> 
pub fn list_with_type_(
  params: ListParams,
  value: List(String),
) -> ListParams

list_with_video_caption

</> 
pub fn list_with_video_caption(
  params: ListParams,
  value: ListVideoCaption,
) -> ListParams

list_with_video_category_id

</> 
pub fn list_with_video_category_id(
  params: ListParams,
  value: String,
) -> ListParams

list_with_video_definition

</> 
pub fn list_with_video_definition(
  params: ListParams,
  value: ListVideoDefinition,
) -> ListParams

list_with_video_dimension

</> 
pub fn list_with_video_dimension(
  params: ListParams,
  value: ListVideoDimension,
) -> ListParams

list_with_video_duration

</> 
pub fn list_with_video_duration(
  params: ListParams,
  value: ListVideoDuration,
) -> ListParams

list_with_video_embeddable

</> 
pub fn list_with_video_embeddable(
  params: ListParams,
  value: ListVideoEmbeddable,
) -> ListParams

list_with_video_license

</> 
pub fn list_with_video_license(
  params: ListParams,
  value: ListVideoLicense,
) -> ListParams

list_with_video_paid_product_placement

</> 
pub fn list_with_video_paid_product_placement(
  params: ListParams,
  value: ListVideoPaidProductPlacement,
) -> ListParams

list_with_video_syndicated

</> 
pub fn list_with_video_syndicated(
  params: ListParams,
  value: ListVideoSyndicated,
) -> ListParams

list_with_video_type

</> 
pub fn list_with_video_type(
  params: ListParams,
  value: ListVideoType,
) -> ListParams
✨ Search Document