- JSON representation
- LocationFilter
- TelecommutePreference
- CommuteFilter
- CommuteMethod
- RoadTraffic
- TimeOfDay
- CompensationFilter
- FilterType
- TimestampRange
The query required to perform a search query.
JSON representation | |
---|---|
{ "query": string, "queryLanguageCode": string, "companies": [ string ], "locationFilters": [ { object ( |
Fields | |
---|---|
query |
The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. |
queryLanguageCode |
The language code of If a value isn't specified, the query language code is automatically detected, which may not be accurate. Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. |
companies[] |
This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{projectId}/tenants/{tenantId}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar". At most 20 company filters are allowed. |
locationFilters[] |
The location filter specifies geo-regions containing the jobs to search against. See If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the At most 5 location filters are allowed. |
jobCategories[] |
The category filter specifies the categories of jobs to search against. See If a value isn't specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. |
commuteFilter |
Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works when you specify a Currently we don't support sorting by commute time. |
companyDisplayNames[] |
This filter specifies the exact company If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. |
compensationFilter |
This search filter is applied only to |
customAttributeFilter |
This filter specifies a structured syntax to match against the The syntax for this expression is a subset of SQL syntax. Supported operators are: Supported functions are Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: |
disableSpellCheck |
This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. |
employmentTypes[] |
The employment type filter specifies the employment type of jobs to search against, such as If a value isn't specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. |
languageCodes[] |
This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. At most 10 language code filters are allowed. |
publishTimeRange |
Jobs published within a range specified by this filter are searched against. |
excludedJobs[] |
This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed. |
LocationFilter
Geographic region of the search.
JSON representation | |
---|---|
{ "address": string, "regionCode": string, "latLng": { object ( |
Fields | |
---|---|
address |
The address name, such as "Mountain View" or "Bay Area". |
regionCode |
CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field to bias location resolution toward a specific country or territory. If this field is not set, application behavior is biased toward the United States by default. See https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. Note that this filter is not applicable for Profile Search related queries. |
latLng |
The latitude and longitude of the geographic center to search from. This field is ignored if |
distanceInMiles |
The distanceInMiles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger. |
telecommutePreference |
Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. This field is only used for job search requests. |
negated |
Whether to apply negation to the filter so profiles matching the filter are excluded. Currently only supported in profile search. |
TelecommutePreference
Specify whether to include telecommute jobs.
Enums | |
---|---|
TELECOMMUTE_PREFERENCE_UNSPECIFIED |
Default value if the telecommute preference isn't specified. |
TELECOMMUTE_EXCLUDED |
Exclude telecommute jobs. |
TELECOMMUTE_ALLOWED |
Allow telecommute jobs. |
CommuteFilter
Parameters needed for commute search.
JSON representation | |
---|---|
{ "commuteMethod": enum ( |
Fields | ||
---|---|---|
commuteMethod |
Required. The method of transportation to calculate the commute time for. |
|
startCoordinates |
Required. The latitude and longitude of the location to calculate the commute time from. |
|
travelDuration |
Required. The maximum travel time in seconds. The maximum allowed value is A duration in seconds with up to nine fractional digits, terminated by ' |
|
allowImpreciseAddresses |
If |
|
Union field traffic_option . Traffic factor to take into account while searching by commute. traffic_option can be only one of the following: |
||
roadTraffic |
Specifies the traffic density to use when calculating commute time. |
|
departureTime |
The departure time used to calculate traffic impact, represented as Currently traffic model is restricted to hour level resolution. |
CommuteMethod
Method for commute.
Enums | |
---|---|
COMMUTE_METHOD_UNSPECIFIED |
Commute method isn't specified. |
DRIVING |
Commute time is calculated based on driving time. |
TRANSIT |
Commute time is calculated based on public transit including bus, metro, subway, and so on. |
WALKING |
Commute time is calculated based on walking time. |
CYCLING |
Commute time is calculated based on biking time. |
RoadTraffic
The traffic density to use when calculating commute time.
Enums | |
---|---|
ROAD_TRAFFIC_UNSPECIFIED |
Road traffic situation isn't specified. |
TRAFFIC_FREE |
Optimal commute time without considering any traffic impact. |
BUSY_HOUR |
Commute time calculation takes in account the peak traffic impact. |
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date
and google.protobuf.Timestamp
.
JSON representation | |
---|---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Fields | |
---|---|
hours |
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes |
Minutes of hour of day. Must be from 0 to 59. |
seconds |
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
nanos |
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
CompensationFilter
Filter on job compensation type and amount.
JSON representation | |
---|---|
{ "type": enum ( |
Fields | |
---|---|
type |
Required. Type of filter. |
units[] |
Required. Specify desired |
range |
Compensation range. |
includeJobsWithUnspecifiedCompensationRange |
If set to true, jobs with unspecified compensation range fields are included. |
FilterType
Specify the type of filtering.
Enums | |
---|---|
FILTER_TYPE_UNSPECIFIED |
Filter type unspecified. Position holder, INVALID, should never be used. |
UNIT_ONLY |
Filter by See |
UNIT_AND_AMOUNT |
Filter by See |
ANNUALIZED_BASE_AMOUNT |
Filter by annualized base compensation amount and |
ANNUALIZED_TOTAL_AMOUNT |
Filter by annualized total compensation amount and |
TimestampRange
Message representing a period of time between two timestamps.
JSON representation | |
---|---|
{ "startTime": string, "endTime": string } |
Fields | |
---|---|
startTime |
Begin of the period (inclusive). |
endTime |
End of the period (exclusive). |