################################################################### _post_json(endpoint, data, client_config?)

Internal function that does the actual request to youtube servers and handles errors.

The requested data is an endpoint (URL without the domain part) and the data as a Hash object.

################################################################### browse(continuation, client_config?) browse(browse_id, params, client_config?)

Requests the youtubei/v1/browse endpoint with the required headers and POST data in order to get a JSON reply in english that can be easily parsed.

Both forms can take an optional ClientConfig parameter (see struct ClientConfig above for more details).

The requested data can either be:

• A continuation token (ctoken). Depending on this token's contents, the returned data can be playlist videos, channel community tab content, channel info, ...

• A playlist ID (parameters MUST be an empty string)

################################################################### browse(continuation, client_config?) browse(browse_id, params, client_config?)

Requests the youtubei/v1/browse endpoint with the required headers and POST data in order to get a JSON reply in english that can be easily parsed.

Both forms can take an optional ClientConfig parameter (see struct ClientConfig above for more details).

The requested data can either be:

• A continuation token (ctoken). Depending on this token's contents, the returned data can be playlist videos, channel community tab content, channel info, ...

• A playlist ID (parameters MUST be an empty string)

################################################################### next(continuation, client_config?) next(data, client_config?)

Requests the youtubei/v1/next endpoint with the required headers and POST data in order to get a JSON reply in english that can be easily parsed.

Both forms can take an optional ClientConfig parameter (see struct ClientConfig above for more details).

The requested data can be:

• A continuation token (ctoken). Depending on this token's contents, the returned data can be videos comments, their replies, ... In this case, the string must be passed directly to the function. E.g:

  YoutubeAPI::next("ABCDEFGH_abcdefgh==")

• Arbitrary parameters, in Hash form. See examples below for known examples of arbitrary data that can be passed to YouTube:

  # Get the videos related to a specific video ID
  YoutubeAPI::next({"videoId" => "dQw4w9WgXcQ"})
  
  # Get a playlist video's details
  YoutubeAPI::next({
    "videoId"    => "9bZkp7q19f0",
    "playlistId" => "PL_oFlvgqkrjUVQwiiE3F3k3voF4tjXeP0",
  })

################################################################### next(continuation, client_config?) next(data, client_config?)

Requests the youtubei/v1/next endpoint with the required headers and POST data in order to get a JSON reply in english that can be easily parsed.

Both forms can take an optional ClientConfig parameter (see struct ClientConfig above for more details).

The requested data can be:

• A continuation token (ctoken). Depending on this token's contents, the returned data can be videos comments, their replies, ... In this case, the string must be passed directly to the function. E.g:

  YoutubeAPI::next("ABCDEFGH_abcdefgh==")

• Arbitrary parameters, in Hash form. See examples below for known examples of arbitrary data that can be passed to YouTube:

  # Get the videos related to a specific video ID
  YoutubeAPI::next({"videoId" => "dQw4w9WgXcQ"})
  
  # Get a playlist video's details
  YoutubeAPI::next({
    "videoId"    => "9bZkp7q19f0",
    "playlistId" => "PL_oFlvgqkrjUVQwiiE3F3k3voF4tjXeP0",
  })

Allow a NamedTuple to be passed, too.

################################################################### player(video_id, params, client_config?)

Requests the youtubei/v1/player endpoint with the required headers and POST data in order to get a JSON reply.

The requested data is a video ID (v= parameter), with some additional paramters, formatted as a base64 string.

An optional ClientConfig parameter can be passed, too (see struct ClientConfig above for more details).

################################################################### resolve_url(url, client_config?)

Requests the youtubei/v1/navigation/resolve_url endpoint with the required headers and POST data in order to get a JSON reply.

An optional ClientConfig parameter can be passed, too (see struct ClientConfig above for more details).

Output:

# Valid channel "brand URL" gives the related UCID and browse ID
channel_a = YoutubeAPI.resolve_url("https://youtube.com/c/google")
channel_a # => {
  "endpoint": {
    "browseEndpoint": {
      "params": "EgC4AQA%3D",
      "browseId":"UCK8sQmJBp8GCxrOtXWBpyEA"
    },
    ...
  }
}

# Invalid URL returns throws an InfoException
channel_b = YoutubeAPI.resolve_url("https://youtube.com/c/invalid")

################################################################### search(search_query, params, client_config?)

Requests the youtubei/v1/search endpoint with the required headers and POST data in order to get a JSON reply. As the search results vary depending on the region, a region code can be specified in order to get non-US results.

The requested data is a search string, with some additional paramters, formatted as a base64 string.

An optional ClientConfig parameter can be passed, too (see struct ClientConfig above for more details).