scrapebadger 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +548 -0
- data/Rakefile +10 -0
- data/docs/AccountApi.md +76 -0
- data/docs/AccountInfo.md +28 -0
- data/docs/AmazonApi.md +1244 -0
- data/docs/ApartmentsApi.md +373 -0
- data/docs/BaiduApi.md +447 -0
- data/docs/BillingLogListResponse.md +24 -0
- data/docs/BillingLogResponse.md +32 -0
- data/docs/BingApi.md +610 -0
- data/docs/ChatGPTApi.md +521 -0
- data/docs/DepopApi.md +542 -0
- data/docs/DuckDuckGoApi.md +700 -0
- data/docs/EBayApi.md +1019 -0
- data/docs/FacebookApi.md +1671 -0
- data/docs/FilterRuleCreate.md +28 -0
- data/docs/FilterRuleDeliveryLogListResponse.md +24 -0
- data/docs/FilterRuleDeliveryLogResponse.md +44 -0
- data/docs/FilterRuleListResponse.md +24 -0
- data/docs/FilterRuleResponse.md +40 -0
- data/docs/FilterRuleUpdate.md +30 -0
- data/docs/FilterRuleValidateRequest.md +18 -0
- data/docs/FilterRuleValidateResponse.md +22 -0
- data/docs/GoogleApi.md +3175 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/IdealistaApi.md +822 -0
- data/docs/ImmobiliareApi.md +773 -0
- data/docs/InstagramApi.md +1673 -0
- data/docs/LeboncoinApi.md +884 -0
- data/docs/LinkedInApi.md +925 -0
- data/docs/LoopNetApi.md +529 -0
- data/docs/PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse.md +20 -0
- data/docs/RealtorApi.md +474 -0
- data/docs/RedditApi.md +1677 -0
- data/docs/RedfinApi.md +616 -0
- data/docs/StreamMonitorCreate.md +26 -0
- data/docs/StreamMonitorListResponse.md +24 -0
- data/docs/StreamMonitorResponse.md +42 -0
- data/docs/StreamMonitorUpdate.md +28 -0
- data/docs/SubscriptionInfo.md +40 -0
- data/docs/TikTokApi.md +2104 -0
- data/docs/TweetDeliveryLogListResponse.md +24 -0
- data/docs/TweetDeliveryLogResponse.md +44 -0
- data/docs/TwitterApi.md +4091 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorLocInner.md +15 -0
- data/docs/VintedApi.md +766 -0
- data/docs/WalmartApi.md +904 -0
- data/docs/WebApi.md +634 -0
- data/docs/WebhookCreate.md +22 -0
- data/docs/WebhookListItem.md +28 -0
- data/docs/WebhookListResponse.md +20 -0
- data/docs/WebhookResponse.md +26 -0
- data/docs/WebhookTestRequest.md +18 -0
- data/docs/WebhookTestResponse.md +24 -0
- data/docs/YahooApi.md +602 -0
- data/docs/YandexApi.md +450 -0
- data/docs/YouTubeApi.md +2872 -0
- data/docs/ZillowApi.md +622 -0
- data/git_push.sh +57 -0
- data/lib/scrapebadger/api/account_api.rb +79 -0
- data/lib/scrapebadger/api/amazon_api.rb +1165 -0
- data/lib/scrapebadger/api/apartments_api.rb +377 -0
- data/lib/scrapebadger/api/baidu_api.rb +436 -0
- data/lib/scrapebadger/api/bing_api.rb +580 -0
- data/lib/scrapebadger/api/chat_gpt_api.rb +466 -0
- data/lib/scrapebadger/api/depop_api.rb +518 -0
- data/lib/scrapebadger/api/duck_duck_go_api.rb +675 -0
- data/lib/scrapebadger/api/e_bay_api.rb +1029 -0
- data/lib/scrapebadger/api/facebook_api.rb +1492 -0
- data/lib/scrapebadger/api/google_api.rb +3191 -0
- data/lib/scrapebadger/api/idealista_api.rb +864 -0
- data/lib/scrapebadger/api/immobiliare_api.rb +734 -0
- data/lib/scrapebadger/api/instagram_api.rb +1555 -0
- data/lib/scrapebadger/api/leboncoin_api.rb +818 -0
- data/lib/scrapebadger/api/linked_in_api.rb +832 -0
- data/lib/scrapebadger/api/loop_net_api.rb +503 -0
- data/lib/scrapebadger/api/realtor_api.rb +481 -0
- data/lib/scrapebadger/api/reddit_api.rb +1601 -0
- data/lib/scrapebadger/api/redfin_api.rb +625 -0
- data/lib/scrapebadger/api/tik_tok_api.rb +2029 -0
- data/lib/scrapebadger/api/twitter_api.rb +3696 -0
- data/lib/scrapebadger/api/vinted_api.rb +705 -0
- data/lib/scrapebadger/api/walmart_api.rb +876 -0
- data/lib/scrapebadger/api/web_api.rb +547 -0
- data/lib/scrapebadger/api/yahoo_api.rb +560 -0
- data/lib/scrapebadger/api/yandex_api.rb +422 -0
- data/lib/scrapebadger/api/you_tube_api.rb +2520 -0
- data/lib/scrapebadger/api/zillow_api.rb +634 -0
- data/lib/scrapebadger/api_client.rb +394 -0
- data/lib/scrapebadger/api_error.rb +58 -0
- data/lib/scrapebadger/configuration.rb +308 -0
- data/lib/scrapebadger/models/account_info.rb +288 -0
- data/lib/scrapebadger/models/billing_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/billing_log_response.rb +334 -0
- data/lib/scrapebadger/models/filter_rule_create.rb +427 -0
- data/lib/scrapebadger/models/filter_rule_delivery_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/filter_rule_delivery_log_response.rb +422 -0
- data/lib/scrapebadger/models/filter_rule_list_response.rb +272 -0
- data/lib/scrapebadger/models/filter_rule_response.rb +390 -0
- data/lib/scrapebadger/models/filter_rule_update.rb +389 -0
- data/lib/scrapebadger/models/filter_rule_validate_request.rb +250 -0
- data/lib/scrapebadger/models/filter_rule_validate_response.rb +248 -0
- data/lib/scrapebadger/models/http_validation_error.rb +216 -0
- data/lib/scrapebadger/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response.rb +238 -0
- data/lib/scrapebadger/models/stream_monitor_create.rb +373 -0
- data/lib/scrapebadger/models/stream_monitor_list_response.rb +272 -0
- data/lib/scrapebadger/models/stream_monitor_response.rb +406 -0
- data/lib/scrapebadger/models/stream_monitor_update.rb +335 -0
- data/lib/scrapebadger/models/subscription_info.rb +352 -0
- data/lib/scrapebadger/models/tweet_delivery_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/tweet_delivery_log_response.rb +422 -0
- data/lib/scrapebadger/models/validation_error.rb +255 -0
- data/lib/scrapebadger/models/validation_error_loc_inner.rb +104 -0
- data/lib/scrapebadger/models/webhook_create.rb +282 -0
- data/lib/scrapebadger/models/webhook_list_item.rb +302 -0
- data/lib/scrapebadger/models/webhook_list_response.rb +240 -0
- data/lib/scrapebadger/models/webhook_response.rb +286 -0
- data/lib/scrapebadger/models/webhook_test_request.rb +223 -0
- data/lib/scrapebadger/models/webhook_test_response.rb +259 -0
- data/lib/scrapebadger/version.rb +15 -0
- data/lib/scrapebadger.rb +96 -0
- data/scrapebadger.gemspec +39 -0
- data/spec/api/account_api_spec.rb +46 -0
- data/spec/api/amazon_api_spec.rb +258 -0
- data/spec/api/apartments_api_spec.rb +98 -0
- data/spec/api/baidu_api_spec.rb +109 -0
- data/spec/api/bing_api_spec.rb +141 -0
- data/spec/api/chat_gpt_api_spec.rb +123 -0
- data/spec/api/depop_api_spec.rb +132 -0
- data/spec/api/duck_duck_go_api_spec.rb +162 -0
- data/spec/api/e_bay_api_spec.rb +222 -0
- data/spec/api/facebook_api_spec.rb +326 -0
- data/spec/api/google_api_spec.rb +649 -0
- data/spec/api/idealista_api_spec.rb +197 -0
- data/spec/api/immobiliare_api_spec.rb +174 -0
- data/spec/api/instagram_api_spec.rb +309 -0
- data/spec/api/leboncoin_api_spec.rb +184 -0
- data/spec/api/linked_in_api_spec.rb +197 -0
- data/spec/api/loop_net_api_spec.rb +127 -0
- data/spec/api/realtor_api_spec.rb +123 -0
- data/spec/api/reddit_api_spec.rb +331 -0
- data/spec/api/redfin_api_spec.rb +147 -0
- data/spec/api/tik_tok_api_spec.rb +413 -0
- data/spec/api/twitter_api_spec.rb +735 -0
- data/spec/api/vinted_api_spec.rb +169 -0
- data/spec/api/walmart_api_spec.rb +192 -0
- data/spec/api/web_api_spec.rb +136 -0
- data/spec/api/yahoo_api_spec.rb +137 -0
- data/spec/api/yandex_api_spec.rb +111 -0
- data/spec/api/you_tube_api_spec.rb +500 -0
- data/spec/api/zillow_api_spec.rb +150 -0
- data/spec/models/account_info_spec.rb +66 -0
- data/spec/models/billing_log_list_response_spec.rb +54 -0
- data/spec/models/billing_log_response_spec.rb +78 -0
- data/spec/models/filter_rule_create_spec.rb +66 -0
- data/spec/models/filter_rule_delivery_log_list_response_spec.rb +54 -0
- data/spec/models/filter_rule_delivery_log_response_spec.rb +114 -0
- data/spec/models/filter_rule_list_response_spec.rb +54 -0
- data/spec/models/filter_rule_response_spec.rb +102 -0
- data/spec/models/filter_rule_update_spec.rb +72 -0
- data/spec/models/filter_rule_validate_request_spec.rb +36 -0
- data/spec/models/filter_rule_validate_response_spec.rb +48 -0
- data/spec/models/http_validation_error_spec.rb +36 -0
- data/spec/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response_spec.rb +42 -0
- data/spec/models/stream_monitor_create_spec.rb +60 -0
- data/spec/models/stream_monitor_list_response_spec.rb +54 -0
- data/spec/models/stream_monitor_response_spec.rb +108 -0
- data/spec/models/stream_monitor_update_spec.rb +66 -0
- data/spec/models/subscription_info_spec.rb +102 -0
- data/spec/models/tweet_delivery_log_list_response_spec.rb +54 -0
- data/spec/models/tweet_delivery_log_response_spec.rb +114 -0
- data/spec/models/validation_error_loc_inner_spec.rb +21 -0
- data/spec/models/validation_error_spec.rb +48 -0
- data/spec/models/webhook_create_spec.rb +48 -0
- data/spec/models/webhook_list_item_spec.rb +66 -0
- data/spec/models/webhook_list_response_spec.rb +42 -0
- data/spec/models/webhook_response_spec.rb +60 -0
- data/spec/models/webhook_test_request_spec.rb +36 -0
- data/spec/models/webhook_test_response_spec.rb +54 -0
- data/spec/spec_helper.rb +111 -0
- metadata +324 -0
data/docs/YouTubeApi.md
ADDED
|
@@ -0,0 +1,2872 @@
|
|
|
1
|
+
# ScrapeBadger::YouTubeApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://scrapebadger.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**youtube_batch_video_detail**](YouTubeApi.md#youtube_batch_video_detail) | **POST** /v1/youtube/videos/batch | Batch video detail |
|
|
8
|
+
| [**youtube_channel_about**](YouTubeApi.md#youtube_channel_about) | **GET** /v1/youtube/channels/{channel_id}/about | Channel about |
|
|
9
|
+
| [**youtube_channel_playlists**](YouTubeApi.md#youtube_channel_playlists) | **GET** /v1/youtube/channels/{channel_id}/playlists | Channel playlists |
|
|
10
|
+
| [**youtube_channel_shorts**](YouTubeApi.md#youtube_channel_shorts) | **GET** /v1/youtube/channels/{channel_id}/shorts | Channel shorts |
|
|
11
|
+
| [**youtube_channel_streams**](YouTubeApi.md#youtube_channel_streams) | **GET** /v1/youtube/channels/{channel_id}/streams | Channel streams |
|
|
12
|
+
| [**youtube_channel_videos**](YouTubeApi.md#youtube_channel_videos) | **GET** /v1/youtube/channels/{channel_id}/videos | Channel videos |
|
|
13
|
+
| [**youtube_comment_replies**](YouTubeApi.md#youtube_comment_replies) | **GET** /v1/youtube/videos/{video_id}/comments/{comment_id}/replies | Comment replies |
|
|
14
|
+
| [**youtube_community_post_comments**](YouTubeApi.md#youtube_community_post_comments) | **GET** /v1/youtube/posts/{post_id}/comments | Community post comments |
|
|
15
|
+
| [**youtube_community_posts**](YouTubeApi.md#youtube_community_posts) | **GET** /v1/youtube/channels/{channel_id}/community | Community posts |
|
|
16
|
+
| [**youtube_content_regions**](YouTubeApi.md#youtube_content_regions) | **GET** /v1/youtube/regions | Content regions |
|
|
17
|
+
| [**youtube_get_a_community_post**](YouTubeApi.md#youtube_get_a_community_post) | **GET** /v1/youtube/posts/{post_id} | Get a community post |
|
|
18
|
+
| [**youtube_get_a_mix_radio_queue**](YouTubeApi.md#youtube_get_a_mix_radio_queue) | **GET** /v1/youtube/mixes/{playlist_id} | Get a mix / radio queue |
|
|
19
|
+
| [**youtube_get_a_short**](YouTubeApi.md#youtube_get_a_short) | **GET** /v1/youtube/shorts/{video_id} | Get a Short |
|
|
20
|
+
| [**youtube_get_channel_detail**](YouTubeApi.md#youtube_get_channel_detail) | **GET** /v1/youtube/channels/{channel_id} | Get channel detail |
|
|
21
|
+
| [**youtube_get_playlist_detail**](YouTubeApi.md#youtube_get_playlist_detail) | **GET** /v1/youtube/playlists/{playlist_id} | Get playlist detail |
|
|
22
|
+
| [**youtube_get_video_detail**](YouTubeApi.md#youtube_get_video_detail) | **GET** /v1/youtube/videos/{video_id} | Get video detail |
|
|
23
|
+
| [**youtube_guest_home_feed**](YouTubeApi.md#youtube_guest_home_feed) | **GET** /v1/youtube/home | Guest home feed |
|
|
24
|
+
| [**youtube_keyword_suggestions**](YouTubeApi.md#youtube_keyword_suggestions) | **GET** /v1/youtube/autocomplete | Keyword suggestions |
|
|
25
|
+
| [**youtube_list_caption_tracks**](YouTubeApi.md#youtube_list_caption_tracks) | **GET** /v1/youtube/videos/{video_id}/captions | List caption tracks |
|
|
26
|
+
| [**youtube_live_chat_messages**](YouTubeApi.md#youtube_live_chat_messages) | **GET** /v1/youtube/videos/{video_id}/live_chat | Live chat messages |
|
|
27
|
+
| [**youtube_oembed_metadata**](YouTubeApi.md#youtube_oembed_metadata) | **GET** /v1/youtube/oembed | oEmbed metadata |
|
|
28
|
+
| [**youtube_playlist_items_page**](YouTubeApi.md#youtube_playlist_items_page) | **GET** /v1/youtube/playlists/{playlist_id}/items | Playlist items page |
|
|
29
|
+
| [**youtube_related_videos**](YouTubeApi.md#youtube_related_videos) | **GET** /v1/youtube/videos/{video_id}/related | Related videos |
|
|
30
|
+
| [**youtube_resolve_handle_url_to_id**](YouTubeApi.md#youtube_resolve_handle_url_to_id) | **GET** /v1/youtube/channels/resolve | Resolve handle/URL to id |
|
|
31
|
+
| [**youtube_search_within_a_channel**](YouTubeApi.md#youtube_search_within_a_channel) | **GET** /v1/youtube/channels/{channel_id}/search | Search within a channel |
|
|
32
|
+
| [**youtube_search_youtube**](YouTubeApi.md#youtube_search_youtube) | **GET** /v1/youtube/search | Search YouTube |
|
|
33
|
+
| [**youtube_search_youtube_music**](YouTubeApi.md#youtube_search_youtube_music) | **GET** /v1/youtube/music/search | Search YouTube Music |
|
|
34
|
+
| [**youtube_shorts_by_sound**](YouTubeApi.md#youtube_shorts_by_sound) | **GET** /v1/youtube/shorts/by_sound/{sound_id} | Shorts by sound |
|
|
35
|
+
| [**youtube_stream_formats**](YouTubeApi.md#youtube_stream_formats) | **GET** /v1/youtube/videos/{video_id}/streams | Stream formats |
|
|
36
|
+
| [**youtube_subscriber_count_fast**](YouTubeApi.md#youtube_subscriber_count_fast) | **GET** /v1/youtube/channels/{channel_id}/subscriber_count | Subscriber count (fast) |
|
|
37
|
+
| [**youtube_supported_markets**](YouTubeApi.md#youtube_supported_markets) | **GET** /v1/youtube/markets | Supported markets |
|
|
38
|
+
| [**youtube_trending_shorts**](YouTubeApi.md#youtube_trending_shorts) | **GET** /v1/youtube/trending/shorts | Trending shorts |
|
|
39
|
+
| [**youtube_trending_videos**](YouTubeApi.md#youtube_trending_videos) | **GET** /v1/youtube/trending | Trending videos |
|
|
40
|
+
| [**youtube_ui_languages**](YouTubeApi.md#youtube_ui_languages) | **GET** /v1/youtube/languages | UI languages |
|
|
41
|
+
| [**youtube_video_categories**](YouTubeApi.md#youtube_video_categories) | **GET** /v1/youtube/categories | Video categories |
|
|
42
|
+
| [**youtube_video_comments**](YouTubeApi.md#youtube_video_comments) | **GET** /v1/youtube/videos/{video_id}/comments | Video comments |
|
|
43
|
+
| [**youtube_video_transcript**](YouTubeApi.md#youtube_video_transcript) | **GET** /v1/youtube/videos/{video_id}/transcript | Video transcript |
|
|
44
|
+
| [**youtube_videos_under_a_hashtag**](YouTubeApi.md#youtube_videos_under_a_hashtag) | **GET** /v1/youtube/hashtags/{tag} | Videos under a hashtag |
|
|
45
|
+
| [**youtube_youtube_scraper_health_check**](YouTubeApi.md#youtube_youtube_scraper_health_check) | **GET** /v1/youtube/health | YouTube scraper health check |
|
|
46
|
+
| [**youtube_youtube_scraper_health_check_head**](YouTubeApi.md#youtube_youtube_scraper_health_check_head) | **HEAD** /v1/youtube/health | YouTube scraper health check |
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## youtube_batch_video_detail
|
|
50
|
+
|
|
51
|
+
> Object youtube_batch_video_detail(request_body)
|
|
52
|
+
|
|
53
|
+
Batch video detail
|
|
54
|
+
|
|
55
|
+
### Examples
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
require 'time'
|
|
59
|
+
require 'scrapebadger'
|
|
60
|
+
# setup authorization
|
|
61
|
+
ScrapeBadger.configure do |config|
|
|
62
|
+
# Configure API key authorization: ApiKeyAuth
|
|
63
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
65
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
69
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
70
|
+
|
|
71
|
+
begin
|
|
72
|
+
# Batch video detail
|
|
73
|
+
result = api_instance.youtube_batch_video_detail(request_body)
|
|
74
|
+
p result
|
|
75
|
+
rescue ScrapeBadger::ApiError => e
|
|
76
|
+
puts "Error when calling YouTubeApi->youtube_batch_video_detail: #{e}"
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
#### Using the youtube_batch_video_detail_with_http_info variant
|
|
81
|
+
|
|
82
|
+
This returns an Array which contains the response data, status code and headers.
|
|
83
|
+
|
|
84
|
+
> <Array(Object, Integer, Hash)> youtube_batch_video_detail_with_http_info(request_body)
|
|
85
|
+
|
|
86
|
+
```ruby
|
|
87
|
+
begin
|
|
88
|
+
# Batch video detail
|
|
89
|
+
data, status_code, headers = api_instance.youtube_batch_video_detail_with_http_info(request_body)
|
|
90
|
+
p status_code # => 2xx
|
|
91
|
+
p headers # => { ... }
|
|
92
|
+
p data # => Object
|
|
93
|
+
rescue ScrapeBadger::ApiError => e
|
|
94
|
+
puts "Error when calling YouTubeApi->youtube_batch_video_detail_with_http_info: #{e}"
|
|
95
|
+
end
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Parameters
|
|
99
|
+
|
|
100
|
+
| Name | Type | Description | Notes |
|
|
101
|
+
| ---- | ---- | ----------- | ----- |
|
|
102
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
103
|
+
|
|
104
|
+
### Return type
|
|
105
|
+
|
|
106
|
+
**Object**
|
|
107
|
+
|
|
108
|
+
### Authorization
|
|
109
|
+
|
|
110
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
111
|
+
|
|
112
|
+
### HTTP request headers
|
|
113
|
+
|
|
114
|
+
- **Content-Type**: application/json
|
|
115
|
+
- **Accept**: application/json
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
## youtube_channel_about
|
|
119
|
+
|
|
120
|
+
> Object youtube_channel_about(channel_id)
|
|
121
|
+
|
|
122
|
+
Channel about
|
|
123
|
+
|
|
124
|
+
### Examples
|
|
125
|
+
|
|
126
|
+
```ruby
|
|
127
|
+
require 'time'
|
|
128
|
+
require 'scrapebadger'
|
|
129
|
+
# setup authorization
|
|
130
|
+
ScrapeBadger.configure do |config|
|
|
131
|
+
# Configure API key authorization: ApiKeyAuth
|
|
132
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
133
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
134
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
138
|
+
channel_id = 'channel_id_example' # String |
|
|
139
|
+
|
|
140
|
+
begin
|
|
141
|
+
# Channel about
|
|
142
|
+
result = api_instance.youtube_channel_about(channel_id)
|
|
143
|
+
p result
|
|
144
|
+
rescue ScrapeBadger::ApiError => e
|
|
145
|
+
puts "Error when calling YouTubeApi->youtube_channel_about: #{e}"
|
|
146
|
+
end
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
#### Using the youtube_channel_about_with_http_info variant
|
|
150
|
+
|
|
151
|
+
This returns an Array which contains the response data, status code and headers.
|
|
152
|
+
|
|
153
|
+
> <Array(Object, Integer, Hash)> youtube_channel_about_with_http_info(channel_id)
|
|
154
|
+
|
|
155
|
+
```ruby
|
|
156
|
+
begin
|
|
157
|
+
# Channel about
|
|
158
|
+
data, status_code, headers = api_instance.youtube_channel_about_with_http_info(channel_id)
|
|
159
|
+
p status_code # => 2xx
|
|
160
|
+
p headers # => { ... }
|
|
161
|
+
p data # => Object
|
|
162
|
+
rescue ScrapeBadger::ApiError => e
|
|
163
|
+
puts "Error when calling YouTubeApi->youtube_channel_about_with_http_info: #{e}"
|
|
164
|
+
end
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Parameters
|
|
168
|
+
|
|
169
|
+
| Name | Type | Description | Notes |
|
|
170
|
+
| ---- | ---- | ----------- | ----- |
|
|
171
|
+
| **channel_id** | **String** | | |
|
|
172
|
+
|
|
173
|
+
### Return type
|
|
174
|
+
|
|
175
|
+
**Object**
|
|
176
|
+
|
|
177
|
+
### Authorization
|
|
178
|
+
|
|
179
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
180
|
+
|
|
181
|
+
### HTTP request headers
|
|
182
|
+
|
|
183
|
+
- **Content-Type**: Not defined
|
|
184
|
+
- **Accept**: application/json
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
## youtube_channel_playlists
|
|
188
|
+
|
|
189
|
+
> Object youtube_channel_playlists(channel_id)
|
|
190
|
+
|
|
191
|
+
Channel playlists
|
|
192
|
+
|
|
193
|
+
### Examples
|
|
194
|
+
|
|
195
|
+
```ruby
|
|
196
|
+
require 'time'
|
|
197
|
+
require 'scrapebadger'
|
|
198
|
+
# setup authorization
|
|
199
|
+
ScrapeBadger.configure do |config|
|
|
200
|
+
# Configure API key authorization: ApiKeyAuth
|
|
201
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
202
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
203
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
204
|
+
end
|
|
205
|
+
|
|
206
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
207
|
+
channel_id = 'channel_id_example' # String |
|
|
208
|
+
|
|
209
|
+
begin
|
|
210
|
+
# Channel playlists
|
|
211
|
+
result = api_instance.youtube_channel_playlists(channel_id)
|
|
212
|
+
p result
|
|
213
|
+
rescue ScrapeBadger::ApiError => e
|
|
214
|
+
puts "Error when calling YouTubeApi->youtube_channel_playlists: #{e}"
|
|
215
|
+
end
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
#### Using the youtube_channel_playlists_with_http_info variant
|
|
219
|
+
|
|
220
|
+
This returns an Array which contains the response data, status code and headers.
|
|
221
|
+
|
|
222
|
+
> <Array(Object, Integer, Hash)> youtube_channel_playlists_with_http_info(channel_id)
|
|
223
|
+
|
|
224
|
+
```ruby
|
|
225
|
+
begin
|
|
226
|
+
# Channel playlists
|
|
227
|
+
data, status_code, headers = api_instance.youtube_channel_playlists_with_http_info(channel_id)
|
|
228
|
+
p status_code # => 2xx
|
|
229
|
+
p headers # => { ... }
|
|
230
|
+
p data # => Object
|
|
231
|
+
rescue ScrapeBadger::ApiError => e
|
|
232
|
+
puts "Error when calling YouTubeApi->youtube_channel_playlists_with_http_info: #{e}"
|
|
233
|
+
end
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Parameters
|
|
237
|
+
|
|
238
|
+
| Name | Type | Description | Notes |
|
|
239
|
+
| ---- | ---- | ----------- | ----- |
|
|
240
|
+
| **channel_id** | **String** | | |
|
|
241
|
+
|
|
242
|
+
### Return type
|
|
243
|
+
|
|
244
|
+
**Object**
|
|
245
|
+
|
|
246
|
+
### Authorization
|
|
247
|
+
|
|
248
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
249
|
+
|
|
250
|
+
### HTTP request headers
|
|
251
|
+
|
|
252
|
+
- **Content-Type**: Not defined
|
|
253
|
+
- **Accept**: application/json
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
## youtube_channel_shorts
|
|
257
|
+
|
|
258
|
+
> Object youtube_channel_shorts(channel_id)
|
|
259
|
+
|
|
260
|
+
Channel shorts
|
|
261
|
+
|
|
262
|
+
### Examples
|
|
263
|
+
|
|
264
|
+
```ruby
|
|
265
|
+
require 'time'
|
|
266
|
+
require 'scrapebadger'
|
|
267
|
+
# setup authorization
|
|
268
|
+
ScrapeBadger.configure do |config|
|
|
269
|
+
# Configure API key authorization: ApiKeyAuth
|
|
270
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
271
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
272
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
276
|
+
channel_id = 'channel_id_example' # String |
|
|
277
|
+
|
|
278
|
+
begin
|
|
279
|
+
# Channel shorts
|
|
280
|
+
result = api_instance.youtube_channel_shorts(channel_id)
|
|
281
|
+
p result
|
|
282
|
+
rescue ScrapeBadger::ApiError => e
|
|
283
|
+
puts "Error when calling YouTubeApi->youtube_channel_shorts: #{e}"
|
|
284
|
+
end
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
#### Using the youtube_channel_shorts_with_http_info variant
|
|
288
|
+
|
|
289
|
+
This returns an Array which contains the response data, status code and headers.
|
|
290
|
+
|
|
291
|
+
> <Array(Object, Integer, Hash)> youtube_channel_shorts_with_http_info(channel_id)
|
|
292
|
+
|
|
293
|
+
```ruby
|
|
294
|
+
begin
|
|
295
|
+
# Channel shorts
|
|
296
|
+
data, status_code, headers = api_instance.youtube_channel_shorts_with_http_info(channel_id)
|
|
297
|
+
p status_code # => 2xx
|
|
298
|
+
p headers # => { ... }
|
|
299
|
+
p data # => Object
|
|
300
|
+
rescue ScrapeBadger::ApiError => e
|
|
301
|
+
puts "Error when calling YouTubeApi->youtube_channel_shorts_with_http_info: #{e}"
|
|
302
|
+
end
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### Parameters
|
|
306
|
+
|
|
307
|
+
| Name | Type | Description | Notes |
|
|
308
|
+
| ---- | ---- | ----------- | ----- |
|
|
309
|
+
| **channel_id** | **String** | | |
|
|
310
|
+
|
|
311
|
+
### Return type
|
|
312
|
+
|
|
313
|
+
**Object**
|
|
314
|
+
|
|
315
|
+
### Authorization
|
|
316
|
+
|
|
317
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
318
|
+
|
|
319
|
+
### HTTP request headers
|
|
320
|
+
|
|
321
|
+
- **Content-Type**: Not defined
|
|
322
|
+
- **Accept**: application/json
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
## youtube_channel_streams
|
|
326
|
+
|
|
327
|
+
> Object youtube_channel_streams(channel_id)
|
|
328
|
+
|
|
329
|
+
Channel streams
|
|
330
|
+
|
|
331
|
+
### Examples
|
|
332
|
+
|
|
333
|
+
```ruby
|
|
334
|
+
require 'time'
|
|
335
|
+
require 'scrapebadger'
|
|
336
|
+
# setup authorization
|
|
337
|
+
ScrapeBadger.configure do |config|
|
|
338
|
+
# Configure API key authorization: ApiKeyAuth
|
|
339
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
340
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
341
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
345
|
+
channel_id = 'channel_id_example' # String |
|
|
346
|
+
|
|
347
|
+
begin
|
|
348
|
+
# Channel streams
|
|
349
|
+
result = api_instance.youtube_channel_streams(channel_id)
|
|
350
|
+
p result
|
|
351
|
+
rescue ScrapeBadger::ApiError => e
|
|
352
|
+
puts "Error when calling YouTubeApi->youtube_channel_streams: #{e}"
|
|
353
|
+
end
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
#### Using the youtube_channel_streams_with_http_info variant
|
|
357
|
+
|
|
358
|
+
This returns an Array which contains the response data, status code and headers.
|
|
359
|
+
|
|
360
|
+
> <Array(Object, Integer, Hash)> youtube_channel_streams_with_http_info(channel_id)
|
|
361
|
+
|
|
362
|
+
```ruby
|
|
363
|
+
begin
|
|
364
|
+
# Channel streams
|
|
365
|
+
data, status_code, headers = api_instance.youtube_channel_streams_with_http_info(channel_id)
|
|
366
|
+
p status_code # => 2xx
|
|
367
|
+
p headers # => { ... }
|
|
368
|
+
p data # => Object
|
|
369
|
+
rescue ScrapeBadger::ApiError => e
|
|
370
|
+
puts "Error when calling YouTubeApi->youtube_channel_streams_with_http_info: #{e}"
|
|
371
|
+
end
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Parameters
|
|
375
|
+
|
|
376
|
+
| Name | Type | Description | Notes |
|
|
377
|
+
| ---- | ---- | ----------- | ----- |
|
|
378
|
+
| **channel_id** | **String** | | |
|
|
379
|
+
|
|
380
|
+
### Return type
|
|
381
|
+
|
|
382
|
+
**Object**
|
|
383
|
+
|
|
384
|
+
### Authorization
|
|
385
|
+
|
|
386
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
387
|
+
|
|
388
|
+
### HTTP request headers
|
|
389
|
+
|
|
390
|
+
- **Content-Type**: Not defined
|
|
391
|
+
- **Accept**: application/json
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
## youtube_channel_videos
|
|
395
|
+
|
|
396
|
+
> Object youtube_channel_videos(channel_id)
|
|
397
|
+
|
|
398
|
+
Channel videos
|
|
399
|
+
|
|
400
|
+
### Examples
|
|
401
|
+
|
|
402
|
+
```ruby
|
|
403
|
+
require 'time'
|
|
404
|
+
require 'scrapebadger'
|
|
405
|
+
# setup authorization
|
|
406
|
+
ScrapeBadger.configure do |config|
|
|
407
|
+
# Configure API key authorization: ApiKeyAuth
|
|
408
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
409
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
410
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
414
|
+
channel_id = 'channel_id_example' # String |
|
|
415
|
+
|
|
416
|
+
begin
|
|
417
|
+
# Channel videos
|
|
418
|
+
result = api_instance.youtube_channel_videos(channel_id)
|
|
419
|
+
p result
|
|
420
|
+
rescue ScrapeBadger::ApiError => e
|
|
421
|
+
puts "Error when calling YouTubeApi->youtube_channel_videos: #{e}"
|
|
422
|
+
end
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
#### Using the youtube_channel_videos_with_http_info variant
|
|
426
|
+
|
|
427
|
+
This returns an Array which contains the response data, status code and headers.
|
|
428
|
+
|
|
429
|
+
> <Array(Object, Integer, Hash)> youtube_channel_videos_with_http_info(channel_id)
|
|
430
|
+
|
|
431
|
+
```ruby
|
|
432
|
+
begin
|
|
433
|
+
# Channel videos
|
|
434
|
+
data, status_code, headers = api_instance.youtube_channel_videos_with_http_info(channel_id)
|
|
435
|
+
p status_code # => 2xx
|
|
436
|
+
p headers # => { ... }
|
|
437
|
+
p data # => Object
|
|
438
|
+
rescue ScrapeBadger::ApiError => e
|
|
439
|
+
puts "Error when calling YouTubeApi->youtube_channel_videos_with_http_info: #{e}"
|
|
440
|
+
end
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### Parameters
|
|
444
|
+
|
|
445
|
+
| Name | Type | Description | Notes |
|
|
446
|
+
| ---- | ---- | ----------- | ----- |
|
|
447
|
+
| **channel_id** | **String** | | |
|
|
448
|
+
|
|
449
|
+
### Return type
|
|
450
|
+
|
|
451
|
+
**Object**
|
|
452
|
+
|
|
453
|
+
### Authorization
|
|
454
|
+
|
|
455
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
456
|
+
|
|
457
|
+
### HTTP request headers
|
|
458
|
+
|
|
459
|
+
- **Content-Type**: Not defined
|
|
460
|
+
- **Accept**: application/json
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
## youtube_comment_replies
|
|
464
|
+
|
|
465
|
+
> Object youtube_comment_replies(video_id, comment_id, continuation)
|
|
466
|
+
|
|
467
|
+
Comment replies
|
|
468
|
+
|
|
469
|
+
### Examples
|
|
470
|
+
|
|
471
|
+
```ruby
|
|
472
|
+
require 'time'
|
|
473
|
+
require 'scrapebadger'
|
|
474
|
+
# setup authorization
|
|
475
|
+
ScrapeBadger.configure do |config|
|
|
476
|
+
# Configure API key authorization: ApiKeyAuth
|
|
477
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
478
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
479
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
480
|
+
end
|
|
481
|
+
|
|
482
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
483
|
+
video_id = 'video_id_example' # String |
|
|
484
|
+
comment_id = 'comment_id_example' # String |
|
|
485
|
+
continuation = 'continuation_example' # String | Replies continuation token
|
|
486
|
+
|
|
487
|
+
begin
|
|
488
|
+
# Comment replies
|
|
489
|
+
result = api_instance.youtube_comment_replies(video_id, comment_id, continuation)
|
|
490
|
+
p result
|
|
491
|
+
rescue ScrapeBadger::ApiError => e
|
|
492
|
+
puts "Error when calling YouTubeApi->youtube_comment_replies: #{e}"
|
|
493
|
+
end
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
#### Using the youtube_comment_replies_with_http_info variant
|
|
497
|
+
|
|
498
|
+
This returns an Array which contains the response data, status code and headers.
|
|
499
|
+
|
|
500
|
+
> <Array(Object, Integer, Hash)> youtube_comment_replies_with_http_info(video_id, comment_id, continuation)
|
|
501
|
+
|
|
502
|
+
```ruby
|
|
503
|
+
begin
|
|
504
|
+
# Comment replies
|
|
505
|
+
data, status_code, headers = api_instance.youtube_comment_replies_with_http_info(video_id, comment_id, continuation)
|
|
506
|
+
p status_code # => 2xx
|
|
507
|
+
p headers # => { ... }
|
|
508
|
+
p data # => Object
|
|
509
|
+
rescue ScrapeBadger::ApiError => e
|
|
510
|
+
puts "Error when calling YouTubeApi->youtube_comment_replies_with_http_info: #{e}"
|
|
511
|
+
end
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Parameters
|
|
515
|
+
|
|
516
|
+
| Name | Type | Description | Notes |
|
|
517
|
+
| ---- | ---- | ----------- | ----- |
|
|
518
|
+
| **video_id** | **String** | | |
|
|
519
|
+
| **comment_id** | **String** | | |
|
|
520
|
+
| **continuation** | **String** | Replies continuation token | |
|
|
521
|
+
|
|
522
|
+
### Return type
|
|
523
|
+
|
|
524
|
+
**Object**
|
|
525
|
+
|
|
526
|
+
### Authorization
|
|
527
|
+
|
|
528
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
529
|
+
|
|
530
|
+
### HTTP request headers
|
|
531
|
+
|
|
532
|
+
- **Content-Type**: Not defined
|
|
533
|
+
- **Accept**: application/json
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
## youtube_community_post_comments
|
|
537
|
+
|
|
538
|
+
> Object youtube_community_post_comments(post_id)
|
|
539
|
+
|
|
540
|
+
Community post comments
|
|
541
|
+
|
|
542
|
+
### Examples
|
|
543
|
+
|
|
544
|
+
```ruby
|
|
545
|
+
require 'time'
|
|
546
|
+
require 'scrapebadger'
|
|
547
|
+
# setup authorization
|
|
548
|
+
ScrapeBadger.configure do |config|
|
|
549
|
+
# Configure API key authorization: ApiKeyAuth
|
|
550
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
551
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
552
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
556
|
+
post_id = 'post_id_example' # String |
|
|
557
|
+
|
|
558
|
+
begin
|
|
559
|
+
# Community post comments
|
|
560
|
+
result = api_instance.youtube_community_post_comments(post_id)
|
|
561
|
+
p result
|
|
562
|
+
rescue ScrapeBadger::ApiError => e
|
|
563
|
+
puts "Error when calling YouTubeApi->youtube_community_post_comments: #{e}"
|
|
564
|
+
end
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
#### Using the youtube_community_post_comments_with_http_info variant
|
|
568
|
+
|
|
569
|
+
This returns an Array which contains the response data, status code and headers.
|
|
570
|
+
|
|
571
|
+
> <Array(Object, Integer, Hash)> youtube_community_post_comments_with_http_info(post_id)
|
|
572
|
+
|
|
573
|
+
```ruby
|
|
574
|
+
begin
|
|
575
|
+
# Community post comments
|
|
576
|
+
data, status_code, headers = api_instance.youtube_community_post_comments_with_http_info(post_id)
|
|
577
|
+
p status_code # => 2xx
|
|
578
|
+
p headers # => { ... }
|
|
579
|
+
p data # => Object
|
|
580
|
+
rescue ScrapeBadger::ApiError => e
|
|
581
|
+
puts "Error when calling YouTubeApi->youtube_community_post_comments_with_http_info: #{e}"
|
|
582
|
+
end
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
### Parameters
|
|
586
|
+
|
|
587
|
+
| Name | Type | Description | Notes |
|
|
588
|
+
| ---- | ---- | ----------- | ----- |
|
|
589
|
+
| **post_id** | **String** | | |
|
|
590
|
+
|
|
591
|
+
### Return type
|
|
592
|
+
|
|
593
|
+
**Object**
|
|
594
|
+
|
|
595
|
+
### Authorization
|
|
596
|
+
|
|
597
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
598
|
+
|
|
599
|
+
### HTTP request headers
|
|
600
|
+
|
|
601
|
+
- **Content-Type**: Not defined
|
|
602
|
+
- **Accept**: application/json
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
## youtube_community_posts
|
|
606
|
+
|
|
607
|
+
> Object youtube_community_posts(channel_id)
|
|
608
|
+
|
|
609
|
+
Community posts
|
|
610
|
+
|
|
611
|
+
### Examples
|
|
612
|
+
|
|
613
|
+
```ruby
|
|
614
|
+
require 'time'
|
|
615
|
+
require 'scrapebadger'
|
|
616
|
+
# setup authorization
|
|
617
|
+
ScrapeBadger.configure do |config|
|
|
618
|
+
# Configure API key authorization: ApiKeyAuth
|
|
619
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
620
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
621
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
625
|
+
channel_id = 'channel_id_example' # String |
|
|
626
|
+
|
|
627
|
+
begin
|
|
628
|
+
# Community posts
|
|
629
|
+
result = api_instance.youtube_community_posts(channel_id)
|
|
630
|
+
p result
|
|
631
|
+
rescue ScrapeBadger::ApiError => e
|
|
632
|
+
puts "Error when calling YouTubeApi->youtube_community_posts: #{e}"
|
|
633
|
+
end
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
#### Using the youtube_community_posts_with_http_info variant
|
|
637
|
+
|
|
638
|
+
This returns an Array which contains the response data, status code and headers.
|
|
639
|
+
|
|
640
|
+
> <Array(Object, Integer, Hash)> youtube_community_posts_with_http_info(channel_id)
|
|
641
|
+
|
|
642
|
+
```ruby
|
|
643
|
+
begin
|
|
644
|
+
# Community posts
|
|
645
|
+
data, status_code, headers = api_instance.youtube_community_posts_with_http_info(channel_id)
|
|
646
|
+
p status_code # => 2xx
|
|
647
|
+
p headers # => { ... }
|
|
648
|
+
p data # => Object
|
|
649
|
+
rescue ScrapeBadger::ApiError => e
|
|
650
|
+
puts "Error when calling YouTubeApi->youtube_community_posts_with_http_info: #{e}"
|
|
651
|
+
end
|
|
652
|
+
```
|
|
653
|
+
|
|
654
|
+
### Parameters
|
|
655
|
+
|
|
656
|
+
| Name | Type | Description | Notes |
|
|
657
|
+
| ---- | ---- | ----------- | ----- |
|
|
658
|
+
| **channel_id** | **String** | | |
|
|
659
|
+
|
|
660
|
+
### Return type
|
|
661
|
+
|
|
662
|
+
**Object**
|
|
663
|
+
|
|
664
|
+
### Authorization
|
|
665
|
+
|
|
666
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
667
|
+
|
|
668
|
+
### HTTP request headers
|
|
669
|
+
|
|
670
|
+
- **Content-Type**: Not defined
|
|
671
|
+
- **Accept**: application/json
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
## youtube_content_regions
|
|
675
|
+
|
|
676
|
+
> Object youtube_content_regions
|
|
677
|
+
|
|
678
|
+
Content regions
|
|
679
|
+
|
|
680
|
+
### Examples
|
|
681
|
+
|
|
682
|
+
```ruby
|
|
683
|
+
require 'time'
|
|
684
|
+
require 'scrapebadger'
|
|
685
|
+
# setup authorization
|
|
686
|
+
ScrapeBadger.configure do |config|
|
|
687
|
+
# Configure API key authorization: ApiKeyAuth
|
|
688
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
689
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
690
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
691
|
+
end
|
|
692
|
+
|
|
693
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
694
|
+
|
|
695
|
+
begin
|
|
696
|
+
# Content regions
|
|
697
|
+
result = api_instance.youtube_content_regions
|
|
698
|
+
p result
|
|
699
|
+
rescue ScrapeBadger::ApiError => e
|
|
700
|
+
puts "Error when calling YouTubeApi->youtube_content_regions: #{e}"
|
|
701
|
+
end
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
#### Using the youtube_content_regions_with_http_info variant
|
|
705
|
+
|
|
706
|
+
This returns an Array which contains the response data, status code and headers.
|
|
707
|
+
|
|
708
|
+
> <Array(Object, Integer, Hash)> youtube_content_regions_with_http_info
|
|
709
|
+
|
|
710
|
+
```ruby
|
|
711
|
+
begin
|
|
712
|
+
# Content regions
|
|
713
|
+
data, status_code, headers = api_instance.youtube_content_regions_with_http_info
|
|
714
|
+
p status_code # => 2xx
|
|
715
|
+
p headers # => { ... }
|
|
716
|
+
p data # => Object
|
|
717
|
+
rescue ScrapeBadger::ApiError => e
|
|
718
|
+
puts "Error when calling YouTubeApi->youtube_content_regions_with_http_info: #{e}"
|
|
719
|
+
end
|
|
720
|
+
```
|
|
721
|
+
|
|
722
|
+
### Parameters
|
|
723
|
+
|
|
724
|
+
This endpoint does not need any parameter.
|
|
725
|
+
|
|
726
|
+
### Return type
|
|
727
|
+
|
|
728
|
+
**Object**
|
|
729
|
+
|
|
730
|
+
### Authorization
|
|
731
|
+
|
|
732
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
733
|
+
|
|
734
|
+
### HTTP request headers
|
|
735
|
+
|
|
736
|
+
- **Content-Type**: Not defined
|
|
737
|
+
- **Accept**: application/json
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
## youtube_get_a_community_post
|
|
741
|
+
|
|
742
|
+
> Object youtube_get_a_community_post(post_id)
|
|
743
|
+
|
|
744
|
+
Get a community post
|
|
745
|
+
|
|
746
|
+
### Examples
|
|
747
|
+
|
|
748
|
+
```ruby
|
|
749
|
+
require 'time'
|
|
750
|
+
require 'scrapebadger'
|
|
751
|
+
# setup authorization
|
|
752
|
+
ScrapeBadger.configure do |config|
|
|
753
|
+
# Configure API key authorization: ApiKeyAuth
|
|
754
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
755
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
756
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
757
|
+
end
|
|
758
|
+
|
|
759
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
760
|
+
post_id = 'post_id_example' # String |
|
|
761
|
+
|
|
762
|
+
begin
|
|
763
|
+
# Get a community post
|
|
764
|
+
result = api_instance.youtube_get_a_community_post(post_id)
|
|
765
|
+
p result
|
|
766
|
+
rescue ScrapeBadger::ApiError => e
|
|
767
|
+
puts "Error when calling YouTubeApi->youtube_get_a_community_post: #{e}"
|
|
768
|
+
end
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
#### Using the youtube_get_a_community_post_with_http_info variant
|
|
772
|
+
|
|
773
|
+
This returns an Array which contains the response data, status code and headers.
|
|
774
|
+
|
|
775
|
+
> <Array(Object, Integer, Hash)> youtube_get_a_community_post_with_http_info(post_id)
|
|
776
|
+
|
|
777
|
+
```ruby
|
|
778
|
+
begin
|
|
779
|
+
# Get a community post
|
|
780
|
+
data, status_code, headers = api_instance.youtube_get_a_community_post_with_http_info(post_id)
|
|
781
|
+
p status_code # => 2xx
|
|
782
|
+
p headers # => { ... }
|
|
783
|
+
p data # => Object
|
|
784
|
+
rescue ScrapeBadger::ApiError => e
|
|
785
|
+
puts "Error when calling YouTubeApi->youtube_get_a_community_post_with_http_info: #{e}"
|
|
786
|
+
end
|
|
787
|
+
```
|
|
788
|
+
|
|
789
|
+
### Parameters
|
|
790
|
+
|
|
791
|
+
| Name | Type | Description | Notes |
|
|
792
|
+
| ---- | ---- | ----------- | ----- |
|
|
793
|
+
| **post_id** | **String** | | |
|
|
794
|
+
|
|
795
|
+
### Return type
|
|
796
|
+
|
|
797
|
+
**Object**
|
|
798
|
+
|
|
799
|
+
### Authorization
|
|
800
|
+
|
|
801
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
802
|
+
|
|
803
|
+
### HTTP request headers
|
|
804
|
+
|
|
805
|
+
- **Content-Type**: Not defined
|
|
806
|
+
- **Accept**: application/json
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
## youtube_get_a_mix_radio_queue
|
|
810
|
+
|
|
811
|
+
> Object youtube_get_a_mix_radio_queue(playlist_id)
|
|
812
|
+
|
|
813
|
+
Get a mix / radio queue
|
|
814
|
+
|
|
815
|
+
### Examples
|
|
816
|
+
|
|
817
|
+
```ruby
|
|
818
|
+
require 'time'
|
|
819
|
+
require 'scrapebadger'
|
|
820
|
+
# setup authorization
|
|
821
|
+
ScrapeBadger.configure do |config|
|
|
822
|
+
# Configure API key authorization: ApiKeyAuth
|
|
823
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
824
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
825
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
826
|
+
end
|
|
827
|
+
|
|
828
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
829
|
+
playlist_id = 'playlist_id_example' # String |
|
|
830
|
+
|
|
831
|
+
begin
|
|
832
|
+
# Get a mix / radio queue
|
|
833
|
+
result = api_instance.youtube_get_a_mix_radio_queue(playlist_id)
|
|
834
|
+
p result
|
|
835
|
+
rescue ScrapeBadger::ApiError => e
|
|
836
|
+
puts "Error when calling YouTubeApi->youtube_get_a_mix_radio_queue: #{e}"
|
|
837
|
+
end
|
|
838
|
+
```
|
|
839
|
+
|
|
840
|
+
#### Using the youtube_get_a_mix_radio_queue_with_http_info variant
|
|
841
|
+
|
|
842
|
+
This returns an Array which contains the response data, status code and headers.
|
|
843
|
+
|
|
844
|
+
> <Array(Object, Integer, Hash)> youtube_get_a_mix_radio_queue_with_http_info(playlist_id)
|
|
845
|
+
|
|
846
|
+
```ruby
|
|
847
|
+
begin
|
|
848
|
+
# Get a mix / radio queue
|
|
849
|
+
data, status_code, headers = api_instance.youtube_get_a_mix_radio_queue_with_http_info(playlist_id)
|
|
850
|
+
p status_code # => 2xx
|
|
851
|
+
p headers # => { ... }
|
|
852
|
+
p data # => Object
|
|
853
|
+
rescue ScrapeBadger::ApiError => e
|
|
854
|
+
puts "Error when calling YouTubeApi->youtube_get_a_mix_radio_queue_with_http_info: #{e}"
|
|
855
|
+
end
|
|
856
|
+
```
|
|
857
|
+
|
|
858
|
+
### Parameters
|
|
859
|
+
|
|
860
|
+
| Name | Type | Description | Notes |
|
|
861
|
+
| ---- | ---- | ----------- | ----- |
|
|
862
|
+
| **playlist_id** | **String** | | |
|
|
863
|
+
|
|
864
|
+
### Return type
|
|
865
|
+
|
|
866
|
+
**Object**
|
|
867
|
+
|
|
868
|
+
### Authorization
|
|
869
|
+
|
|
870
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
871
|
+
|
|
872
|
+
### HTTP request headers
|
|
873
|
+
|
|
874
|
+
- **Content-Type**: Not defined
|
|
875
|
+
- **Accept**: application/json
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
## youtube_get_a_short
|
|
879
|
+
|
|
880
|
+
> Object youtube_get_a_short(video_id)
|
|
881
|
+
|
|
882
|
+
Get a Short
|
|
883
|
+
|
|
884
|
+
### Examples
|
|
885
|
+
|
|
886
|
+
```ruby
|
|
887
|
+
require 'time'
|
|
888
|
+
require 'scrapebadger'
|
|
889
|
+
# setup authorization
|
|
890
|
+
ScrapeBadger.configure do |config|
|
|
891
|
+
# Configure API key authorization: ApiKeyAuth
|
|
892
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
893
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
894
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
895
|
+
end
|
|
896
|
+
|
|
897
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
898
|
+
video_id = 'video_id_example' # String |
|
|
899
|
+
|
|
900
|
+
begin
|
|
901
|
+
# Get a Short
|
|
902
|
+
result = api_instance.youtube_get_a_short(video_id)
|
|
903
|
+
p result
|
|
904
|
+
rescue ScrapeBadger::ApiError => e
|
|
905
|
+
puts "Error when calling YouTubeApi->youtube_get_a_short: #{e}"
|
|
906
|
+
end
|
|
907
|
+
```
|
|
908
|
+
|
|
909
|
+
#### Using the youtube_get_a_short_with_http_info variant
|
|
910
|
+
|
|
911
|
+
This returns an Array which contains the response data, status code and headers.
|
|
912
|
+
|
|
913
|
+
> <Array(Object, Integer, Hash)> youtube_get_a_short_with_http_info(video_id)
|
|
914
|
+
|
|
915
|
+
```ruby
|
|
916
|
+
begin
|
|
917
|
+
# Get a Short
|
|
918
|
+
data, status_code, headers = api_instance.youtube_get_a_short_with_http_info(video_id)
|
|
919
|
+
p status_code # => 2xx
|
|
920
|
+
p headers # => { ... }
|
|
921
|
+
p data # => Object
|
|
922
|
+
rescue ScrapeBadger::ApiError => e
|
|
923
|
+
puts "Error when calling YouTubeApi->youtube_get_a_short_with_http_info: #{e}"
|
|
924
|
+
end
|
|
925
|
+
```
|
|
926
|
+
|
|
927
|
+
### Parameters
|
|
928
|
+
|
|
929
|
+
| Name | Type | Description | Notes |
|
|
930
|
+
| ---- | ---- | ----------- | ----- |
|
|
931
|
+
| **video_id** | **String** | | |
|
|
932
|
+
|
|
933
|
+
### Return type
|
|
934
|
+
|
|
935
|
+
**Object**
|
|
936
|
+
|
|
937
|
+
### Authorization
|
|
938
|
+
|
|
939
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
940
|
+
|
|
941
|
+
### HTTP request headers
|
|
942
|
+
|
|
943
|
+
- **Content-Type**: Not defined
|
|
944
|
+
- **Accept**: application/json
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
## youtube_get_channel_detail
|
|
948
|
+
|
|
949
|
+
> Object youtube_get_channel_detail(channel_id, opts)
|
|
950
|
+
|
|
951
|
+
Get channel detail
|
|
952
|
+
|
|
953
|
+
Channel detail (accepts a UC id, @handle, or custom URL).
|
|
954
|
+
|
|
955
|
+
### Examples
|
|
956
|
+
|
|
957
|
+
```ruby
|
|
958
|
+
require 'time'
|
|
959
|
+
require 'scrapebadger'
|
|
960
|
+
# setup authorization
|
|
961
|
+
ScrapeBadger.configure do |config|
|
|
962
|
+
# Configure API key authorization: ApiKeyAuth
|
|
963
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
964
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
965
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
966
|
+
end
|
|
967
|
+
|
|
968
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
969
|
+
channel_id = 'channel_id_example' # String |
|
|
970
|
+
opts = {
|
|
971
|
+
gl: 'gl_example', # String |
|
|
972
|
+
hl: 'hl_example' # String |
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
begin
|
|
976
|
+
# Get channel detail
|
|
977
|
+
result = api_instance.youtube_get_channel_detail(channel_id, opts)
|
|
978
|
+
p result
|
|
979
|
+
rescue ScrapeBadger::ApiError => e
|
|
980
|
+
puts "Error when calling YouTubeApi->youtube_get_channel_detail: #{e}"
|
|
981
|
+
end
|
|
982
|
+
```
|
|
983
|
+
|
|
984
|
+
#### Using the youtube_get_channel_detail_with_http_info variant
|
|
985
|
+
|
|
986
|
+
This returns an Array which contains the response data, status code and headers.
|
|
987
|
+
|
|
988
|
+
> <Array(Object, Integer, Hash)> youtube_get_channel_detail_with_http_info(channel_id, opts)
|
|
989
|
+
|
|
990
|
+
```ruby
|
|
991
|
+
begin
|
|
992
|
+
# Get channel detail
|
|
993
|
+
data, status_code, headers = api_instance.youtube_get_channel_detail_with_http_info(channel_id, opts)
|
|
994
|
+
p status_code # => 2xx
|
|
995
|
+
p headers # => { ... }
|
|
996
|
+
p data # => Object
|
|
997
|
+
rescue ScrapeBadger::ApiError => e
|
|
998
|
+
puts "Error when calling YouTubeApi->youtube_get_channel_detail_with_http_info: #{e}"
|
|
999
|
+
end
|
|
1000
|
+
```
|
|
1001
|
+
|
|
1002
|
+
### Parameters
|
|
1003
|
+
|
|
1004
|
+
| Name | Type | Description | Notes |
|
|
1005
|
+
| ---- | ---- | ----------- | ----- |
|
|
1006
|
+
| **channel_id** | **String** | | |
|
|
1007
|
+
| **gl** | **String** | | [optional] |
|
|
1008
|
+
| **hl** | **String** | | [optional] |
|
|
1009
|
+
|
|
1010
|
+
### Return type
|
|
1011
|
+
|
|
1012
|
+
**Object**
|
|
1013
|
+
|
|
1014
|
+
### Authorization
|
|
1015
|
+
|
|
1016
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1017
|
+
|
|
1018
|
+
### HTTP request headers
|
|
1019
|
+
|
|
1020
|
+
- **Content-Type**: Not defined
|
|
1021
|
+
- **Accept**: application/json
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
## youtube_get_playlist_detail
|
|
1025
|
+
|
|
1026
|
+
> Object youtube_get_playlist_detail(playlist_id)
|
|
1027
|
+
|
|
1028
|
+
Get playlist detail
|
|
1029
|
+
|
|
1030
|
+
### Examples
|
|
1031
|
+
|
|
1032
|
+
```ruby
|
|
1033
|
+
require 'time'
|
|
1034
|
+
require 'scrapebadger'
|
|
1035
|
+
# setup authorization
|
|
1036
|
+
ScrapeBadger.configure do |config|
|
|
1037
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1038
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1039
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1040
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1041
|
+
end
|
|
1042
|
+
|
|
1043
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1044
|
+
playlist_id = 'playlist_id_example' # String |
|
|
1045
|
+
|
|
1046
|
+
begin
|
|
1047
|
+
# Get playlist detail
|
|
1048
|
+
result = api_instance.youtube_get_playlist_detail(playlist_id)
|
|
1049
|
+
p result
|
|
1050
|
+
rescue ScrapeBadger::ApiError => e
|
|
1051
|
+
puts "Error when calling YouTubeApi->youtube_get_playlist_detail: #{e}"
|
|
1052
|
+
end
|
|
1053
|
+
```
|
|
1054
|
+
|
|
1055
|
+
#### Using the youtube_get_playlist_detail_with_http_info variant
|
|
1056
|
+
|
|
1057
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1058
|
+
|
|
1059
|
+
> <Array(Object, Integer, Hash)> youtube_get_playlist_detail_with_http_info(playlist_id)
|
|
1060
|
+
|
|
1061
|
+
```ruby
|
|
1062
|
+
begin
|
|
1063
|
+
# Get playlist detail
|
|
1064
|
+
data, status_code, headers = api_instance.youtube_get_playlist_detail_with_http_info(playlist_id)
|
|
1065
|
+
p status_code # => 2xx
|
|
1066
|
+
p headers # => { ... }
|
|
1067
|
+
p data # => Object
|
|
1068
|
+
rescue ScrapeBadger::ApiError => e
|
|
1069
|
+
puts "Error when calling YouTubeApi->youtube_get_playlist_detail_with_http_info: #{e}"
|
|
1070
|
+
end
|
|
1071
|
+
```
|
|
1072
|
+
|
|
1073
|
+
### Parameters
|
|
1074
|
+
|
|
1075
|
+
| Name | Type | Description | Notes |
|
|
1076
|
+
| ---- | ---- | ----------- | ----- |
|
|
1077
|
+
| **playlist_id** | **String** | | |
|
|
1078
|
+
|
|
1079
|
+
### Return type
|
|
1080
|
+
|
|
1081
|
+
**Object**
|
|
1082
|
+
|
|
1083
|
+
### Authorization
|
|
1084
|
+
|
|
1085
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1086
|
+
|
|
1087
|
+
### HTTP request headers
|
|
1088
|
+
|
|
1089
|
+
- **Content-Type**: Not defined
|
|
1090
|
+
- **Accept**: application/json
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
## youtube_get_video_detail
|
|
1094
|
+
|
|
1095
|
+
> Object youtube_get_video_detail(video_id, opts)
|
|
1096
|
+
|
|
1097
|
+
Get video detail
|
|
1098
|
+
|
|
1099
|
+
Full video detail — merged player + next (likes, comments, chapters, related).
|
|
1100
|
+
|
|
1101
|
+
### Examples
|
|
1102
|
+
|
|
1103
|
+
```ruby
|
|
1104
|
+
require 'time'
|
|
1105
|
+
require 'scrapebadger'
|
|
1106
|
+
# setup authorization
|
|
1107
|
+
ScrapeBadger.configure do |config|
|
|
1108
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1109
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1110
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1111
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1112
|
+
end
|
|
1113
|
+
|
|
1114
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1115
|
+
video_id = 'video_id_example' # String |
|
|
1116
|
+
opts = {
|
|
1117
|
+
gl: 'gl_example', # String |
|
|
1118
|
+
hl: 'hl_example' # String |
|
|
1119
|
+
}
|
|
1120
|
+
|
|
1121
|
+
begin
|
|
1122
|
+
# Get video detail
|
|
1123
|
+
result = api_instance.youtube_get_video_detail(video_id, opts)
|
|
1124
|
+
p result
|
|
1125
|
+
rescue ScrapeBadger::ApiError => e
|
|
1126
|
+
puts "Error when calling YouTubeApi->youtube_get_video_detail: #{e}"
|
|
1127
|
+
end
|
|
1128
|
+
```
|
|
1129
|
+
|
|
1130
|
+
#### Using the youtube_get_video_detail_with_http_info variant
|
|
1131
|
+
|
|
1132
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1133
|
+
|
|
1134
|
+
> <Array(Object, Integer, Hash)> youtube_get_video_detail_with_http_info(video_id, opts)
|
|
1135
|
+
|
|
1136
|
+
```ruby
|
|
1137
|
+
begin
|
|
1138
|
+
# Get video detail
|
|
1139
|
+
data, status_code, headers = api_instance.youtube_get_video_detail_with_http_info(video_id, opts)
|
|
1140
|
+
p status_code # => 2xx
|
|
1141
|
+
p headers # => { ... }
|
|
1142
|
+
p data # => Object
|
|
1143
|
+
rescue ScrapeBadger::ApiError => e
|
|
1144
|
+
puts "Error when calling YouTubeApi->youtube_get_video_detail_with_http_info: #{e}"
|
|
1145
|
+
end
|
|
1146
|
+
```
|
|
1147
|
+
|
|
1148
|
+
### Parameters
|
|
1149
|
+
|
|
1150
|
+
| Name | Type | Description | Notes |
|
|
1151
|
+
| ---- | ---- | ----------- | ----- |
|
|
1152
|
+
| **video_id** | **String** | | |
|
|
1153
|
+
| **gl** | **String** | | [optional] |
|
|
1154
|
+
| **hl** | **String** | | [optional] |
|
|
1155
|
+
|
|
1156
|
+
### Return type
|
|
1157
|
+
|
|
1158
|
+
**Object**
|
|
1159
|
+
|
|
1160
|
+
### Authorization
|
|
1161
|
+
|
|
1162
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1163
|
+
|
|
1164
|
+
### HTTP request headers
|
|
1165
|
+
|
|
1166
|
+
- **Content-Type**: Not defined
|
|
1167
|
+
- **Accept**: application/json
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
## youtube_guest_home_feed
|
|
1171
|
+
|
|
1172
|
+
> Object youtube_guest_home_feed
|
|
1173
|
+
|
|
1174
|
+
Guest home feed
|
|
1175
|
+
|
|
1176
|
+
### Examples
|
|
1177
|
+
|
|
1178
|
+
```ruby
|
|
1179
|
+
require 'time'
|
|
1180
|
+
require 'scrapebadger'
|
|
1181
|
+
# setup authorization
|
|
1182
|
+
ScrapeBadger.configure do |config|
|
|
1183
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1184
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1185
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1186
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1187
|
+
end
|
|
1188
|
+
|
|
1189
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1190
|
+
|
|
1191
|
+
begin
|
|
1192
|
+
# Guest home feed
|
|
1193
|
+
result = api_instance.youtube_guest_home_feed
|
|
1194
|
+
p result
|
|
1195
|
+
rescue ScrapeBadger::ApiError => e
|
|
1196
|
+
puts "Error when calling YouTubeApi->youtube_guest_home_feed: #{e}"
|
|
1197
|
+
end
|
|
1198
|
+
```
|
|
1199
|
+
|
|
1200
|
+
#### Using the youtube_guest_home_feed_with_http_info variant
|
|
1201
|
+
|
|
1202
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1203
|
+
|
|
1204
|
+
> <Array(Object, Integer, Hash)> youtube_guest_home_feed_with_http_info
|
|
1205
|
+
|
|
1206
|
+
```ruby
|
|
1207
|
+
begin
|
|
1208
|
+
# Guest home feed
|
|
1209
|
+
data, status_code, headers = api_instance.youtube_guest_home_feed_with_http_info
|
|
1210
|
+
p status_code # => 2xx
|
|
1211
|
+
p headers # => { ... }
|
|
1212
|
+
p data # => Object
|
|
1213
|
+
rescue ScrapeBadger::ApiError => e
|
|
1214
|
+
puts "Error when calling YouTubeApi->youtube_guest_home_feed_with_http_info: #{e}"
|
|
1215
|
+
end
|
|
1216
|
+
```
|
|
1217
|
+
|
|
1218
|
+
### Parameters
|
|
1219
|
+
|
|
1220
|
+
This endpoint does not need any parameter.
|
|
1221
|
+
|
|
1222
|
+
### Return type
|
|
1223
|
+
|
|
1224
|
+
**Object**
|
|
1225
|
+
|
|
1226
|
+
### Authorization
|
|
1227
|
+
|
|
1228
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1229
|
+
|
|
1230
|
+
### HTTP request headers
|
|
1231
|
+
|
|
1232
|
+
- **Content-Type**: Not defined
|
|
1233
|
+
- **Accept**: application/json
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
## youtube_keyword_suggestions
|
|
1237
|
+
|
|
1238
|
+
> Object youtube_keyword_suggestions(query, opts)
|
|
1239
|
+
|
|
1240
|
+
Keyword suggestions
|
|
1241
|
+
|
|
1242
|
+
Return YouTube keyword autocomplete suggestions.
|
|
1243
|
+
|
|
1244
|
+
### Examples
|
|
1245
|
+
|
|
1246
|
+
```ruby
|
|
1247
|
+
require 'time'
|
|
1248
|
+
require 'scrapebadger'
|
|
1249
|
+
# setup authorization
|
|
1250
|
+
ScrapeBadger.configure do |config|
|
|
1251
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1252
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1253
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1254
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1255
|
+
end
|
|
1256
|
+
|
|
1257
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1258
|
+
query = 'query_example' # String | Partial query prefix
|
|
1259
|
+
opts = {
|
|
1260
|
+
gl: 'gl_example', # String |
|
|
1261
|
+
hl: 'hl_example' # String |
|
|
1262
|
+
}
|
|
1263
|
+
|
|
1264
|
+
begin
|
|
1265
|
+
# Keyword suggestions
|
|
1266
|
+
result = api_instance.youtube_keyword_suggestions(query, opts)
|
|
1267
|
+
p result
|
|
1268
|
+
rescue ScrapeBadger::ApiError => e
|
|
1269
|
+
puts "Error when calling YouTubeApi->youtube_keyword_suggestions: #{e}"
|
|
1270
|
+
end
|
|
1271
|
+
```
|
|
1272
|
+
|
|
1273
|
+
#### Using the youtube_keyword_suggestions_with_http_info variant
|
|
1274
|
+
|
|
1275
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1276
|
+
|
|
1277
|
+
> <Array(Object, Integer, Hash)> youtube_keyword_suggestions_with_http_info(query, opts)
|
|
1278
|
+
|
|
1279
|
+
```ruby
|
|
1280
|
+
begin
|
|
1281
|
+
# Keyword suggestions
|
|
1282
|
+
data, status_code, headers = api_instance.youtube_keyword_suggestions_with_http_info(query, opts)
|
|
1283
|
+
p status_code # => 2xx
|
|
1284
|
+
p headers # => { ... }
|
|
1285
|
+
p data # => Object
|
|
1286
|
+
rescue ScrapeBadger::ApiError => e
|
|
1287
|
+
puts "Error when calling YouTubeApi->youtube_keyword_suggestions_with_http_info: #{e}"
|
|
1288
|
+
end
|
|
1289
|
+
```
|
|
1290
|
+
|
|
1291
|
+
### Parameters
|
|
1292
|
+
|
|
1293
|
+
| Name | Type | Description | Notes |
|
|
1294
|
+
| ---- | ---- | ----------- | ----- |
|
|
1295
|
+
| **query** | **String** | Partial query prefix | |
|
|
1296
|
+
| **gl** | **String** | | [optional] |
|
|
1297
|
+
| **hl** | **String** | | [optional] |
|
|
1298
|
+
|
|
1299
|
+
### Return type
|
|
1300
|
+
|
|
1301
|
+
**Object**
|
|
1302
|
+
|
|
1303
|
+
### Authorization
|
|
1304
|
+
|
|
1305
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1306
|
+
|
|
1307
|
+
### HTTP request headers
|
|
1308
|
+
|
|
1309
|
+
- **Content-Type**: Not defined
|
|
1310
|
+
- **Accept**: application/json
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
## youtube_list_caption_tracks
|
|
1314
|
+
|
|
1315
|
+
> Object youtube_list_caption_tracks(video_id)
|
|
1316
|
+
|
|
1317
|
+
List caption tracks
|
|
1318
|
+
|
|
1319
|
+
### Examples
|
|
1320
|
+
|
|
1321
|
+
```ruby
|
|
1322
|
+
require 'time'
|
|
1323
|
+
require 'scrapebadger'
|
|
1324
|
+
# setup authorization
|
|
1325
|
+
ScrapeBadger.configure do |config|
|
|
1326
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1327
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1328
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1329
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1330
|
+
end
|
|
1331
|
+
|
|
1332
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1333
|
+
video_id = 'video_id_example' # String |
|
|
1334
|
+
|
|
1335
|
+
begin
|
|
1336
|
+
# List caption tracks
|
|
1337
|
+
result = api_instance.youtube_list_caption_tracks(video_id)
|
|
1338
|
+
p result
|
|
1339
|
+
rescue ScrapeBadger::ApiError => e
|
|
1340
|
+
puts "Error when calling YouTubeApi->youtube_list_caption_tracks: #{e}"
|
|
1341
|
+
end
|
|
1342
|
+
```
|
|
1343
|
+
|
|
1344
|
+
#### Using the youtube_list_caption_tracks_with_http_info variant
|
|
1345
|
+
|
|
1346
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1347
|
+
|
|
1348
|
+
> <Array(Object, Integer, Hash)> youtube_list_caption_tracks_with_http_info(video_id)
|
|
1349
|
+
|
|
1350
|
+
```ruby
|
|
1351
|
+
begin
|
|
1352
|
+
# List caption tracks
|
|
1353
|
+
data, status_code, headers = api_instance.youtube_list_caption_tracks_with_http_info(video_id)
|
|
1354
|
+
p status_code # => 2xx
|
|
1355
|
+
p headers # => { ... }
|
|
1356
|
+
p data # => Object
|
|
1357
|
+
rescue ScrapeBadger::ApiError => e
|
|
1358
|
+
puts "Error when calling YouTubeApi->youtube_list_caption_tracks_with_http_info: #{e}"
|
|
1359
|
+
end
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
### Parameters
|
|
1363
|
+
|
|
1364
|
+
| Name | Type | Description | Notes |
|
|
1365
|
+
| ---- | ---- | ----------- | ----- |
|
|
1366
|
+
| **video_id** | **String** | | |
|
|
1367
|
+
|
|
1368
|
+
### Return type
|
|
1369
|
+
|
|
1370
|
+
**Object**
|
|
1371
|
+
|
|
1372
|
+
### Authorization
|
|
1373
|
+
|
|
1374
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1375
|
+
|
|
1376
|
+
### HTTP request headers
|
|
1377
|
+
|
|
1378
|
+
- **Content-Type**: Not defined
|
|
1379
|
+
- **Accept**: application/json
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
## youtube_live_chat_messages
|
|
1383
|
+
|
|
1384
|
+
> Object youtube_live_chat_messages(video_id, opts)
|
|
1385
|
+
|
|
1386
|
+
Live chat messages
|
|
1387
|
+
|
|
1388
|
+
### Examples
|
|
1389
|
+
|
|
1390
|
+
```ruby
|
|
1391
|
+
require 'time'
|
|
1392
|
+
require 'scrapebadger'
|
|
1393
|
+
# setup authorization
|
|
1394
|
+
ScrapeBadger.configure do |config|
|
|
1395
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1396
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1397
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1398
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1399
|
+
end
|
|
1400
|
+
|
|
1401
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1402
|
+
video_id = 'video_id_example' # String |
|
|
1403
|
+
opts = {
|
|
1404
|
+
continuation: 'continuation_example', # String |
|
|
1405
|
+
replay: true # Boolean |
|
|
1406
|
+
}
|
|
1407
|
+
|
|
1408
|
+
begin
|
|
1409
|
+
# Live chat messages
|
|
1410
|
+
result = api_instance.youtube_live_chat_messages(video_id, opts)
|
|
1411
|
+
p result
|
|
1412
|
+
rescue ScrapeBadger::ApiError => e
|
|
1413
|
+
puts "Error when calling YouTubeApi->youtube_live_chat_messages: #{e}"
|
|
1414
|
+
end
|
|
1415
|
+
```
|
|
1416
|
+
|
|
1417
|
+
#### Using the youtube_live_chat_messages_with_http_info variant
|
|
1418
|
+
|
|
1419
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1420
|
+
|
|
1421
|
+
> <Array(Object, Integer, Hash)> youtube_live_chat_messages_with_http_info(video_id, opts)
|
|
1422
|
+
|
|
1423
|
+
```ruby
|
|
1424
|
+
begin
|
|
1425
|
+
# Live chat messages
|
|
1426
|
+
data, status_code, headers = api_instance.youtube_live_chat_messages_with_http_info(video_id, opts)
|
|
1427
|
+
p status_code # => 2xx
|
|
1428
|
+
p headers # => { ... }
|
|
1429
|
+
p data # => Object
|
|
1430
|
+
rescue ScrapeBadger::ApiError => e
|
|
1431
|
+
puts "Error when calling YouTubeApi->youtube_live_chat_messages_with_http_info: #{e}"
|
|
1432
|
+
end
|
|
1433
|
+
```
|
|
1434
|
+
|
|
1435
|
+
### Parameters
|
|
1436
|
+
|
|
1437
|
+
| Name | Type | Description | Notes |
|
|
1438
|
+
| ---- | ---- | ----------- | ----- |
|
|
1439
|
+
| **video_id** | **String** | | |
|
|
1440
|
+
| **continuation** | **String** | | [optional] |
|
|
1441
|
+
| **replay** | **Boolean** | | [optional][default to false] |
|
|
1442
|
+
|
|
1443
|
+
### Return type
|
|
1444
|
+
|
|
1445
|
+
**Object**
|
|
1446
|
+
|
|
1447
|
+
### Authorization
|
|
1448
|
+
|
|
1449
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1450
|
+
|
|
1451
|
+
### HTTP request headers
|
|
1452
|
+
|
|
1453
|
+
- **Content-Type**: Not defined
|
|
1454
|
+
- **Accept**: application/json
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
## youtube_oembed_metadata
|
|
1458
|
+
|
|
1459
|
+
> Object youtube_oembed_metadata(url)
|
|
1460
|
+
|
|
1461
|
+
oEmbed metadata
|
|
1462
|
+
|
|
1463
|
+
### Examples
|
|
1464
|
+
|
|
1465
|
+
```ruby
|
|
1466
|
+
require 'time'
|
|
1467
|
+
require 'scrapebadger'
|
|
1468
|
+
# setup authorization
|
|
1469
|
+
ScrapeBadger.configure do |config|
|
|
1470
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1471
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1472
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1473
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1474
|
+
end
|
|
1475
|
+
|
|
1476
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1477
|
+
url = 'url_example' # String | A YouTube URL
|
|
1478
|
+
|
|
1479
|
+
begin
|
|
1480
|
+
# oEmbed metadata
|
|
1481
|
+
result = api_instance.youtube_oembed_metadata(url)
|
|
1482
|
+
p result
|
|
1483
|
+
rescue ScrapeBadger::ApiError => e
|
|
1484
|
+
puts "Error when calling YouTubeApi->youtube_oembed_metadata: #{e}"
|
|
1485
|
+
end
|
|
1486
|
+
```
|
|
1487
|
+
|
|
1488
|
+
#### Using the youtube_oembed_metadata_with_http_info variant
|
|
1489
|
+
|
|
1490
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1491
|
+
|
|
1492
|
+
> <Array(Object, Integer, Hash)> youtube_oembed_metadata_with_http_info(url)
|
|
1493
|
+
|
|
1494
|
+
```ruby
|
|
1495
|
+
begin
|
|
1496
|
+
# oEmbed metadata
|
|
1497
|
+
data, status_code, headers = api_instance.youtube_oembed_metadata_with_http_info(url)
|
|
1498
|
+
p status_code # => 2xx
|
|
1499
|
+
p headers # => { ... }
|
|
1500
|
+
p data # => Object
|
|
1501
|
+
rescue ScrapeBadger::ApiError => e
|
|
1502
|
+
puts "Error when calling YouTubeApi->youtube_oembed_metadata_with_http_info: #{e}"
|
|
1503
|
+
end
|
|
1504
|
+
```
|
|
1505
|
+
|
|
1506
|
+
### Parameters
|
|
1507
|
+
|
|
1508
|
+
| Name | Type | Description | Notes |
|
|
1509
|
+
| ---- | ---- | ----------- | ----- |
|
|
1510
|
+
| **url** | **String** | A YouTube URL | |
|
|
1511
|
+
|
|
1512
|
+
### Return type
|
|
1513
|
+
|
|
1514
|
+
**Object**
|
|
1515
|
+
|
|
1516
|
+
### Authorization
|
|
1517
|
+
|
|
1518
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1519
|
+
|
|
1520
|
+
### HTTP request headers
|
|
1521
|
+
|
|
1522
|
+
- **Content-Type**: Not defined
|
|
1523
|
+
- **Accept**: application/json
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
## youtube_playlist_items_page
|
|
1527
|
+
|
|
1528
|
+
> Object youtube_playlist_items_page(playlist_id)
|
|
1529
|
+
|
|
1530
|
+
Playlist items page
|
|
1531
|
+
|
|
1532
|
+
### Examples
|
|
1533
|
+
|
|
1534
|
+
```ruby
|
|
1535
|
+
require 'time'
|
|
1536
|
+
require 'scrapebadger'
|
|
1537
|
+
# setup authorization
|
|
1538
|
+
ScrapeBadger.configure do |config|
|
|
1539
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1540
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1541
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1542
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1543
|
+
end
|
|
1544
|
+
|
|
1545
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1546
|
+
playlist_id = 'playlist_id_example' # String |
|
|
1547
|
+
|
|
1548
|
+
begin
|
|
1549
|
+
# Playlist items page
|
|
1550
|
+
result = api_instance.youtube_playlist_items_page(playlist_id)
|
|
1551
|
+
p result
|
|
1552
|
+
rescue ScrapeBadger::ApiError => e
|
|
1553
|
+
puts "Error when calling YouTubeApi->youtube_playlist_items_page: #{e}"
|
|
1554
|
+
end
|
|
1555
|
+
```
|
|
1556
|
+
|
|
1557
|
+
#### Using the youtube_playlist_items_page_with_http_info variant
|
|
1558
|
+
|
|
1559
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1560
|
+
|
|
1561
|
+
> <Array(Object, Integer, Hash)> youtube_playlist_items_page_with_http_info(playlist_id)
|
|
1562
|
+
|
|
1563
|
+
```ruby
|
|
1564
|
+
begin
|
|
1565
|
+
# Playlist items page
|
|
1566
|
+
data, status_code, headers = api_instance.youtube_playlist_items_page_with_http_info(playlist_id)
|
|
1567
|
+
p status_code # => 2xx
|
|
1568
|
+
p headers # => { ... }
|
|
1569
|
+
p data # => Object
|
|
1570
|
+
rescue ScrapeBadger::ApiError => e
|
|
1571
|
+
puts "Error when calling YouTubeApi->youtube_playlist_items_page_with_http_info: #{e}"
|
|
1572
|
+
end
|
|
1573
|
+
```
|
|
1574
|
+
|
|
1575
|
+
### Parameters
|
|
1576
|
+
|
|
1577
|
+
| Name | Type | Description | Notes |
|
|
1578
|
+
| ---- | ---- | ----------- | ----- |
|
|
1579
|
+
| **playlist_id** | **String** | | |
|
|
1580
|
+
|
|
1581
|
+
### Return type
|
|
1582
|
+
|
|
1583
|
+
**Object**
|
|
1584
|
+
|
|
1585
|
+
### Authorization
|
|
1586
|
+
|
|
1587
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1588
|
+
|
|
1589
|
+
### HTTP request headers
|
|
1590
|
+
|
|
1591
|
+
- **Content-Type**: Not defined
|
|
1592
|
+
- **Accept**: application/json
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
## youtube_related_videos
|
|
1596
|
+
|
|
1597
|
+
> Object youtube_related_videos(video_id)
|
|
1598
|
+
|
|
1599
|
+
Related videos
|
|
1600
|
+
|
|
1601
|
+
### Examples
|
|
1602
|
+
|
|
1603
|
+
```ruby
|
|
1604
|
+
require 'time'
|
|
1605
|
+
require 'scrapebadger'
|
|
1606
|
+
# setup authorization
|
|
1607
|
+
ScrapeBadger.configure do |config|
|
|
1608
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1609
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1610
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1611
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1612
|
+
end
|
|
1613
|
+
|
|
1614
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1615
|
+
video_id = 'video_id_example' # String |
|
|
1616
|
+
|
|
1617
|
+
begin
|
|
1618
|
+
# Related videos
|
|
1619
|
+
result = api_instance.youtube_related_videos(video_id)
|
|
1620
|
+
p result
|
|
1621
|
+
rescue ScrapeBadger::ApiError => e
|
|
1622
|
+
puts "Error when calling YouTubeApi->youtube_related_videos: #{e}"
|
|
1623
|
+
end
|
|
1624
|
+
```
|
|
1625
|
+
|
|
1626
|
+
#### Using the youtube_related_videos_with_http_info variant
|
|
1627
|
+
|
|
1628
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1629
|
+
|
|
1630
|
+
> <Array(Object, Integer, Hash)> youtube_related_videos_with_http_info(video_id)
|
|
1631
|
+
|
|
1632
|
+
```ruby
|
|
1633
|
+
begin
|
|
1634
|
+
# Related videos
|
|
1635
|
+
data, status_code, headers = api_instance.youtube_related_videos_with_http_info(video_id)
|
|
1636
|
+
p status_code # => 2xx
|
|
1637
|
+
p headers # => { ... }
|
|
1638
|
+
p data # => Object
|
|
1639
|
+
rescue ScrapeBadger::ApiError => e
|
|
1640
|
+
puts "Error when calling YouTubeApi->youtube_related_videos_with_http_info: #{e}"
|
|
1641
|
+
end
|
|
1642
|
+
```
|
|
1643
|
+
|
|
1644
|
+
### Parameters
|
|
1645
|
+
|
|
1646
|
+
| Name | Type | Description | Notes |
|
|
1647
|
+
| ---- | ---- | ----------- | ----- |
|
|
1648
|
+
| **video_id** | **String** | | |
|
|
1649
|
+
|
|
1650
|
+
### Return type
|
|
1651
|
+
|
|
1652
|
+
**Object**
|
|
1653
|
+
|
|
1654
|
+
### Authorization
|
|
1655
|
+
|
|
1656
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1657
|
+
|
|
1658
|
+
### HTTP request headers
|
|
1659
|
+
|
|
1660
|
+
- **Content-Type**: Not defined
|
|
1661
|
+
- **Accept**: application/json
|
|
1662
|
+
|
|
1663
|
+
|
|
1664
|
+
## youtube_resolve_handle_url_to_id
|
|
1665
|
+
|
|
1666
|
+
> Object youtube_resolve_handle_url_to_id(opts)
|
|
1667
|
+
|
|
1668
|
+
Resolve handle/URL to id
|
|
1669
|
+
|
|
1670
|
+
### Examples
|
|
1671
|
+
|
|
1672
|
+
```ruby
|
|
1673
|
+
require 'time'
|
|
1674
|
+
require 'scrapebadger'
|
|
1675
|
+
# setup authorization
|
|
1676
|
+
ScrapeBadger.configure do |config|
|
|
1677
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1678
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1679
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1680
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1681
|
+
end
|
|
1682
|
+
|
|
1683
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1684
|
+
opts = {
|
|
1685
|
+
handle: 'handle_example', # String |
|
|
1686
|
+
url: 'url_example' # String |
|
|
1687
|
+
}
|
|
1688
|
+
|
|
1689
|
+
begin
|
|
1690
|
+
# Resolve handle/URL to id
|
|
1691
|
+
result = api_instance.youtube_resolve_handle_url_to_id(opts)
|
|
1692
|
+
p result
|
|
1693
|
+
rescue ScrapeBadger::ApiError => e
|
|
1694
|
+
puts "Error when calling YouTubeApi->youtube_resolve_handle_url_to_id: #{e}"
|
|
1695
|
+
end
|
|
1696
|
+
```
|
|
1697
|
+
|
|
1698
|
+
#### Using the youtube_resolve_handle_url_to_id_with_http_info variant
|
|
1699
|
+
|
|
1700
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1701
|
+
|
|
1702
|
+
> <Array(Object, Integer, Hash)> youtube_resolve_handle_url_to_id_with_http_info(opts)
|
|
1703
|
+
|
|
1704
|
+
```ruby
|
|
1705
|
+
begin
|
|
1706
|
+
# Resolve handle/URL to id
|
|
1707
|
+
data, status_code, headers = api_instance.youtube_resolve_handle_url_to_id_with_http_info(opts)
|
|
1708
|
+
p status_code # => 2xx
|
|
1709
|
+
p headers # => { ... }
|
|
1710
|
+
p data # => Object
|
|
1711
|
+
rescue ScrapeBadger::ApiError => e
|
|
1712
|
+
puts "Error when calling YouTubeApi->youtube_resolve_handle_url_to_id_with_http_info: #{e}"
|
|
1713
|
+
end
|
|
1714
|
+
```
|
|
1715
|
+
|
|
1716
|
+
### Parameters
|
|
1717
|
+
|
|
1718
|
+
| Name | Type | Description | Notes |
|
|
1719
|
+
| ---- | ---- | ----------- | ----- |
|
|
1720
|
+
| **handle** | **String** | | [optional] |
|
|
1721
|
+
| **url** | **String** | | [optional] |
|
|
1722
|
+
|
|
1723
|
+
### Return type
|
|
1724
|
+
|
|
1725
|
+
**Object**
|
|
1726
|
+
|
|
1727
|
+
### Authorization
|
|
1728
|
+
|
|
1729
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1730
|
+
|
|
1731
|
+
### HTTP request headers
|
|
1732
|
+
|
|
1733
|
+
- **Content-Type**: Not defined
|
|
1734
|
+
- **Accept**: application/json
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
## youtube_search_within_a_channel
|
|
1738
|
+
|
|
1739
|
+
> Object youtube_search_within_a_channel(channel_id, query)
|
|
1740
|
+
|
|
1741
|
+
Search within a channel
|
|
1742
|
+
|
|
1743
|
+
### Examples
|
|
1744
|
+
|
|
1745
|
+
```ruby
|
|
1746
|
+
require 'time'
|
|
1747
|
+
require 'scrapebadger'
|
|
1748
|
+
# setup authorization
|
|
1749
|
+
ScrapeBadger.configure do |config|
|
|
1750
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1751
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1752
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1753
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1754
|
+
end
|
|
1755
|
+
|
|
1756
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1757
|
+
channel_id = 'channel_id_example' # String |
|
|
1758
|
+
query = 'query_example' # String | Search keywords
|
|
1759
|
+
|
|
1760
|
+
begin
|
|
1761
|
+
# Search within a channel
|
|
1762
|
+
result = api_instance.youtube_search_within_a_channel(channel_id, query)
|
|
1763
|
+
p result
|
|
1764
|
+
rescue ScrapeBadger::ApiError => e
|
|
1765
|
+
puts "Error when calling YouTubeApi->youtube_search_within_a_channel: #{e}"
|
|
1766
|
+
end
|
|
1767
|
+
```
|
|
1768
|
+
|
|
1769
|
+
#### Using the youtube_search_within_a_channel_with_http_info variant
|
|
1770
|
+
|
|
1771
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1772
|
+
|
|
1773
|
+
> <Array(Object, Integer, Hash)> youtube_search_within_a_channel_with_http_info(channel_id, query)
|
|
1774
|
+
|
|
1775
|
+
```ruby
|
|
1776
|
+
begin
|
|
1777
|
+
# Search within a channel
|
|
1778
|
+
data, status_code, headers = api_instance.youtube_search_within_a_channel_with_http_info(channel_id, query)
|
|
1779
|
+
p status_code # => 2xx
|
|
1780
|
+
p headers # => { ... }
|
|
1781
|
+
p data # => Object
|
|
1782
|
+
rescue ScrapeBadger::ApiError => e
|
|
1783
|
+
puts "Error when calling YouTubeApi->youtube_search_within_a_channel_with_http_info: #{e}"
|
|
1784
|
+
end
|
|
1785
|
+
```
|
|
1786
|
+
|
|
1787
|
+
### Parameters
|
|
1788
|
+
|
|
1789
|
+
| Name | Type | Description | Notes |
|
|
1790
|
+
| ---- | ---- | ----------- | ----- |
|
|
1791
|
+
| **channel_id** | **String** | | |
|
|
1792
|
+
| **query** | **String** | Search keywords | |
|
|
1793
|
+
|
|
1794
|
+
### Return type
|
|
1795
|
+
|
|
1796
|
+
**Object**
|
|
1797
|
+
|
|
1798
|
+
### Authorization
|
|
1799
|
+
|
|
1800
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1801
|
+
|
|
1802
|
+
### HTTP request headers
|
|
1803
|
+
|
|
1804
|
+
- **Content-Type**: Not defined
|
|
1805
|
+
- **Accept**: application/json
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
## youtube_search_youtube
|
|
1809
|
+
|
|
1810
|
+
> Object youtube_search_youtube(query, opts)
|
|
1811
|
+
|
|
1812
|
+
Search YouTube
|
|
1813
|
+
|
|
1814
|
+
Search videos / channels / playlists with the full filter matrix.
|
|
1815
|
+
|
|
1816
|
+
### Examples
|
|
1817
|
+
|
|
1818
|
+
```ruby
|
|
1819
|
+
require 'time'
|
|
1820
|
+
require 'scrapebadger'
|
|
1821
|
+
# setup authorization
|
|
1822
|
+
ScrapeBadger.configure do |config|
|
|
1823
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1824
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1825
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1826
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1827
|
+
end
|
|
1828
|
+
|
|
1829
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1830
|
+
query = 'query_example' # String | Search keywords
|
|
1831
|
+
opts = {
|
|
1832
|
+
type: 'type_example', # String | video|channel|playlist|movie|all
|
|
1833
|
+
sort_by: 'sort_by_example', # String | relevance|date|views|rating
|
|
1834
|
+
upload_date: 'upload_date_example', # String | hour|today|week|month|year
|
|
1835
|
+
duration: 'duration_example', # String | short|medium|long
|
|
1836
|
+
features: 'features_example', # String | hd,4k,360,vr180,3d,hdr,cc,subtitles,live
|
|
1837
|
+
gl: 'gl_example', # String | Content region (US, GB, DE…)
|
|
1838
|
+
hl: 'hl_example', # String | UI language
|
|
1839
|
+
continuation: 'continuation_example' # String |
|
|
1840
|
+
}
|
|
1841
|
+
|
|
1842
|
+
begin
|
|
1843
|
+
# Search YouTube
|
|
1844
|
+
result = api_instance.youtube_search_youtube(query, opts)
|
|
1845
|
+
p result
|
|
1846
|
+
rescue ScrapeBadger::ApiError => e
|
|
1847
|
+
puts "Error when calling YouTubeApi->youtube_search_youtube: #{e}"
|
|
1848
|
+
end
|
|
1849
|
+
```
|
|
1850
|
+
|
|
1851
|
+
#### Using the youtube_search_youtube_with_http_info variant
|
|
1852
|
+
|
|
1853
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1854
|
+
|
|
1855
|
+
> <Array(Object, Integer, Hash)> youtube_search_youtube_with_http_info(query, opts)
|
|
1856
|
+
|
|
1857
|
+
```ruby
|
|
1858
|
+
begin
|
|
1859
|
+
# Search YouTube
|
|
1860
|
+
data, status_code, headers = api_instance.youtube_search_youtube_with_http_info(query, opts)
|
|
1861
|
+
p status_code # => 2xx
|
|
1862
|
+
p headers # => { ... }
|
|
1863
|
+
p data # => Object
|
|
1864
|
+
rescue ScrapeBadger::ApiError => e
|
|
1865
|
+
puts "Error when calling YouTubeApi->youtube_search_youtube_with_http_info: #{e}"
|
|
1866
|
+
end
|
|
1867
|
+
```
|
|
1868
|
+
|
|
1869
|
+
### Parameters
|
|
1870
|
+
|
|
1871
|
+
| Name | Type | Description | Notes |
|
|
1872
|
+
| ---- | ---- | ----------- | ----- |
|
|
1873
|
+
| **query** | **String** | Search keywords | |
|
|
1874
|
+
| **type** | **String** | video|channel|playlist|movie|all | [optional] |
|
|
1875
|
+
| **sort_by** | **String** | relevance|date|views|rating | [optional] |
|
|
1876
|
+
| **upload_date** | **String** | hour|today|week|month|year | [optional] |
|
|
1877
|
+
| **duration** | **String** | short|medium|long | [optional] |
|
|
1878
|
+
| **features** | **String** | hd,4k,360,vr180,3d,hdr,cc,subtitles,live | [optional] |
|
|
1879
|
+
| **gl** | **String** | Content region (US, GB, DE…) | [optional] |
|
|
1880
|
+
| **hl** | **String** | UI language | [optional] |
|
|
1881
|
+
| **continuation** | **String** | | [optional] |
|
|
1882
|
+
|
|
1883
|
+
### Return type
|
|
1884
|
+
|
|
1885
|
+
**Object**
|
|
1886
|
+
|
|
1887
|
+
### Authorization
|
|
1888
|
+
|
|
1889
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1890
|
+
|
|
1891
|
+
### HTTP request headers
|
|
1892
|
+
|
|
1893
|
+
- **Content-Type**: Not defined
|
|
1894
|
+
- **Accept**: application/json
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
## youtube_search_youtube_music
|
|
1898
|
+
|
|
1899
|
+
> Object youtube_search_youtube_music(query)
|
|
1900
|
+
|
|
1901
|
+
Search YouTube Music
|
|
1902
|
+
|
|
1903
|
+
### Examples
|
|
1904
|
+
|
|
1905
|
+
```ruby
|
|
1906
|
+
require 'time'
|
|
1907
|
+
require 'scrapebadger'
|
|
1908
|
+
# setup authorization
|
|
1909
|
+
ScrapeBadger.configure do |config|
|
|
1910
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1911
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1912
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1913
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1914
|
+
end
|
|
1915
|
+
|
|
1916
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1917
|
+
query = 'query_example' # String | Search keywords
|
|
1918
|
+
|
|
1919
|
+
begin
|
|
1920
|
+
# Search YouTube Music
|
|
1921
|
+
result = api_instance.youtube_search_youtube_music(query)
|
|
1922
|
+
p result
|
|
1923
|
+
rescue ScrapeBadger::ApiError => e
|
|
1924
|
+
puts "Error when calling YouTubeApi->youtube_search_youtube_music: #{e}"
|
|
1925
|
+
end
|
|
1926
|
+
```
|
|
1927
|
+
|
|
1928
|
+
#### Using the youtube_search_youtube_music_with_http_info variant
|
|
1929
|
+
|
|
1930
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1931
|
+
|
|
1932
|
+
> <Array(Object, Integer, Hash)> youtube_search_youtube_music_with_http_info(query)
|
|
1933
|
+
|
|
1934
|
+
```ruby
|
|
1935
|
+
begin
|
|
1936
|
+
# Search YouTube Music
|
|
1937
|
+
data, status_code, headers = api_instance.youtube_search_youtube_music_with_http_info(query)
|
|
1938
|
+
p status_code # => 2xx
|
|
1939
|
+
p headers # => { ... }
|
|
1940
|
+
p data # => Object
|
|
1941
|
+
rescue ScrapeBadger::ApiError => e
|
|
1942
|
+
puts "Error when calling YouTubeApi->youtube_search_youtube_music_with_http_info: #{e}"
|
|
1943
|
+
end
|
|
1944
|
+
```
|
|
1945
|
+
|
|
1946
|
+
### Parameters
|
|
1947
|
+
|
|
1948
|
+
| Name | Type | Description | Notes |
|
|
1949
|
+
| ---- | ---- | ----------- | ----- |
|
|
1950
|
+
| **query** | **String** | Search keywords | |
|
|
1951
|
+
|
|
1952
|
+
### Return type
|
|
1953
|
+
|
|
1954
|
+
**Object**
|
|
1955
|
+
|
|
1956
|
+
### Authorization
|
|
1957
|
+
|
|
1958
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1959
|
+
|
|
1960
|
+
### HTTP request headers
|
|
1961
|
+
|
|
1962
|
+
- **Content-Type**: Not defined
|
|
1963
|
+
- **Accept**: application/json
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
## youtube_shorts_by_sound
|
|
1967
|
+
|
|
1968
|
+
> Object youtube_shorts_by_sound(sound_id)
|
|
1969
|
+
|
|
1970
|
+
Shorts by sound
|
|
1971
|
+
|
|
1972
|
+
### Examples
|
|
1973
|
+
|
|
1974
|
+
```ruby
|
|
1975
|
+
require 'time'
|
|
1976
|
+
require 'scrapebadger'
|
|
1977
|
+
# setup authorization
|
|
1978
|
+
ScrapeBadger.configure do |config|
|
|
1979
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1980
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1981
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1982
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1983
|
+
end
|
|
1984
|
+
|
|
1985
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
1986
|
+
sound_id = 'sound_id_example' # String |
|
|
1987
|
+
|
|
1988
|
+
begin
|
|
1989
|
+
# Shorts by sound
|
|
1990
|
+
result = api_instance.youtube_shorts_by_sound(sound_id)
|
|
1991
|
+
p result
|
|
1992
|
+
rescue ScrapeBadger::ApiError => e
|
|
1993
|
+
puts "Error when calling YouTubeApi->youtube_shorts_by_sound: #{e}"
|
|
1994
|
+
end
|
|
1995
|
+
```
|
|
1996
|
+
|
|
1997
|
+
#### Using the youtube_shorts_by_sound_with_http_info variant
|
|
1998
|
+
|
|
1999
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2000
|
+
|
|
2001
|
+
> <Array(Object, Integer, Hash)> youtube_shorts_by_sound_with_http_info(sound_id)
|
|
2002
|
+
|
|
2003
|
+
```ruby
|
|
2004
|
+
begin
|
|
2005
|
+
# Shorts by sound
|
|
2006
|
+
data, status_code, headers = api_instance.youtube_shorts_by_sound_with_http_info(sound_id)
|
|
2007
|
+
p status_code # => 2xx
|
|
2008
|
+
p headers # => { ... }
|
|
2009
|
+
p data # => Object
|
|
2010
|
+
rescue ScrapeBadger::ApiError => e
|
|
2011
|
+
puts "Error when calling YouTubeApi->youtube_shorts_by_sound_with_http_info: #{e}"
|
|
2012
|
+
end
|
|
2013
|
+
```
|
|
2014
|
+
|
|
2015
|
+
### Parameters
|
|
2016
|
+
|
|
2017
|
+
| Name | Type | Description | Notes |
|
|
2018
|
+
| ---- | ---- | ----------- | ----- |
|
|
2019
|
+
| **sound_id** | **String** | | |
|
|
2020
|
+
|
|
2021
|
+
### Return type
|
|
2022
|
+
|
|
2023
|
+
**Object**
|
|
2024
|
+
|
|
2025
|
+
### Authorization
|
|
2026
|
+
|
|
2027
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2028
|
+
|
|
2029
|
+
### HTTP request headers
|
|
2030
|
+
|
|
2031
|
+
- **Content-Type**: Not defined
|
|
2032
|
+
- **Accept**: application/json
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
## youtube_stream_formats
|
|
2036
|
+
|
|
2037
|
+
> Object youtube_stream_formats(video_id, opts)
|
|
2038
|
+
|
|
2039
|
+
Stream formats
|
|
2040
|
+
|
|
2041
|
+
Stream/format metadata (best-effort; media URLs may be PO-token gated).
|
|
2042
|
+
|
|
2043
|
+
### Examples
|
|
2044
|
+
|
|
2045
|
+
```ruby
|
|
2046
|
+
require 'time'
|
|
2047
|
+
require 'scrapebadger'
|
|
2048
|
+
# setup authorization
|
|
2049
|
+
ScrapeBadger.configure do |config|
|
|
2050
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2051
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2052
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2053
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2054
|
+
end
|
|
2055
|
+
|
|
2056
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2057
|
+
video_id = 'video_id_example' # String |
|
|
2058
|
+
opts = {
|
|
2059
|
+
client: 'client_example' # String | IOS|ANDROID|WEB
|
|
2060
|
+
}
|
|
2061
|
+
|
|
2062
|
+
begin
|
|
2063
|
+
# Stream formats
|
|
2064
|
+
result = api_instance.youtube_stream_formats(video_id, opts)
|
|
2065
|
+
p result
|
|
2066
|
+
rescue ScrapeBadger::ApiError => e
|
|
2067
|
+
puts "Error when calling YouTubeApi->youtube_stream_formats: #{e}"
|
|
2068
|
+
end
|
|
2069
|
+
```
|
|
2070
|
+
|
|
2071
|
+
#### Using the youtube_stream_formats_with_http_info variant
|
|
2072
|
+
|
|
2073
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2074
|
+
|
|
2075
|
+
> <Array(Object, Integer, Hash)> youtube_stream_formats_with_http_info(video_id, opts)
|
|
2076
|
+
|
|
2077
|
+
```ruby
|
|
2078
|
+
begin
|
|
2079
|
+
# Stream formats
|
|
2080
|
+
data, status_code, headers = api_instance.youtube_stream_formats_with_http_info(video_id, opts)
|
|
2081
|
+
p status_code # => 2xx
|
|
2082
|
+
p headers # => { ... }
|
|
2083
|
+
p data # => Object
|
|
2084
|
+
rescue ScrapeBadger::ApiError => e
|
|
2085
|
+
puts "Error when calling YouTubeApi->youtube_stream_formats_with_http_info: #{e}"
|
|
2086
|
+
end
|
|
2087
|
+
```
|
|
2088
|
+
|
|
2089
|
+
### Parameters
|
|
2090
|
+
|
|
2091
|
+
| Name | Type | Description | Notes |
|
|
2092
|
+
| ---- | ---- | ----------- | ----- |
|
|
2093
|
+
| **video_id** | **String** | | |
|
|
2094
|
+
| **client** | **String** | IOS|ANDROID|WEB | [optional][default to 'IOS'] |
|
|
2095
|
+
|
|
2096
|
+
### Return type
|
|
2097
|
+
|
|
2098
|
+
**Object**
|
|
2099
|
+
|
|
2100
|
+
### Authorization
|
|
2101
|
+
|
|
2102
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2103
|
+
|
|
2104
|
+
### HTTP request headers
|
|
2105
|
+
|
|
2106
|
+
- **Content-Type**: Not defined
|
|
2107
|
+
- **Accept**: application/json
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
## youtube_subscriber_count_fast
|
|
2111
|
+
|
|
2112
|
+
> Object youtube_subscriber_count_fast(channel_id)
|
|
2113
|
+
|
|
2114
|
+
Subscriber count (fast)
|
|
2115
|
+
|
|
2116
|
+
### Examples
|
|
2117
|
+
|
|
2118
|
+
```ruby
|
|
2119
|
+
require 'time'
|
|
2120
|
+
require 'scrapebadger'
|
|
2121
|
+
# setup authorization
|
|
2122
|
+
ScrapeBadger.configure do |config|
|
|
2123
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2124
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2125
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2126
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2127
|
+
end
|
|
2128
|
+
|
|
2129
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2130
|
+
channel_id = 'channel_id_example' # String |
|
|
2131
|
+
|
|
2132
|
+
begin
|
|
2133
|
+
# Subscriber count (fast)
|
|
2134
|
+
result = api_instance.youtube_subscriber_count_fast(channel_id)
|
|
2135
|
+
p result
|
|
2136
|
+
rescue ScrapeBadger::ApiError => e
|
|
2137
|
+
puts "Error when calling YouTubeApi->youtube_subscriber_count_fast: #{e}"
|
|
2138
|
+
end
|
|
2139
|
+
```
|
|
2140
|
+
|
|
2141
|
+
#### Using the youtube_subscriber_count_fast_with_http_info variant
|
|
2142
|
+
|
|
2143
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2144
|
+
|
|
2145
|
+
> <Array(Object, Integer, Hash)> youtube_subscriber_count_fast_with_http_info(channel_id)
|
|
2146
|
+
|
|
2147
|
+
```ruby
|
|
2148
|
+
begin
|
|
2149
|
+
# Subscriber count (fast)
|
|
2150
|
+
data, status_code, headers = api_instance.youtube_subscriber_count_fast_with_http_info(channel_id)
|
|
2151
|
+
p status_code # => 2xx
|
|
2152
|
+
p headers # => { ... }
|
|
2153
|
+
p data # => Object
|
|
2154
|
+
rescue ScrapeBadger::ApiError => e
|
|
2155
|
+
puts "Error when calling YouTubeApi->youtube_subscriber_count_fast_with_http_info: #{e}"
|
|
2156
|
+
end
|
|
2157
|
+
```
|
|
2158
|
+
|
|
2159
|
+
### Parameters
|
|
2160
|
+
|
|
2161
|
+
| Name | Type | Description | Notes |
|
|
2162
|
+
| ---- | ---- | ----------- | ----- |
|
|
2163
|
+
| **channel_id** | **String** | | |
|
|
2164
|
+
|
|
2165
|
+
### Return type
|
|
2166
|
+
|
|
2167
|
+
**Object**
|
|
2168
|
+
|
|
2169
|
+
### Authorization
|
|
2170
|
+
|
|
2171
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2172
|
+
|
|
2173
|
+
### HTTP request headers
|
|
2174
|
+
|
|
2175
|
+
- **Content-Type**: Not defined
|
|
2176
|
+
- **Accept**: application/json
|
|
2177
|
+
|
|
2178
|
+
|
|
2179
|
+
## youtube_supported_markets
|
|
2180
|
+
|
|
2181
|
+
> Object youtube_supported_markets
|
|
2182
|
+
|
|
2183
|
+
Supported markets
|
|
2184
|
+
|
|
2185
|
+
### Examples
|
|
2186
|
+
|
|
2187
|
+
```ruby
|
|
2188
|
+
require 'time'
|
|
2189
|
+
require 'scrapebadger'
|
|
2190
|
+
# setup authorization
|
|
2191
|
+
ScrapeBadger.configure do |config|
|
|
2192
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2193
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2194
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2195
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2196
|
+
end
|
|
2197
|
+
|
|
2198
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2199
|
+
|
|
2200
|
+
begin
|
|
2201
|
+
# Supported markets
|
|
2202
|
+
result = api_instance.youtube_supported_markets
|
|
2203
|
+
p result
|
|
2204
|
+
rescue ScrapeBadger::ApiError => e
|
|
2205
|
+
puts "Error when calling YouTubeApi->youtube_supported_markets: #{e}"
|
|
2206
|
+
end
|
|
2207
|
+
```
|
|
2208
|
+
|
|
2209
|
+
#### Using the youtube_supported_markets_with_http_info variant
|
|
2210
|
+
|
|
2211
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2212
|
+
|
|
2213
|
+
> <Array(Object, Integer, Hash)> youtube_supported_markets_with_http_info
|
|
2214
|
+
|
|
2215
|
+
```ruby
|
|
2216
|
+
begin
|
|
2217
|
+
# Supported markets
|
|
2218
|
+
data, status_code, headers = api_instance.youtube_supported_markets_with_http_info
|
|
2219
|
+
p status_code # => 2xx
|
|
2220
|
+
p headers # => { ... }
|
|
2221
|
+
p data # => Object
|
|
2222
|
+
rescue ScrapeBadger::ApiError => e
|
|
2223
|
+
puts "Error when calling YouTubeApi->youtube_supported_markets_with_http_info: #{e}"
|
|
2224
|
+
end
|
|
2225
|
+
```
|
|
2226
|
+
|
|
2227
|
+
### Parameters
|
|
2228
|
+
|
|
2229
|
+
This endpoint does not need any parameter.
|
|
2230
|
+
|
|
2231
|
+
### Return type
|
|
2232
|
+
|
|
2233
|
+
**Object**
|
|
2234
|
+
|
|
2235
|
+
### Authorization
|
|
2236
|
+
|
|
2237
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2238
|
+
|
|
2239
|
+
### HTTP request headers
|
|
2240
|
+
|
|
2241
|
+
- **Content-Type**: Not defined
|
|
2242
|
+
- **Accept**: application/json
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
## youtube_trending_shorts
|
|
2246
|
+
|
|
2247
|
+
> Object youtube_trending_shorts
|
|
2248
|
+
|
|
2249
|
+
Trending shorts
|
|
2250
|
+
|
|
2251
|
+
### Examples
|
|
2252
|
+
|
|
2253
|
+
```ruby
|
|
2254
|
+
require 'time'
|
|
2255
|
+
require 'scrapebadger'
|
|
2256
|
+
# setup authorization
|
|
2257
|
+
ScrapeBadger.configure do |config|
|
|
2258
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2259
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2260
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2261
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2262
|
+
end
|
|
2263
|
+
|
|
2264
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2265
|
+
|
|
2266
|
+
begin
|
|
2267
|
+
# Trending shorts
|
|
2268
|
+
result = api_instance.youtube_trending_shorts
|
|
2269
|
+
p result
|
|
2270
|
+
rescue ScrapeBadger::ApiError => e
|
|
2271
|
+
puts "Error when calling YouTubeApi->youtube_trending_shorts: #{e}"
|
|
2272
|
+
end
|
|
2273
|
+
```
|
|
2274
|
+
|
|
2275
|
+
#### Using the youtube_trending_shorts_with_http_info variant
|
|
2276
|
+
|
|
2277
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2278
|
+
|
|
2279
|
+
> <Array(Object, Integer, Hash)> youtube_trending_shorts_with_http_info
|
|
2280
|
+
|
|
2281
|
+
```ruby
|
|
2282
|
+
begin
|
|
2283
|
+
# Trending shorts
|
|
2284
|
+
data, status_code, headers = api_instance.youtube_trending_shorts_with_http_info
|
|
2285
|
+
p status_code # => 2xx
|
|
2286
|
+
p headers # => { ... }
|
|
2287
|
+
p data # => Object
|
|
2288
|
+
rescue ScrapeBadger::ApiError => e
|
|
2289
|
+
puts "Error when calling YouTubeApi->youtube_trending_shorts_with_http_info: #{e}"
|
|
2290
|
+
end
|
|
2291
|
+
```
|
|
2292
|
+
|
|
2293
|
+
### Parameters
|
|
2294
|
+
|
|
2295
|
+
This endpoint does not need any parameter.
|
|
2296
|
+
|
|
2297
|
+
### Return type
|
|
2298
|
+
|
|
2299
|
+
**Object**
|
|
2300
|
+
|
|
2301
|
+
### Authorization
|
|
2302
|
+
|
|
2303
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2304
|
+
|
|
2305
|
+
### HTTP request headers
|
|
2306
|
+
|
|
2307
|
+
- **Content-Type**: Not defined
|
|
2308
|
+
- **Accept**: application/json
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
## youtube_trending_videos
|
|
2312
|
+
|
|
2313
|
+
> Object youtube_trending_videos(opts)
|
|
2314
|
+
|
|
2315
|
+
Trending videos
|
|
2316
|
+
|
|
2317
|
+
### Examples
|
|
2318
|
+
|
|
2319
|
+
```ruby
|
|
2320
|
+
require 'time'
|
|
2321
|
+
require 'scrapebadger'
|
|
2322
|
+
# setup authorization
|
|
2323
|
+
ScrapeBadger.configure do |config|
|
|
2324
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2325
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2326
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2327
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2328
|
+
end
|
|
2329
|
+
|
|
2330
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2331
|
+
opts = {
|
|
2332
|
+
gl: 'gl_example', # String |
|
|
2333
|
+
type: 'type_example' # String | now|music|gaming|movies
|
|
2334
|
+
}
|
|
2335
|
+
|
|
2336
|
+
begin
|
|
2337
|
+
# Trending videos
|
|
2338
|
+
result = api_instance.youtube_trending_videos(opts)
|
|
2339
|
+
p result
|
|
2340
|
+
rescue ScrapeBadger::ApiError => e
|
|
2341
|
+
puts "Error when calling YouTubeApi->youtube_trending_videos: #{e}"
|
|
2342
|
+
end
|
|
2343
|
+
```
|
|
2344
|
+
|
|
2345
|
+
#### Using the youtube_trending_videos_with_http_info variant
|
|
2346
|
+
|
|
2347
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2348
|
+
|
|
2349
|
+
> <Array(Object, Integer, Hash)> youtube_trending_videos_with_http_info(opts)
|
|
2350
|
+
|
|
2351
|
+
```ruby
|
|
2352
|
+
begin
|
|
2353
|
+
# Trending videos
|
|
2354
|
+
data, status_code, headers = api_instance.youtube_trending_videos_with_http_info(opts)
|
|
2355
|
+
p status_code # => 2xx
|
|
2356
|
+
p headers # => { ... }
|
|
2357
|
+
p data # => Object
|
|
2358
|
+
rescue ScrapeBadger::ApiError => e
|
|
2359
|
+
puts "Error when calling YouTubeApi->youtube_trending_videos_with_http_info: #{e}"
|
|
2360
|
+
end
|
|
2361
|
+
```
|
|
2362
|
+
|
|
2363
|
+
### Parameters
|
|
2364
|
+
|
|
2365
|
+
| Name | Type | Description | Notes |
|
|
2366
|
+
| ---- | ---- | ----------- | ----- |
|
|
2367
|
+
| **gl** | **String** | | [optional] |
|
|
2368
|
+
| **type** | **String** | now|music|gaming|movies | [optional][default to 'now'] |
|
|
2369
|
+
|
|
2370
|
+
### Return type
|
|
2371
|
+
|
|
2372
|
+
**Object**
|
|
2373
|
+
|
|
2374
|
+
### Authorization
|
|
2375
|
+
|
|
2376
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2377
|
+
|
|
2378
|
+
### HTTP request headers
|
|
2379
|
+
|
|
2380
|
+
- **Content-Type**: Not defined
|
|
2381
|
+
- **Accept**: application/json
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
## youtube_ui_languages
|
|
2385
|
+
|
|
2386
|
+
> Object youtube_ui_languages
|
|
2387
|
+
|
|
2388
|
+
UI languages
|
|
2389
|
+
|
|
2390
|
+
### Examples
|
|
2391
|
+
|
|
2392
|
+
```ruby
|
|
2393
|
+
require 'time'
|
|
2394
|
+
require 'scrapebadger'
|
|
2395
|
+
# setup authorization
|
|
2396
|
+
ScrapeBadger.configure do |config|
|
|
2397
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2398
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2399
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2400
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2401
|
+
end
|
|
2402
|
+
|
|
2403
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2404
|
+
|
|
2405
|
+
begin
|
|
2406
|
+
# UI languages
|
|
2407
|
+
result = api_instance.youtube_ui_languages
|
|
2408
|
+
p result
|
|
2409
|
+
rescue ScrapeBadger::ApiError => e
|
|
2410
|
+
puts "Error when calling YouTubeApi->youtube_ui_languages: #{e}"
|
|
2411
|
+
end
|
|
2412
|
+
```
|
|
2413
|
+
|
|
2414
|
+
#### Using the youtube_ui_languages_with_http_info variant
|
|
2415
|
+
|
|
2416
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2417
|
+
|
|
2418
|
+
> <Array(Object, Integer, Hash)> youtube_ui_languages_with_http_info
|
|
2419
|
+
|
|
2420
|
+
```ruby
|
|
2421
|
+
begin
|
|
2422
|
+
# UI languages
|
|
2423
|
+
data, status_code, headers = api_instance.youtube_ui_languages_with_http_info
|
|
2424
|
+
p status_code # => 2xx
|
|
2425
|
+
p headers # => { ... }
|
|
2426
|
+
p data # => Object
|
|
2427
|
+
rescue ScrapeBadger::ApiError => e
|
|
2428
|
+
puts "Error when calling YouTubeApi->youtube_ui_languages_with_http_info: #{e}"
|
|
2429
|
+
end
|
|
2430
|
+
```
|
|
2431
|
+
|
|
2432
|
+
### Parameters
|
|
2433
|
+
|
|
2434
|
+
This endpoint does not need any parameter.
|
|
2435
|
+
|
|
2436
|
+
### Return type
|
|
2437
|
+
|
|
2438
|
+
**Object**
|
|
2439
|
+
|
|
2440
|
+
### Authorization
|
|
2441
|
+
|
|
2442
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2443
|
+
|
|
2444
|
+
### HTTP request headers
|
|
2445
|
+
|
|
2446
|
+
- **Content-Type**: Not defined
|
|
2447
|
+
- **Accept**: application/json
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
## youtube_video_categories
|
|
2451
|
+
|
|
2452
|
+
> Object youtube_video_categories(opts)
|
|
2453
|
+
|
|
2454
|
+
Video categories
|
|
2455
|
+
|
|
2456
|
+
### Examples
|
|
2457
|
+
|
|
2458
|
+
```ruby
|
|
2459
|
+
require 'time'
|
|
2460
|
+
require 'scrapebadger'
|
|
2461
|
+
# setup authorization
|
|
2462
|
+
ScrapeBadger.configure do |config|
|
|
2463
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2464
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2465
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2466
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2467
|
+
end
|
|
2468
|
+
|
|
2469
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2470
|
+
opts = {
|
|
2471
|
+
gl: 'gl_example' # String |
|
|
2472
|
+
}
|
|
2473
|
+
|
|
2474
|
+
begin
|
|
2475
|
+
# Video categories
|
|
2476
|
+
result = api_instance.youtube_video_categories(opts)
|
|
2477
|
+
p result
|
|
2478
|
+
rescue ScrapeBadger::ApiError => e
|
|
2479
|
+
puts "Error when calling YouTubeApi->youtube_video_categories: #{e}"
|
|
2480
|
+
end
|
|
2481
|
+
```
|
|
2482
|
+
|
|
2483
|
+
#### Using the youtube_video_categories_with_http_info variant
|
|
2484
|
+
|
|
2485
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2486
|
+
|
|
2487
|
+
> <Array(Object, Integer, Hash)> youtube_video_categories_with_http_info(opts)
|
|
2488
|
+
|
|
2489
|
+
```ruby
|
|
2490
|
+
begin
|
|
2491
|
+
# Video categories
|
|
2492
|
+
data, status_code, headers = api_instance.youtube_video_categories_with_http_info(opts)
|
|
2493
|
+
p status_code # => 2xx
|
|
2494
|
+
p headers # => { ... }
|
|
2495
|
+
p data # => Object
|
|
2496
|
+
rescue ScrapeBadger::ApiError => e
|
|
2497
|
+
puts "Error when calling YouTubeApi->youtube_video_categories_with_http_info: #{e}"
|
|
2498
|
+
end
|
|
2499
|
+
```
|
|
2500
|
+
|
|
2501
|
+
### Parameters
|
|
2502
|
+
|
|
2503
|
+
| Name | Type | Description | Notes |
|
|
2504
|
+
| ---- | ---- | ----------- | ----- |
|
|
2505
|
+
| **gl** | **String** | | [optional][default to 'US'] |
|
|
2506
|
+
|
|
2507
|
+
### Return type
|
|
2508
|
+
|
|
2509
|
+
**Object**
|
|
2510
|
+
|
|
2511
|
+
### Authorization
|
|
2512
|
+
|
|
2513
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2514
|
+
|
|
2515
|
+
### HTTP request headers
|
|
2516
|
+
|
|
2517
|
+
- **Content-Type**: Not defined
|
|
2518
|
+
- **Accept**: application/json
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
## youtube_video_comments
|
|
2522
|
+
|
|
2523
|
+
> Object youtube_video_comments(video_id, opts)
|
|
2524
|
+
|
|
2525
|
+
Video comments
|
|
2526
|
+
|
|
2527
|
+
### Examples
|
|
2528
|
+
|
|
2529
|
+
```ruby
|
|
2530
|
+
require 'time'
|
|
2531
|
+
require 'scrapebadger'
|
|
2532
|
+
# setup authorization
|
|
2533
|
+
ScrapeBadger.configure do |config|
|
|
2534
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2535
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2536
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2537
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2538
|
+
end
|
|
2539
|
+
|
|
2540
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2541
|
+
video_id = 'video_id_example' # String |
|
|
2542
|
+
opts = {
|
|
2543
|
+
sort_by: 'sort_by_example', # String | top|newest
|
|
2544
|
+
continuation: 'continuation_example' # String |
|
|
2545
|
+
}
|
|
2546
|
+
|
|
2547
|
+
begin
|
|
2548
|
+
# Video comments
|
|
2549
|
+
result = api_instance.youtube_video_comments(video_id, opts)
|
|
2550
|
+
p result
|
|
2551
|
+
rescue ScrapeBadger::ApiError => e
|
|
2552
|
+
puts "Error when calling YouTubeApi->youtube_video_comments: #{e}"
|
|
2553
|
+
end
|
|
2554
|
+
```
|
|
2555
|
+
|
|
2556
|
+
#### Using the youtube_video_comments_with_http_info variant
|
|
2557
|
+
|
|
2558
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2559
|
+
|
|
2560
|
+
> <Array(Object, Integer, Hash)> youtube_video_comments_with_http_info(video_id, opts)
|
|
2561
|
+
|
|
2562
|
+
```ruby
|
|
2563
|
+
begin
|
|
2564
|
+
# Video comments
|
|
2565
|
+
data, status_code, headers = api_instance.youtube_video_comments_with_http_info(video_id, opts)
|
|
2566
|
+
p status_code # => 2xx
|
|
2567
|
+
p headers # => { ... }
|
|
2568
|
+
p data # => Object
|
|
2569
|
+
rescue ScrapeBadger::ApiError => e
|
|
2570
|
+
puts "Error when calling YouTubeApi->youtube_video_comments_with_http_info: #{e}"
|
|
2571
|
+
end
|
|
2572
|
+
```
|
|
2573
|
+
|
|
2574
|
+
### Parameters
|
|
2575
|
+
|
|
2576
|
+
| Name | Type | Description | Notes |
|
|
2577
|
+
| ---- | ---- | ----------- | ----- |
|
|
2578
|
+
| **video_id** | **String** | | |
|
|
2579
|
+
| **sort_by** | **String** | top|newest | [optional][default to 'top'] |
|
|
2580
|
+
| **continuation** | **String** | | [optional] |
|
|
2581
|
+
|
|
2582
|
+
### Return type
|
|
2583
|
+
|
|
2584
|
+
**Object**
|
|
2585
|
+
|
|
2586
|
+
### Authorization
|
|
2587
|
+
|
|
2588
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2589
|
+
|
|
2590
|
+
### HTTP request headers
|
|
2591
|
+
|
|
2592
|
+
- **Content-Type**: Not defined
|
|
2593
|
+
- **Accept**: application/json
|
|
2594
|
+
|
|
2595
|
+
|
|
2596
|
+
## youtube_video_transcript
|
|
2597
|
+
|
|
2598
|
+
> Object youtube_video_transcript(video_id, opts)
|
|
2599
|
+
|
|
2600
|
+
Video transcript
|
|
2601
|
+
|
|
2602
|
+
### Examples
|
|
2603
|
+
|
|
2604
|
+
```ruby
|
|
2605
|
+
require 'time'
|
|
2606
|
+
require 'scrapebadger'
|
|
2607
|
+
# setup authorization
|
|
2608
|
+
ScrapeBadger.configure do |config|
|
|
2609
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2610
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2611
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2612
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2613
|
+
end
|
|
2614
|
+
|
|
2615
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2616
|
+
video_id = 'video_id_example' # String |
|
|
2617
|
+
opts = {
|
|
2618
|
+
language: 'language_example' # String | BCP-47 language code
|
|
2619
|
+
}
|
|
2620
|
+
|
|
2621
|
+
begin
|
|
2622
|
+
# Video transcript
|
|
2623
|
+
result = api_instance.youtube_video_transcript(video_id, opts)
|
|
2624
|
+
p result
|
|
2625
|
+
rescue ScrapeBadger::ApiError => e
|
|
2626
|
+
puts "Error when calling YouTubeApi->youtube_video_transcript: #{e}"
|
|
2627
|
+
end
|
|
2628
|
+
```
|
|
2629
|
+
|
|
2630
|
+
#### Using the youtube_video_transcript_with_http_info variant
|
|
2631
|
+
|
|
2632
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2633
|
+
|
|
2634
|
+
> <Array(Object, Integer, Hash)> youtube_video_transcript_with_http_info(video_id, opts)
|
|
2635
|
+
|
|
2636
|
+
```ruby
|
|
2637
|
+
begin
|
|
2638
|
+
# Video transcript
|
|
2639
|
+
data, status_code, headers = api_instance.youtube_video_transcript_with_http_info(video_id, opts)
|
|
2640
|
+
p status_code # => 2xx
|
|
2641
|
+
p headers # => { ... }
|
|
2642
|
+
p data # => Object
|
|
2643
|
+
rescue ScrapeBadger::ApiError => e
|
|
2644
|
+
puts "Error when calling YouTubeApi->youtube_video_transcript_with_http_info: #{e}"
|
|
2645
|
+
end
|
|
2646
|
+
```
|
|
2647
|
+
|
|
2648
|
+
### Parameters
|
|
2649
|
+
|
|
2650
|
+
| Name | Type | Description | Notes |
|
|
2651
|
+
| ---- | ---- | ----------- | ----- |
|
|
2652
|
+
| **video_id** | **String** | | |
|
|
2653
|
+
| **language** | **String** | BCP-47 language code | [optional] |
|
|
2654
|
+
|
|
2655
|
+
### Return type
|
|
2656
|
+
|
|
2657
|
+
**Object**
|
|
2658
|
+
|
|
2659
|
+
### Authorization
|
|
2660
|
+
|
|
2661
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2662
|
+
|
|
2663
|
+
### HTTP request headers
|
|
2664
|
+
|
|
2665
|
+
- **Content-Type**: Not defined
|
|
2666
|
+
- **Accept**: application/json
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
## youtube_videos_under_a_hashtag
|
|
2670
|
+
|
|
2671
|
+
> Object youtube_videos_under_a_hashtag(tag)
|
|
2672
|
+
|
|
2673
|
+
Videos under a hashtag
|
|
2674
|
+
|
|
2675
|
+
### Examples
|
|
2676
|
+
|
|
2677
|
+
```ruby
|
|
2678
|
+
require 'time'
|
|
2679
|
+
require 'scrapebadger'
|
|
2680
|
+
# setup authorization
|
|
2681
|
+
ScrapeBadger.configure do |config|
|
|
2682
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2683
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2684
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2685
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2686
|
+
end
|
|
2687
|
+
|
|
2688
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2689
|
+
tag = 'tag_example' # String |
|
|
2690
|
+
|
|
2691
|
+
begin
|
|
2692
|
+
# Videos under a hashtag
|
|
2693
|
+
result = api_instance.youtube_videos_under_a_hashtag(tag)
|
|
2694
|
+
p result
|
|
2695
|
+
rescue ScrapeBadger::ApiError => e
|
|
2696
|
+
puts "Error when calling YouTubeApi->youtube_videos_under_a_hashtag: #{e}"
|
|
2697
|
+
end
|
|
2698
|
+
```
|
|
2699
|
+
|
|
2700
|
+
#### Using the youtube_videos_under_a_hashtag_with_http_info variant
|
|
2701
|
+
|
|
2702
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2703
|
+
|
|
2704
|
+
> <Array(Object, Integer, Hash)> youtube_videos_under_a_hashtag_with_http_info(tag)
|
|
2705
|
+
|
|
2706
|
+
```ruby
|
|
2707
|
+
begin
|
|
2708
|
+
# Videos under a hashtag
|
|
2709
|
+
data, status_code, headers = api_instance.youtube_videos_under_a_hashtag_with_http_info(tag)
|
|
2710
|
+
p status_code # => 2xx
|
|
2711
|
+
p headers # => { ... }
|
|
2712
|
+
p data # => Object
|
|
2713
|
+
rescue ScrapeBadger::ApiError => e
|
|
2714
|
+
puts "Error when calling YouTubeApi->youtube_videos_under_a_hashtag_with_http_info: #{e}"
|
|
2715
|
+
end
|
|
2716
|
+
```
|
|
2717
|
+
|
|
2718
|
+
### Parameters
|
|
2719
|
+
|
|
2720
|
+
| Name | Type | Description | Notes |
|
|
2721
|
+
| ---- | ---- | ----------- | ----- |
|
|
2722
|
+
| **tag** | **String** | | |
|
|
2723
|
+
|
|
2724
|
+
### Return type
|
|
2725
|
+
|
|
2726
|
+
**Object**
|
|
2727
|
+
|
|
2728
|
+
### Authorization
|
|
2729
|
+
|
|
2730
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2731
|
+
|
|
2732
|
+
### HTTP request headers
|
|
2733
|
+
|
|
2734
|
+
- **Content-Type**: Not defined
|
|
2735
|
+
- **Accept**: application/json
|
|
2736
|
+
|
|
2737
|
+
|
|
2738
|
+
## youtube_youtube_scraper_health_check
|
|
2739
|
+
|
|
2740
|
+
> Object youtube_youtube_scraper_health_check
|
|
2741
|
+
|
|
2742
|
+
YouTube scraper health check
|
|
2743
|
+
|
|
2744
|
+
Check health of the YouTube scraper service (accepts HEAD for UptimeRobot).
|
|
2745
|
+
|
|
2746
|
+
### Examples
|
|
2747
|
+
|
|
2748
|
+
```ruby
|
|
2749
|
+
require 'time'
|
|
2750
|
+
require 'scrapebadger'
|
|
2751
|
+
# setup authorization
|
|
2752
|
+
ScrapeBadger.configure do |config|
|
|
2753
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2754
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2755
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2756
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2757
|
+
end
|
|
2758
|
+
|
|
2759
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2760
|
+
|
|
2761
|
+
begin
|
|
2762
|
+
# YouTube scraper health check
|
|
2763
|
+
result = api_instance.youtube_youtube_scraper_health_check
|
|
2764
|
+
p result
|
|
2765
|
+
rescue ScrapeBadger::ApiError => e
|
|
2766
|
+
puts "Error when calling YouTubeApi->youtube_youtube_scraper_health_check: #{e}"
|
|
2767
|
+
end
|
|
2768
|
+
```
|
|
2769
|
+
|
|
2770
|
+
#### Using the youtube_youtube_scraper_health_check_with_http_info variant
|
|
2771
|
+
|
|
2772
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2773
|
+
|
|
2774
|
+
> <Array(Object, Integer, Hash)> youtube_youtube_scraper_health_check_with_http_info
|
|
2775
|
+
|
|
2776
|
+
```ruby
|
|
2777
|
+
begin
|
|
2778
|
+
# YouTube scraper health check
|
|
2779
|
+
data, status_code, headers = api_instance.youtube_youtube_scraper_health_check_with_http_info
|
|
2780
|
+
p status_code # => 2xx
|
|
2781
|
+
p headers # => { ... }
|
|
2782
|
+
p data # => Object
|
|
2783
|
+
rescue ScrapeBadger::ApiError => e
|
|
2784
|
+
puts "Error when calling YouTubeApi->youtube_youtube_scraper_health_check_with_http_info: #{e}"
|
|
2785
|
+
end
|
|
2786
|
+
```
|
|
2787
|
+
|
|
2788
|
+
### Parameters
|
|
2789
|
+
|
|
2790
|
+
This endpoint does not need any parameter.
|
|
2791
|
+
|
|
2792
|
+
### Return type
|
|
2793
|
+
|
|
2794
|
+
**Object**
|
|
2795
|
+
|
|
2796
|
+
### Authorization
|
|
2797
|
+
|
|
2798
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2799
|
+
|
|
2800
|
+
### HTTP request headers
|
|
2801
|
+
|
|
2802
|
+
- **Content-Type**: Not defined
|
|
2803
|
+
- **Accept**: application/json
|
|
2804
|
+
|
|
2805
|
+
|
|
2806
|
+
## youtube_youtube_scraper_health_check_head
|
|
2807
|
+
|
|
2808
|
+
> Object youtube_youtube_scraper_health_check_head
|
|
2809
|
+
|
|
2810
|
+
YouTube scraper health check
|
|
2811
|
+
|
|
2812
|
+
Check health of the YouTube scraper service (accepts HEAD for UptimeRobot).
|
|
2813
|
+
|
|
2814
|
+
### Examples
|
|
2815
|
+
|
|
2816
|
+
```ruby
|
|
2817
|
+
require 'time'
|
|
2818
|
+
require 'scrapebadger'
|
|
2819
|
+
# setup authorization
|
|
2820
|
+
ScrapeBadger.configure do |config|
|
|
2821
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2822
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2823
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2824
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2825
|
+
end
|
|
2826
|
+
|
|
2827
|
+
api_instance = ScrapeBadger::YouTubeApi.new
|
|
2828
|
+
|
|
2829
|
+
begin
|
|
2830
|
+
# YouTube scraper health check
|
|
2831
|
+
result = api_instance.youtube_youtube_scraper_health_check_head
|
|
2832
|
+
p result
|
|
2833
|
+
rescue ScrapeBadger::ApiError => e
|
|
2834
|
+
puts "Error when calling YouTubeApi->youtube_youtube_scraper_health_check_head: #{e}"
|
|
2835
|
+
end
|
|
2836
|
+
```
|
|
2837
|
+
|
|
2838
|
+
#### Using the youtube_youtube_scraper_health_check_head_with_http_info variant
|
|
2839
|
+
|
|
2840
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2841
|
+
|
|
2842
|
+
> <Array(Object, Integer, Hash)> youtube_youtube_scraper_health_check_head_with_http_info
|
|
2843
|
+
|
|
2844
|
+
```ruby
|
|
2845
|
+
begin
|
|
2846
|
+
# YouTube scraper health check
|
|
2847
|
+
data, status_code, headers = api_instance.youtube_youtube_scraper_health_check_head_with_http_info
|
|
2848
|
+
p status_code # => 2xx
|
|
2849
|
+
p headers # => { ... }
|
|
2850
|
+
p data # => Object
|
|
2851
|
+
rescue ScrapeBadger::ApiError => e
|
|
2852
|
+
puts "Error when calling YouTubeApi->youtube_youtube_scraper_health_check_head_with_http_info: #{e}"
|
|
2853
|
+
end
|
|
2854
|
+
```
|
|
2855
|
+
|
|
2856
|
+
### Parameters
|
|
2857
|
+
|
|
2858
|
+
This endpoint does not need any parameter.
|
|
2859
|
+
|
|
2860
|
+
### Return type
|
|
2861
|
+
|
|
2862
|
+
**Object**
|
|
2863
|
+
|
|
2864
|
+
### Authorization
|
|
2865
|
+
|
|
2866
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2867
|
+
|
|
2868
|
+
### HTTP request headers
|
|
2869
|
+
|
|
2870
|
+
- **Content-Type**: Not defined
|
|
2871
|
+
- **Accept**: application/json
|
|
2872
|
+
|