Class: XTwitterScraper::Models::ExtractionRunParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/extraction_run_params.rb,
sig/x_twitter_scraper/models/extraction_run_params.rbs

Overview

See Also:

  • XTwitterScraper::Resources::Extractions#run

Defined Under Namespace

Modules: CollectionStrategy, DedupeMode, MediaType, QueryType, Quotes, Replies, Retweets, Scope, SinceTime, Sort, Target, ToolType, UntilTime Classes: RelationTarget

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(tool_type:, dry_run: nil, advanced_query: nil, any_words: nil, bio_contains: nil, blue_verified_only: nil, bounding_box: nil, card_name: nil, cashtags: nil, collection_strategy: nil, conversation_id: nil, dedupe_across_targets: nil, dedupe_mode: nil, exact_phrase: nil, exclude_original_author: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, has_location: nil, has_media_only: nil, has_website: nil, include_original_post: nil, include_search_terms: nil, include_target_metadata: nil, in_reply_to_tweet_id: nil, language: nil, list_id: nil, location_contains: nil, max_depth: nil, max_followers: nil, max_following: nil, max_id: nil, max_items_per_target: nil, max_likes: nil, max_pages_per_target: nil, max_posts: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_account_age_days: nil, min_bookmarks: nil, min_faves: nil, min_followers: nil, min_following: nil, min_posts: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, native_retweets: nil, near: nil, news: nil, overlap_mode: nil, place: nil, place_country: nil, point_radius: nil, query_type: nil, quotes: nil, quotes_of_tweet_id: nil, relation_targets: nil, replies: nil, results_limit: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, scope: nil, search_queries: nil, search_query: nil, since_date: nil, since_id: nil, since_time: nil, sort: nil, source: nil, start_cursor: nil, target_community_id: nil, target_community_ids: nil, target_list_id: nil, target_list_ids: nil, targets: nil, target_space_id: nil, target_tweet_id: nil, target_tweet_ids: nil, target_username: nil, target_usernames: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, username_contains: nil, verified_only: nil, verified_type: nil, within: nil, within_time: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see XTwitterScraper::Models::ExtractionRunParams for more details.

Parameters:

  • tool_type (Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType) —

    Identifier for the extraction tool used to run a job.

  • dry_run (Boolean) (defaults to: nil) —

    Estimate cost without creating an extraction.

  • advanced_query (String) (defaults to: nil) —

    Raw advanced search query appended as-is (tweet_search_extractor)

  • any_words (String) (defaults to: nil) —

    Words or quoted phrases where any one can match. Separate with spaces, commas, o

  • bio_contains (String) (defaults to: nil) —

    Bio terms separated by commas or lines.

  • blue_verified_only (Boolean) (defaults to: nil) —

    Return only Blue-verified Tweet authors.

  • bounding_box (String) (defaults to: nil) —

    Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)

  • card_name (String) (defaults to: nil) —

    Match the Tweet card name.

  • cashtags (String) (defaults to: nil) —

    Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)

  • collection_strategy (Symbol, XTwitterScraper::Models::ExtractionRunParams::CollectionStrategy) (defaults to: nil) —

    Reply collection strategy.

  • conversation_id (String) (defaults to: nil) —

    Conversation ID filter (tweet_search_extractor)

  • dedupe_across_targets (Boolean) (defaults to: nil) —

    Merge duplicate results across collection targets.

  • dedupe_mode (Symbol, XTwitterScraper::Models::ExtractionRunParams::DedupeMode) (defaults to: nil) —

    Keep target duplicates, first rows, or merged overlap.

  • exact_phrase (String) (defaults to: nil) —

    Exact phrase to match (tweet_search_extractor)

  • exclude_original_author (Boolean) (defaults to: nil) —

    Exclude replies from the source author.

  • exclude_source (String) (defaults to: nil) —

    Exclude a source application.

  • exclude_words (String) (defaults to: nil) —

    Words or quoted phrases to exclude. Separate with spaces, commas, or lines. (twe

  • from_user (String) (defaults to: nil) —

    Filter by author username (tweet_search_extractor)

  • geocode (String) (defaults to: nil) —

    Match latitude, longitude, and radius.

  • hashtags (String) (defaults to: nil) —

    Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)

  • has_location (Boolean) (defaults to: nil) —

    Require a profile location.

  • has_media_only (Boolean) (defaults to: nil) —

    Return only replies with media.

  • has_website (Boolean) (defaults to: nil) —

    Require a profile website.

  • include_original_post (Boolean) (defaults to: nil) —

    Include the source post in reply results.

  • include_search_terms (Boolean) (defaults to: nil) —

    Add matching search terms to collection metadata.

  • include_target_metadata (Boolean) (defaults to: nil) —

    Add source target metadata to each result.

  • in_reply_to_tweet_id (String) (defaults to: nil) —

    Only replies to this tweet ID (tweet_search_extractor)

  • language (String) (defaults to: nil) —

    Language code filter (tweet_search_extractor)

  • list_id (String) (defaults to: nil) —

    Search within a list ID (tweet_search_extractor)

  • location_contains (String) (defaults to: nil) —

    Required profile location text.

  • max_depth (Integer) (defaults to: nil) —

    Maximum nested reply depth.

  • max_followers (Integer) (defaults to: nil) —

    Maximum follower count for profile results.

  • max_following (Integer) (defaults to: nil) —

    Maximum following count for profile results.

  • max_id (String) (defaults to: nil) —

    Return Tweets older than this Tweet ID.

  • max_items_per_target (Integer) (defaults to: nil) —

    Maximum results collected for each target.

  • max_likes (Integer) (defaults to: nil) —

    Maximum Tweet like count.

  • max_pages_per_target (Integer) (defaults to: nil) —

    Reply pages collected for each target.

  • max_posts (Integer) (defaults to: nil) —

    Maximum post count for profile results.

  • max_quotes (Integer) (defaults to: nil) —

    Maximum Tweet quote count.

  • max_replies (Integer) (defaults to: nil) —

    Maximum Tweet reply count.

  • max_retweets (Integer) (defaults to: nil) —

    Maximum Tweet repost count.

  • media_type (Symbol, XTwitterScraper::Models::ExtractionRunParams::MediaType) (defaults to: nil) —

    Media type filter (tweet_search_extractor)

  • mentioning (String) (defaults to: nil) —

    Filter tweets mentioning a username (tweet_search_extractor)

  • min_account_age_days (Integer) (defaults to: nil) —

    Minimum profile age in days.

  • min_bookmarks (Integer) (defaults to: nil) —

    Minimum Tweet bookmark count.

  • min_faves (Integer) (defaults to: nil) —

    Minimum likes threshold (tweet_search_extractor)

  • min_followers (Integer) (defaults to: nil) —

    Minimum follower count for profile results.

  • min_following (Integer) (defaults to: nil) —

    Minimum following count for profile results.

  • min_posts (Integer) (defaults to: nil) —

    Minimum post count for profile results.

  • min_quotes (Integer) (defaults to: nil) —

    Minimum quote count threshold (tweet_search_extractor)

  • min_replies (Integer) (defaults to: nil) —

    Minimum replies threshold (tweet_search_extractor)

  • min_retweets (Integer) (defaults to: nil) —

    Minimum retweets threshold (tweet_search_extractor)

  • min_views (Integer) (defaults to: nil) —

    Minimum Tweet view count.

  • native_retweets (Boolean) (defaults to: nil) —

    Only return native reposts.

  • near (String) (defaults to: nil) —

    Match a place name.

  • news (Boolean) (defaults to: nil) —

    Only return news results.

  • overlap_mode (Boolean) (defaults to: nil) —

    Shortcut for dedupeMode=merge.

  • place (String) (defaults to: nil) —

    Search within a place ID (tweet_search_extractor)

  • place_country (String) (defaults to: nil) —

    Search within a country code (tweet_search_extractor)

  • point_radius (String) (defaults to: nil) —

    Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)

  • query_type (Symbol, XTwitterScraper::Models::ExtractionRunParams::QueryType) (defaults to: nil) —

    Search ranking applied to every query.

  • quotes (Symbol, XTwitterScraper::Models::ExtractionRunParams::Quotes) (defaults to: nil) —

    Quote mode (tweet_search_extractor)

  • quotes_of_tweet_id (String) (defaults to: nil) —

    Only quotes of this tweet ID (tweet_search_extractor)

  • relation_targets (Array<XTwitterScraper::Models::ExtractionRunParams::RelationTarget>) (defaults to: nil) —

    Profile relations processed within one job.

  • replies (Symbol, XTwitterScraper::Models::ExtractionRunParams::Replies) (defaults to: nil) —

    Reply mode (tweet_search_extractor)

  • results_limit (Integer) (defaults to: nil) —

    Maximum number of results to extract. When set, the extraction stops after reach

  • retweets (Symbol, XTwitterScraper::Models::ExtractionRunParams::Retweets) (defaults to: nil) —

    Retweet mode (tweet_search_extractor)

  • retweets_of_tweet_id (String) (defaults to: nil) —

    Only retweets of this tweet ID (tweet_search_extractor)

  • safe (Boolean) (defaults to: nil) —

    Enable the safe-search filter.

  • scope (Symbol, XTwitterScraper::Models::ExtractionRunParams::Scope) (defaults to: nil) —

    Reply depth scope.

  • search_queries (Array<String>) (defaults to: nil) —

    Search queries processed as one collection job.

  • search_query (String) (defaults to: nil) —

    Required for tweet_search_extractor & community_search.

  • since_date (Date) (defaults to: nil) —

    Start date YYYY-MM-DD (tweet_search_extractor)

  • since_id (String) (defaults to: nil) —

    Return Tweets newer than this Tweet ID.

  • since_time (Time, Integer) (defaults to: nil) —

    Reply start time as ISO 8601 or Unix seconds.

  • sort (Symbol, XTwitterScraper::Models::ExtractionRunParams::Sort) (defaults to: nil) —

    Reply result order.

  • source (String) (defaults to: nil) —

    Match the source application.

  • start_cursor (String) (defaults to: nil) —

    Resume one reply target from this cursor.

  • target_community_id (String) (defaults to: nil) —

    Required for community_post_extractor & community_search.

  • target_community_ids (Array<String>) (defaults to: nil) —

    Community IDs processed as one collection job.

  • target_list_id (String) (defaults to: nil) —

    Required for list_follower_explorer, list_member_extractor & list_post_extractor

  • target_list_ids (Array<String>) (defaults to: nil) —

    List IDs processed as one collection job.

  • targets (Array<String, XTwitterScraper::Models::ExtractionRunParams::Target::UnionMember1>) (defaults to: nil) —

    Mixed targets auto-routed within one job.

  • target_space_id (String) (defaults to: nil) —

    Required for space_explorer.

  • target_tweet_id (String) (defaults to: nil)
  • target_tweet_ids (Array<String>) (defaults to: nil) —

    Tweet IDs processed as one collection job.

  • target_username (String) (defaults to: nil)
  • target_usernames (Array<String>) (defaults to: nil) —

    Usernames processed as one collection job.

  • to_user (String) (defaults to: nil) —

    Filter replies sent to a username (tweet_search_extractor)

  • until_date (Date) (defaults to: nil) —

    End date YYYY-MM-DD (tweet_search_extractor)

  • until_time (Time, Integer) (defaults to: nil) —

    Reply end time as ISO 8601 or Unix seconds.

  • url (String) (defaults to: nil) —

    URL substring or domain filter (tweet_search_extractor)

  • username_contains (String) (defaults to: nil) —

    Required username text.

  • verified_only (Boolean) (defaults to: nil) —

    Only verified authors (tweet_search_extractor)

  • verified_type (String) (defaults to: nil) —

    Exact profile verification type.

  • within (String) (defaults to: nil) —

    Set the radius for the near filter.

  • within_time (String) (defaults to: nil) —

    Match Tweets inside a recent time window.

  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 625

