SearchJobsResponse

Response for SearchJob method.

JSON representation
{
  "matchingJobs": [
    {
      object (MatchingJob)
    }
  ],
  "histogramQueryResults": [
    {
      object (HistogramQueryResult)
    }
  ],
  "nextPageToken": string,
  "locationFilters": [
    {
      object (Location)
    }
  ],
  "totalSize": integer,
  "metadata": {
    object (ResponseMetadata)
  },
  "broadenedQueryJobsCount": integer,
  "spellCorrection": {
    object (SpellingCorrection)
  }
}
Fields
matchingJobs[]

object (MatchingJob)

The Job entities that match the specified SearchJobsRequest.

histogramQueryResults[]

object (HistogramQueryResult)

The histogram results that match with specified SearchJobsRequest.histogram_queries.

nextPageToken

string

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

locationFilters[]

object (Location)

The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location.location_type is Location.LocationType.LOCATION_TYPE_UNSPECIFIED.

totalSize

integer

Number of jobs that match the specified query.

Note: This size is precise only if the total is less than 100,000.

metadata

object (ResponseMetadata)

Additional information for the API invocation, such as the request tracking id.

broadenedQueryJobsCount

integer

If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.

spellCorrection

object (SpellingCorrection)

The spell checking result, and correction.

MatchingJob

Job entry with metadata inside SearchJobsResponse.

JSON representation
{
  "job": {
    object (Job)
  },
  "jobSummary": string,
  "jobTitleSnippet": string,
  "searchTextSnippet": string,
  "commuteInfo": {
    object (CommuteInfo)
  }
}
Fields
job

object (Job)

Job resource that matches the specified SearchJobsRequest.

jobSummary

string

A summary of the job with core information that's displayed on the search results listing page.

jobTitleSnippet

string

Contains snippets of text from the Job.title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.

searchTextSnippet

string

Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

commuteInfo

object (CommuteInfo)

Commute information which is generated based on specified CommuteFilter.

CommuteInfo

Commute details related to this job.

JSON representation
{
  "jobLocation": {
    object (Location)
  },
  "travelDuration": string
}
Fields
jobLocation

object (Location)

Location used as the destination in the commute calculation.

travelDuration

string (Duration format)

The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job isn't reachable within the requested duration, but was returned as part of an expanded query.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

HistogramQueryResult

Histogram result that matches HistogramQuery specified in searches.

JSON representation
{
  "histogramQuery": string,
  "histogram": {
    string: string,
    ...
  }
}
Fields
histogramQuery

string

Requested histogram expression.

histogram

map (key: string, value: string (int64 format))

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.

The key format is:

  • (for string histogram) string values stored in the field.
  • (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative.
  • (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

SpellingCorrection

Spell check result.

JSON representation
{
  "corrected": boolean,
  "correctedText": string,
  "correctedHtml": string
}
Fields
corrected

boolean

Indicates if the query was corrected by the spell checker.

correctedText

string

Correction output consisting of the corrected keyword string.

correctedHtml

string

Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "..." html tags.

For example, the user input query is "software enginear", where the second word, "enginear," is incorrect. It should be "engineer". When spelling correction is enabled, this value is "software engineer".