GoogleApi.YouTube.V3.Model.SearchResult (google_api_you_tube v0.54.0)

View Source

A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.

Attributes

  • etag (type: String.t, default: nil) - Etag of this resource.
  • id (type: GoogleApi.YouTube.V3.Model.ResourceId.t, default: nil) - The id object contains information that can be used to uniquely identify the resource that matches the search request.
  • kind (type: String.t, default: youtube#searchResult) - Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult".
  • snippet (type: GoogleApi.YouTube.V3.Model.SearchResultSnippet.t, default: nil) - The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.YouTube.V3.Model.SearchResult{
  etag: String.t() | nil,
  id: GoogleApi.YouTube.V3.Model.ResourceId.t() | nil,
  kind: String.t() | nil,
  snippet: GoogleApi.YouTube.V3.Model.SearchResultSnippet.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.