Skip to content

Enums

enums

Type Aliases for Scrape.do's Google Plugin Literal Parameters

Every fixed-value field on a Google Plugin parameter model resolves to a named TypeAlias declared here

Device / Sort
Search Filters
Flights
Hotels
News / Trends / Trending
Play Store
Shopping Product

GoogleDeviceType module-attribute 

GoogleDeviceType = Literal['desktop', 'mobile']

Device class to emulate when fetching the SERP / Shopping page

GoogleReviewsSortByType module-attribute 

GoogleReviewsSortByType = Literal[
    "newestFirst", "ratingHigh", "ratingLow"
]

Sort order returned by google/maps/reviews

GoogleShoppingSortByType module-attribute 

GoogleShoppingSortByType = Literal[0, 1, 2]

Sort order for google/shopping

Mapping
  • 0 = Relevance
  • 1 = Acsending Price
  • 2 = Descending Price

GoogleFlightsTripType module-attribute 

GoogleFlightsTripType = Literal[1, 2]

Trip type for google/flights

Mapping
  • 1 = Round Trip
  • 2 = One Way

GoogleFlightsTravelClassType module-attribute 

GoogleFlightsTravelClassType = Literal[1, 2, 3, 4]

Cabin class for google/flights

Mapping
  • 1 = Economy
  • 2 = Premium Economy
  • 3 = Business
  • 4 = Fist Class

GoogleFlightsStopsType module-attribute 

GoogleFlightsStopsType = Literal[0, 1, 2, 3]

Stop filter for google/flights

Mapping
  • 0 = Any
  • 1 = No Stops
  • 2 = 1 Stop Or Less
  • 3 = 2 Stops Or Less

GoogleFlightsSortByType module-attribute 

GoogleFlightsSortByType = Literal[1, 2, 3, 4, 5, 6]

Sort order for google/flights

Mapping
  • 1 = Top
  • 2 = Price
  • 3 = Departure
  • 4 = Arrival
  • 5 = Duration
  • 6 = Emissions

GoogleHotelsSortByType module-attribute 

GoogleHotelsSortByType = Literal[3, 8, 13]

Sort order for google/hotels

Mapping
  • 3 = Price
  • 8 = Rating
  • 13 = Most Reviewed

GoogleHotelsRatingType module-attribute 

GoogleHotelsRatingType = Literal[7, 8, 9]

Rating threshold for google/hotels

Mapping
  • 7 = 3.5+
  • 8 = 4.0+
  • 9 = 4.5+

GoogleNewsSortOrderType module-attribute 

GoogleNewsSortOrderType = Literal['0', '1']

Sort order for google/news when q is the driver

Mapping
  • "0" = Relevance
  • "1" = Date

GoogleTrendsDataType module-attribute 

GoogleTrendsDataType = Literal[
    "TIMESERIES",
    "GEO_MAP",
    "GEO_MAP_0",
    "RELATED_QUERIES",
    "RELATED_TOPICS",
]

Trends widget to fetch for google/trends

GEO_MAP vs GEO_MAP_0

  • GEO_MAP returns the regional-interest breakdown for multi-query mode (when comparing two or more q terms)

  • GEO_MAP_0 returns the regional-interest map for the single-query mode

  • When data_type is omitted, the gateway returns TIMESERIES + GEO_MAP by default

GoogleTrendsRegionType module-attribute 

GoogleTrendsRegionType = Literal[
    "COUNTRY", "REGION", "DMA", "CITY"
]

Geographic resolution for google/trends when data_type selects a regional-interest widget (GEO_MAP or GEO_MAP_0)

Mapping
  • COUNTRY = Country-level granularity
  • REGION = Subdivisions (states / provinces)
  • DMA = Designated Market Area (US only)
  • CITY = City-level granularity

GoogleTrendingHoursType module-attribute 

GoogleTrendingHoursType = Literal[4, 24, 48, 168]

Time window for google/trending

Mapping
  • 4 = Last 4 hours
  • 24 = Last 24 hours (default)
  • 48 = Last 48 hours
  • 168 = Last 7 days

GoogleTrendingSortType module-attribute 

GoogleTrendingSortType = Literal[
    "relevance", "search_volume", "recency", "title"
]

Sort order for google/trending

Mapping
  • relevance = Most relevant first (default)
  • search_volume = Highest search volume first
  • recency = Most recent first
  • title = Alphabetical

GoogleTrendingStatusType module-attribute 

GoogleTrendingStatusType = Literal['all', 'active']

Trend-status filter for google/trending

Mapping
  • all = All trends regardless of state (default)
  • active = Currently active trends only

GoogleTrendsGPropType module-attribute 

GoogleTrendsGPropType = Literal[
    "web", "images", "news", "youtube", "froogle"
]

Google property scope for google/trends

GoogleSafeSearchType module-attribute 

GoogleSafeSearchType = Literal['active', 'off']

SafeSearch filter for google/search

Mapping
  • "active" = SafeSearch on (filters explicit content)
  • "off" = SafeSearch off

GoogleTimePeriodType module-attribute 

GoogleTimePeriodType = Literal[
    "last_hour",
    "last_day",
    "last_week",
    "last_month",
    "last_year",
]

Time-range filter for google/search

Usages

  • Filters organic results to a rolling window ending at the current moment

  • Combine with start for paginated time-filtered results

GoogleNFPRType module-attribute 

GoogleNFPRType = Literal[0, 1]

Spell-correction toggle for google/search

Mapping
  • 0 = Spell correction enabled (default Google behaviour)
  • 1 = Spell correction disabled (returns "no fix for spelling")

GooglePlayStoreChartType module-attribute 

GooglePlayStoreChartType = Literal[
    "topselling_free", "topselling_paid", "topgrossing"
]

Top-charts driver for google/play-store

Mapping
  • topselling_free = Top free apps
  • topselling_paid = Top paid apps
  • topgrossing = Top grossing apps

GooglePlayStoreDeviceType module-attribute 

GooglePlayStoreDeviceType = Literal[
    "phone", "tablet", "tv", "chromebook", "watch", "car"
]

Form-factor filter for the google/play-store endpoint's store_device parameter

GooglePlayStoreAgeType module-attribute 

GooglePlayStoreAgeType = Literal[
    "AGE_RANGE1", "AGE_RANGE2", "AGE_RANGE3"
]

Age-range filter for google/play-store when apps_category="FAMILY"

Mapping
  • AGE_RANGE1 = Ages 5 & under
  • AGE_RANGE2 = Ages 6-8
  • AGE_RANGE3 = Ages 9 & up

GoogleShoppingProductSortByType module-attribute 

GoogleShoppingProductSortByType = Literal[
    "base_price",
    "total_price",
    "promotion",
    "seller_rating",
]

Sort order for google/shopping/product

Mapping
  • base_price = Base price ascending
  • total_price = Total price (incl. shipping) ascending
  • promotion = Promotional offers first
  • seller_rating = Highest seller rating first
HTML Fallback

Setting sort_by forces the endpoint into an HTML-fallback path on the gateway side

GoogleShoppingProductDeviceType module-attribute 

GoogleShoppingProductDeviceType = Literal[
    "desktop", "mobile", "tablet"
]

Device class to emulate for google/shopping/product

Extended Device Set

Unlike most other Google plugins (which accept only desktop/mobile), google/shopping/product additionally accepts tablet