ExTrends v0.1.0 ExTrends.InterestByRegion View Source
Google interest by region operation
See in which location your term was most popular during the specified time frame.
Values are calculated on a scale from 0 to 100, where 100 is the location with the most popularity as a fraction of total searches in that location.
Link to this section Summary
Functions
To build interest by region operation
Link to this section Functions
request(query)
View Sourcerequest(%{ :keyword => binary() | [binary()], optional(:time) => binary(), optional(:geo) => binary(), optional(:resolution) => binary(), optional(:hl) => binary(), optional(:tz) => integer(), optional(:prop) => binary(), optional(:cat) => integer() }) :: ExTrends.Operation.InterestByRegion.t() | no_return()
To build interest by region operation
Map keys:
keyword
- type string or list of string(up to 5 keywords) - the search term(s) of interest.time
- Location of interest.geo
- geocode for a country, region, or DMA depending on the granularity required (defaults to worldwide). For example,geo: "US-CA-800"
will target the Bakersfield, California, United States orgeo: "US"
will just target the US.resolution
-COUNTRY
,REGION
,CITY
orDMA
. Resolution is selected by default otherwise. Trying to select a resolution larger than a specified geo will return an error.hl
- Preferred language (defaults toen-US
. Ref: language-codes)tz
- Timezone Offset from UTC in minutes. (defaults to 0)prop
- Google property to filter on. Defaults to web search. (enumerated string [images
,news
,youtube
orfroogle
] where froogle is Google Shopping results)cat
- A number corresponding to a particular category to query within (defaults to all categories), see the category wiki for a complete list.
Time format
Date to start from
Defaults to last 5yrs,
"today 5-y"
.Everything
"all"
Specific dates, "YYYY-MM-DD YYYY-MM-DD" example
"2016-12-14 2017-01-25"
Specific datetimes, "YYYY-MM-DDTHH YYYY-MM-DDTHH" example
"2017-02-06T10 2017-02-12T07"
- Note Time component is based off UTC
Current Time Minus Time Pattern:
By Month:
"today #-m"
where # is the number of months from that date to pull data for- For example:
"today 3-m"
would get data from today to 3months ago - NOTE Google uses UTC date as "today"
- Seems to only work for 1, 2, 3 months only
- For example:
Daily:
"now #-d"
where # is the number of days from that date to pull data for- For example:
"now 7-d"
would get data from the last week - Seems to only work for 1, 7 days only
- For example:
Hourly:
"now #-H"
where # is the number of hours from that date to pull data for- For example:
"now 1-H"
would get data from the last hour - Seems to only work for 1, 4 hours only
- For example:
Examples
ExTrends.InterestByRegion.request(%{keyword: "virus"}) |> ExTrends.run()