Instance Attribute Details

#advanced_query ⇒ String?

Raw advanced search query appended as-is (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


30
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 30

optional :advanced_query, String, api_name: :advancedQuery

#any_words ⇒ String?

Words or quoted phrases where any one can match. Separate with spaces, commas, or lines. (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 37

optional :any_words, String, api_name: :anyWords

#bio_contains ⇒ String?

Bio terms separated by commas or lines.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 43

optional :bio_contains, String, api_name: :bioContains

#blue_verified_only ⇒ Boolean?

Return only Blue-verified Tweet authors.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


49
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 49

optional :blue_verified_only, XTwitterScraper::Internal::Type::Boolean, api_name: :blueVerifiedOnly

#bounding_box ⇒ String?

Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 55

optional :bounding_box, String, api_name: :boundingBox

#card_name ⇒ String?

Match the Tweet card name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


61
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 61

optional :card_name, String, api_name: :cardName

#cashtags ⇒ String?

Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


67
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 67

optional :cashtags, String

#collection_strategy ⇒ Symbol, ...

Reply collection strategy.

Returns:



73
74
75
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 73

optional :collection_strategy,
enum: -> { XTwitterScraper::ExtractionRunParams::CollectionStrategy },
api_name: :collectionStrategy

#conversation_id ⇒ String?

Conversation ID filter (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


81
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 81

optional :conversation_id, String, api_name: :conversationId

#dedupe_across_targets ⇒ Boolean?

Merge duplicate results across collection targets.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


87
88
89
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 87

optional :dedupe_across_targets,
XTwitterScraper::Internal::Type::Boolean,
api_name: :dedupeAcrossTargets

#dedupe_mode ⇒ Symbol, ...

Keep target duplicates, first rows, or merged overlap.

Returns:



95
96
97
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 95

optional :dedupe_mode,
enum: -> { XTwitterScraper::ExtractionRunParams::DedupeMode },
api_name: :dedupeMode

#dry_run ⇒ Boolean?

Estimate cost without creating an extraction.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


24
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 24

optional :dry_run, XTwitterScraper::Internal::Type::Boolean

#exact_phrase ⇒ String?

Exact phrase to match (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


103
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 103

optional :exact_phrase, String, api_name: :exactPhrase

#exclude_original_author ⇒ Boolean?

Exclude replies from the source author.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


109
110
111
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 109

optional :exclude_original_author,
XTwitterScraper::Internal::Type::Boolean,
api_name: :excludeOriginalAuthor

#exclude_source ⇒ String?

Exclude a source application.

Parameters:

  • (String)

Returns:

  • (String, nil) 


117
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 117

optional :exclude_source, String, api_name: :excludeSource

#exclude_words ⇒ String?

Words or quoted phrases to exclude. Separate with spaces, commas, or lines. (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


124
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 124

optional :exclude_words, String, api_name: :excludeWords

#from_user ⇒ String?

Filter by author username (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


130
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 130

optional :from_user, String, api_name: :fromUser

#geocode ⇒ String?

Match latitude, longitude, and radius.

Parameters:

  • (String)

Returns:

  • (String, nil) 


136
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 136

optional :geocode, String

#has_location ⇒ Boolean?

Require a profile location.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


148
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 148

optional :has_location, XTwitterScraper::Internal::Type::Boolean, api_name: :hasLocation

#has_media_only ⇒ Boolean?

Return only replies with media.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


154
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 154

optional :has_media_only, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMediaOnly

#has_website ⇒ Boolean?

Require a profile website.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


160
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 160

optional :has_website, XTwitterScraper::Internal::Type::Boolean, api_name: :hasWebsite

#hashtags ⇒ String?

Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


142
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 142

optional :hashtags, String

#in_reply_to_tweet_id ⇒ String?

Only replies to this tweet ID (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


188
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 188

optional :in_reply_to_tweet_id, String, api_name: :inReplyToTweetId

#include_original_post ⇒ Boolean?

Include the source post in reply results.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


166
167
168
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 166

optional :include_original_post,
XTwitterScraper::Internal::Type::Boolean,
api_name: :includeOriginalPost

#include_search_terms ⇒ Boolean?

Add matching search terms to collection metadata.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


174
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 174

optional :include_search_terms, XTwitterScraper::Internal::Type::Boolean, api_name: :includeSearchTerms

#include_target_metadata ⇒ Boolean?

Add source target metadata to each result.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


180
181
182
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 180

optional :include_target_metadata,
XTwitterScraper::Internal::Type::Boolean,
api_name: :includeTargetMetadata

#language ⇒ String?

Language code filter (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


194
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 194

optional :language, String

#list_id ⇒ String?

Search within a list ID (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


200
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 200

optional :list_id, String, api_name: :listId

#location_contains ⇒ String?

Required profile location text.

Parameters:

  • (String)

Returns:

  • (String, nil) 


206
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 206

optional :location_contains, String, api_name: :locationContains

#max_depth ⇒ Integer?

Maximum nested reply depth.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


212
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 212

optional :max_depth, Integer, api_name: :maxDepth

#max_followers ⇒ Integer?

Maximum follower count for profile results.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


218
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 218

optional :max_followers, Integer, api_name: :maxFollowers

#max_following ⇒ Integer?

Maximum following count for profile results.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


224
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 224

optional :max_following, Integer, api_name: :maxFollowing

#max_id ⇒ String?

Return Tweets older than this Tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


230
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 230

optional :max_id, String, api_name: :maxId

#max_items_per_target ⇒ Integer?

Maximum results collected for each target.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


236
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 236

optional :max_items_per_target, Integer, api_name: :maxItemsPerTarget

#max_likes ⇒ Integer?

Maximum Tweet like count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


242
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 242

optional :max_likes, Integer, api_name: :maxLikes

#max_pages_per_target ⇒ Integer?

Reply pages collected for each target.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


248
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 248

optional :max_pages_per_target, Integer, api_name: :maxPagesPerTarget

#max_posts ⇒ Integer?

Maximum post count for profile results.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


254
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 254

optional :max_posts, Integer, api_name: :maxPosts

#max_quotes ⇒ Integer?

Maximum Tweet quote count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


260
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 260

optional :max_quotes, Integer, api_name: :maxQuotes

#max_replies ⇒ Integer?

Maximum Tweet reply count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


266
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 266

optional :max_replies, Integer, api_name: :maxReplies

#max_retweets ⇒ Integer?

Maximum Tweet repost count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


272
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 272

optional :max_retweets, Integer, api_name: :maxRetweets

#media_type ⇒ Symbol, ...

Media type filter (tweet_search_extractor)

Returns:



278
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 278

optional :media_type, enum: -> { XTwitterScraper::ExtractionRunParams::MediaType }, api_name: :mediaType

#mentioning ⇒ String?

Filter tweets mentioning a username (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


284
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 284

optional :mentioning, String

#min_account_age_days ⇒ Integer?

Minimum profile age in days.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


290
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 290

optional :min_account_age_days, Integer, api_name: :minAccountAgeDays

#min_bookmarks ⇒ Integer?

Minimum Tweet bookmark count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


296
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 296

optional :min_bookmarks, Integer, api_name: :minBookmarks

#min_faves ⇒ Integer?

Minimum likes threshold (tweet_search_extractor)

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


302
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 302

optional :min_faves, Integer, api_name: :minFaves

#min_followers ⇒ Integer?

Minimum follower count for profile results.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


308
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 308

optional :min_followers, Integer, api_name: :minFollowers

#min_following ⇒ Integer?

Minimum following count for profile results.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


314
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 314

optional :min_following, Integer, api_name: :minFollowing

#min_posts ⇒ Integer?

Minimum post count for profile results.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


320
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 320

optional :min_posts, Integer, api_name: :minPosts

#min_quotes ⇒ Integer?

Minimum quote count threshold (tweet_search_extractor)

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


326
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 326

optional :min_quotes, Integer, api_name: :minQuotes

#min_replies ⇒ Integer?

Minimum replies threshold (tweet_search_extractor)

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


332
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 332

optional :min_replies, Integer, api_name: :minReplies

#min_retweets ⇒ Integer?

Minimum retweets threshold (tweet_search_extractor)

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


338
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 338

optional :min_retweets, Integer, api_name: :minRetweets

#min_views ⇒ Integer?

Minimum Tweet view count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


344
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 344

optional :min_views, Integer, api_name: :minViews

#native_retweets ⇒ Boolean?

Only return native reposts.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


350
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 350

optional :native_retweets, XTwitterScraper::Internal::Type::Boolean, api_name: :nativeRetweets

#near ⇒ String?

Match a place name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


356
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 356

optional :near, String

#news ⇒ Boolean?

Only return news results.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


362
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 362

optional :news, XTwitterScraper::Internal::Type::Boolean

#overlap_mode ⇒ Boolean?

Shortcut for dedupeMode=merge.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


368
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 368

optional :overlap_mode, XTwitterScraper::Internal::Type::Boolean, api_name: :overlapMode

#place ⇒ String?

Search within a place ID (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


374
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 374

optional :place, String

#place_country ⇒ String?

Search within a country code (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


380
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 380

optional :place_country, String, api_name: :placeCountry

#point_radius ⇒ String?

Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


386
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 386

optional :point_radius, String, api_name: :pointRadius

#query_type ⇒ Symbol, ...

Search ranking applied to every query.

Returns:



392
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 392

optional :query_type, enum: -> { XTwitterScraper::ExtractionRunParams::QueryType }, api_name: :queryType

#quotes ⇒ Symbol, ...

Quote mode (tweet_search_extractor)

Returns:



398
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 398

optional :quotes, enum: -> { XTwitterScraper::ExtractionRunParams::Quotes }

#quotes_of_tweet_id ⇒ String?

Only quotes of this tweet ID (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


404
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 404

optional :quotes_of_tweet_id, String, api_name: :quotesOfTweetId

#relation_targets ⇒ Array<XTwitterScraper::Models::ExtractionRunParams::RelationTarget>?

Profile relations processed within one job.

Returns:



410
411
412
413
414
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 410

optional :relation_targets,
-> {
  XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::ExtractionRunParams::RelationTarget]
},
api_name: :relationTargets

#replies ⇒ Symbol, ...

Reply mode (tweet_search_extractor)

Returns:



420
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 420

optional :replies, enum: -> { XTwitterScraper::ExtractionRunParams::Replies }

#results_limit ⇒ Integer?

Maximum number of results to extract. When set, the extraction stops after reaching this limit.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


427
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 427

optional :results_limit, Integer, api_name: :resultsLimit

#retweets ⇒ Symbol, ...

Retweet mode (tweet_search_extractor)

Returns:



433
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 433

optional :retweets, enum: -> { XTwitterScraper::ExtractionRunParams::Retweets }

#retweets_of_tweet_id ⇒ String?

Only retweets of this tweet ID (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


439
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 439

optional :retweets_of_tweet_id, String, api_name: :retweetsOfTweetId

#safe ⇒ Boolean?

Enable the safe-search filter.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


445
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 445

optional :safe, XTwitterScraper::Internal::Type::Boolean

#scope ⇒ Symbol, ...

Reply depth scope.

Returns:



451
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 451

optional :scope, enum: -> { XTwitterScraper::ExtractionRunParams::Scope }

#search_queries ⇒ Array<String>?

Search queries processed as one collection job.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


457
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 457

optional :search_queries, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :searchQueries

#search_query ⇒ String?

Required for tweet_search_extractor & community_search.

Parameters:

  • (String)

Returns:

  • (String, nil) 


463
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 463

optional :search_query, String, api_name: :searchQuery

#since_date ⇒ Date?

Start date YYYY-MM-DD (tweet_search_extractor)

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


469
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 469

optional :since_date, Date, api_name: :sinceDate

#since_id ⇒ String?

Return Tweets newer than this Tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


475
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 475

optional :since_id, String, api_name: :sinceId

#since_time ⇒ Time, ...

Reply start time as ISO 8601 or Unix seconds.

Returns:

  • (Time, Integer, nil) 


481
482
483
484
485
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 481

optional :since_time,
union: -> {
  XTwitterScraper::ExtractionRunParams::SinceTime
},
api_name: :sinceTime

#sort ⇒ Symbol, ...

Reply result order.

Returns:



491
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 491

optional :sort, enum: -> { XTwitterScraper::ExtractionRunParams::Sort }

#source ⇒ String?

Match the source application.

Parameters:

  • (String)

Returns:

  • (String, nil) 


497
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 497

optional :source, String

#start_cursor ⇒ String?

Resume one reply target from this cursor.

Parameters:

  • (String)

Returns:

  • (String, nil) 


503
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 503

optional :start_cursor, String, api_name: :startCursor

#target_community_id ⇒ String?

Required for community_post_extractor & community_search.

Parameters:

  • (String)

Returns:

  • (String, nil) 


509
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 509

optional :target_community_id, String, api_name: :targetCommunityId

#target_community_ids ⇒ Array<String>?

Community IDs processed as one collection job.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


515
516
517
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 515

optional :target_community_ids,
XTwitterScraper::Internal::Type::ArrayOf[String],
api_name: :targetCommunityIds

#target_list_id ⇒ String?

Required for list_follower_explorer, list_member_extractor & list_post_extractor.

Parameters:

  • (String)

Returns:

  • (String, nil) 


524
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 524

optional :target_list_id, String, api_name: :targetListId

#target_list_ids ⇒ Array<String>?

List IDs processed as one collection job.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


530
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 530

optional :target_list_ids, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :targetListIds

#target_space_id ⇒ String?

Required for space_explorer.

Parameters:

  • (String)

Returns:

  • (String, nil) 


543
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 543

optional :target_space_id, String, api_name: :targetSpaceId

#target_tweet_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


548
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 548

optional :target_tweet_id, String, api_name: :targetTweetId

#target_tweet_ids ⇒ Array<String>?

Tweet IDs processed as one collection job.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


554
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 554

optional :target_tweet_ids, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :targetTweetIds

#target_username ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


559
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 559

optional :target_username, String, api_name: :targetUsername

#target_usernames ⇒ Array<String>?

Usernames processed as one collection job.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


565
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 565

optional :target_usernames, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :targetUsernames

#targets ⇒ Array<String, XTwitterScraper::Models::ExtractionRunParams::Target::UnionMember1>?

Mixed targets auto-routed within one job.

Returns:



536
537
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 536

optional :targets,
-> { XTwitterScraper::Internal::Type::ArrayOf[union: XTwitterScraper::ExtractionRunParams::Target] }

#to_user ⇒ String?

Filter replies sent to a username (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


571
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 571

optional :to_user, String, api_name: :toUser

#tool_type ⇒ Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType

Identifier for the extraction tool used to run a job.

Parameters:

  • value (XTwitterScraper::Models::ExtractionRunParams::tool_type)

Returns:



18
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 18

required :tool_type, enum: -> { XTwitterScraper::ExtractionRunParams::ToolType }, api_name: :toolType

#until_date ⇒ Date?

End date YYYY-MM-DD (tweet_search_extractor)

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


577
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 577

optional :until_date, Date, api_name: :untilDate

#until_time ⇒ Time, ...

Reply end time as ISO 8601 or Unix seconds.

Returns:

  • (Time, Integer, nil) 


583
584
585
586
587
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 583

optional :until_time,
union: -> {
  XTwitterScraper::ExtractionRunParams::UntilTime
},
api_name: :untilTime

#url ⇒ String?

URL substring or domain filter (tweet_search_extractor)

Parameters:

  • (String)

Returns:

  • (String, nil) 


593
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 593

optional :url, String

#username_contains ⇒ String?

Required username text.

Parameters:

  • (String)

Returns:

  • (String, nil) 


599
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 599

optional :username_contains, String, api_name: :usernameContains

#verified_only ⇒ Boolean?

Only verified authors (tweet_search_extractor)

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


605
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 605

optional :verified_only, XTwitterScraper::Internal::Type::Boolean, api_name: :verifiedOnly

#verified_type ⇒ String?

Exact profile verification type.

Parameters:

  • (String)

Returns:

  • (String, nil) 


611
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 611

optional :verified_type, String, api_name: :verifiedType

#within ⇒ String?

Set the radius for the near filter.

Parameters:

  • (String)

Returns:

  • (String, nil) 


617
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 617

optional :within, String

#within_time ⇒ String?

Match Tweets inside a recent time window.

Parameters:

  • (String)

Returns:

  • (String, nil) 


623
 
# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 623

optional :within_time, String, api_name: :withinTime

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 853

.variants ⇒ Array(String, XTwitterScraper::Models::ExtractionRunParams::Target::UnionMember1)

Returns:




# File 'lib/x_twitter_scraper/models/extraction_run_params.rb', line 999

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


626
 
# File 'sig/x_twitter_scraper/models/extraction_run_params.rbs', line 626

def to_hash: -> {