SearchJobsResponse

Output only.

Response for SearchJob method.

JSON representation
{
  "matchingJobs": [
    {
      object (MatchingJob)
    }
  ],
  "histogramResults": {
    object (HistogramResults)
  },
  "nextPageToken": string,
  "locationFilters": [
    {
      object (Location)
    }
  ],
  "estimatedTotalSize": number,
  "totalSize": number,
  "metadata": {
    object (ResponseMetadata)
  },
  "broadenedQueryJobsCount": number,
  "spellCorrection": {
    object (SpellingCorrection)
  }
}
Fields
matchingJobs[]

object (MatchingJob)

The Job entities that match the specified SearchJobsRequest.

histogramResults

object (HistogramResults)

The histogram results that match specified SearchJobsRequest.histogram_facets.

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 [JobLocation.location_type][] is [JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED][].

estimatedTotalSize

number

An estimation of the number of jobs that match the specified query.

This number is not guaranteed to be accurate. For accurate results, see [enablePreciseResultSize][].

totalSize

number

The precise result count, which is available only if the client set [enablePreciseResultSize][] to true, or if the response is the last page of results. Otherwise, the value is -1.

metadata

object (ResponseMetadata)

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

broadenedQueryJobsCount

number

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

Output only.

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.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

Output only.

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 is not 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".

HistogramResults

Output only.

Histogram results that match HistogramFacets specified in SearchJobsRequest.

JSON representation
{
  "simpleHistogramResults": [
    {
      object (HistogramResult)
    }
  ],
  "customAttributeHistogramResults": [
    {
      object (CustomAttributeHistogramResult)
    }
  ],
  "compensationHistogramResults": [
    {
      object (CompensationHistogramResult)
    }
  ]
}
Fields
simpleHistogramResults[]

object (HistogramResult)

Specifies histogram results that matches HistogramFacets.simple_histogram_facets.

customAttributeHistogramResults[]

object (CustomAttributeHistogramResult)

Specifies histogram results for custom attributes that match HistogramFacets.custom_attribute_histogram_facets.

compensationHistogramResults[]

object (CompensationHistogramResult)

Specifies compensation field-based histogram results that match [HistogramFacets.compensation_histogram_requests][].

HistogramResult

Output only.

Result of a histogram call. The response contains the histogram map for the search type specified by [HistogramResult.field][]. The response is a map of each filter value to the corresponding count of jobs for that filter.

JSON representation
{
  "searchType": enum (SearchType),
  "values": {
    string: number,
    ...
  }
}
Fields
searchType

enum (SearchType)

The Histogram search filters.

values

map (key: string, value: number)

A map from the values of [field][] to the number of jobs with that value in this search result.

Key: search type (filter names, such as the companyName).

Values: the count of jobs that match the filter for this search.

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

CustomAttributeHistogramResult

Output only.

Custom attribute histogram result.

JSON representation
{
  "key": string,
  "stringValueHistogramResult": {
    string: number,
    ...
  },
  "longValueHistogramResult": {
    object (NumericBucketingResult)
  }
}
Fields
key

string

Stores the key of custom attribute the histogram is performed on.

stringValueHistogramResult

map (key: string, value: number)

Stores a map from the values of string custom field associated with key to the number of jobs with that value in this histogram result.

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

longValueHistogramResult

object (NumericBucketingResult)

Stores bucketed histogram counting result or min/max values for custom attribute long values associated with key.

NumericBucketingResult

Output only.

Custom numeric bucketing result.

JSON representation
{
  "counts": [
    {
      object (BucketizedCount)
    }
  ],
  "minValue": number,
  "maxValue": number
}
Fields
counts[]

object (BucketizedCount)

Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1.

minValue

number

Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.

maxValue

number

Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true.

BucketizedCount

Represents count of jobs within one bucket.

JSON representation
{
  "range": {
    object (BucketRange)
  },
  "count": number
}
Fields
range

object (BucketRange)

Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range.

count

number

Number of jobs whose numeric field value fall into range.

BucketRange

Represents starting and ending value of a range in double.

JSON representation
{
  "from": number,
  "to": number
}
Fields
from

number

Starting value of the bucket range.

to

number

Ending value of the bucket range.

CompensationHistogramResult

Output only.

Compensation based histogram result.

JSON representation
{
  "type": enum (CompensationHistogramRequestType),
  "result": {
    object (NumericBucketingResult)
  }
}
Fields
type

enum (CompensationHistogramRequestType)

Type of the request, corresponding to CompensationHistogramRequest.type.

result

object (NumericBucketingResult)

Histogram result.

SpellingCorrection

Output only.

Spell check result.

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

boolean

Indicates if the query was corrected by the spell checker.

correctedText

string

Correction output consisting of the corrected keyword string.