Class: Google::Apis::JobsV4::SearchJobsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/jobs_v4/classes.rb,
lib/google/apis/jobs_v4/representations.rb,
lib/google/apis/jobs_v4/representations.rb

Overview

The Request body of the SearchJobs call.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchJobsRequest

Returns a new instance of SearchJobsRequest.



2307
2308
2309
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2307

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#custom_ranking_info ⇒ Google::Apis::JobsV4::CustomRankingInfo

Custom ranking information for SearchJobsRequest. Corresponds to the JSON property customRankingInfo

Returns:



2114
2115
2116
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2114

def custom_ranking_info
  @custom_ranking_info
end

#disable_keyword_match ⇒ Boolean Also known as: disable_keyword_match?

This field is deprecated. Please use SearchJobsRequest.keyword_match_mode going forward. To migrate, disable_keyword_match set to false maps to KeywordMatchMode.KEYWORD_MATCH_ALL, and disable_keyword_match set to true maps to KeywordMatchMode.KEYWORD_MATCH_DISABLED. If SearchJobsRequest. keyword_match_mode is set, this field is ignored. Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Use Company. keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. Corresponds to the JSON property disableKeywordMatch

Returns:

  • (Boolean) 


2135
2136
2137
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2135

def disable_keyword_match
  @disable_keyword_match
end

#diversification_level ⇒ String

Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. Corresponds to the JSON property diversificationLevel

Returns:

  • (String) 


2146
2147
2148
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2146

def diversification_level
  @diversification_level
end

#enable_broadening ⇒ Boolean Also known as: enable_broadening?

Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. Corresponds to the JSON property enableBroadening

Returns:

  • (Boolean) 


2153
2154
2155
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2153

def enable_broadening
  @enable_broadening
end

#histogram_queries ⇒ Array<Google::Apis::JobsV4::HistogramQuery>

An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * count(string_histogram_facet): Count the number of matching entities, for each distinct attribute value. * count(numeric_histogram_facet, list of buckets): Count the number of matching entities within each bucket. A maximum of 200 histogram buckets are supported. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [ 1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job. company_display_name. * employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME". * company_size (DEPRECATED): histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_day: histogram by the Job.posting_publish_time in days. Must specify list of numeric buckets in spec. * publish_time_in_month: histogram by the Job. posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level, for example, "Entry Level". * country: histogram by the country code of jobs, for example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the " admin1 code, country", for example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code, for example, "en", "fr". * category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", " HEALTHCARE". * base_compensation_unit: histogram by the CompensationInfo. CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"].

  • numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute[" key1"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000) , bucket(10000, 100000), bucket(100000, MAX)]) * count( string_custom_attribute["some-string-custom-attribute"]) * count( numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, " negative"), bucket(0, MAX, "non-negative")]) Corresponds to the JSON property histogramQueries

Returns:



2214
2215
2216
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2214

def histogram_queries
  @histogram_queries
end

#job_query ⇒ Google::Apis::JobsV4::JobQuery

The query required to perform a search query. Corresponds to the JSON property jobQuery

Returns:



2219
2220
2221
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2219

def job_query
  @job_query
end

#job_view ⇒ String

The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_SMALL if no value is specified. Corresponds to the JSON property jobView

Returns:

  • (String) 


2225
2226
2227
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2225

def job_view
  @job_view
end

#keyword_match_mode ⇒ String

Controls what keyword match options to use. If both keyword_match_mode and disable_keyword_match are set, keyword_match_mode will take precedence. Defaults to KeywordMatchMode.KEYWORD_MATCH_ALL if no value is specified. Corresponds to the JSON property keywordMatchMode

Returns:

  • (String) 


2232
2233
2234
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2232

def keyword_match_mode
  @keyword_match_mode
end

#max_page_size ⇒ Fixnum

A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. Corresponds to the JSON property maxPageSize

Returns:

  • (Fixnum) 


2239
2240
2241
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2239

def max_page_size
  @max_page_size
end

#offset ⇒ Fixnum

An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). Corresponds to the JSON property offset

Returns:

  • (Fixnum) 


2250
2251
2252
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2250

def offset
  @offset
end

#order_by ⇒ String

The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * "posting_publish_time desc": By Job. posting_publish_time descending. * "posting_update_time desc": By Job. posting_update_time descending. * "title": By Job.title ascending. * "title desc": By Job.title descending. * "annualized_base_compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized_base_compensation desc": By job's CompensationInfo. annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * " annualized_total_compensation": By job's CompensationInfo. annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * " annualized_total_compensation desc": By job's CompensationInfo. annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * " custom_ranking desc": By the relevance score adjusted to the SearchJobsRequest.CustomRankingInfo.ranking_expression with weight factor assigned by SearchJobsRequest.CustomRankingInfo.importance_level in descending order. * Location sorting: Use the special syntax to order jobs by distance: " distance_from('Hawaii')": Order by distance from Hawaii. "distance_from(19. 89, 155.5)": Order by distance from a coordinate. "distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below. "distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below. The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level. Corresponds to the JSON property orderBy

Returns:

  • (String) 


2287
2288
2289
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2287

def order_by
  @order_by
end

#page_token ⇒ String

The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. Corresponds to the JSON property pageToken

Returns:

  • (String) 


2294
2295
2296
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2294

def page_token
  @page_token
end

#request_metadata ⇒ Google::Apis::JobsV4::RequestMetadata

Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. Corresponds to the JSON property requestMetadata

Returns:



2300
2301
2302
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2300

def request_metadata
  @request_metadata
end

#search_mode ⇒ String

Mode of a search. Defaults to SearchMode.JOB_SEARCH. Corresponds to the JSON property searchMode

Returns:

  • (String) 


2305
2306
2307
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2305

def search_mode
  @search_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2312

def update!(**args)
  @custom_ranking_info = args[:custom_ranking_info] if args.key?(:custom_ranking_info)
  @disable_keyword_match = args[:disable_keyword_match] if args.key?(:disable_keyword_match)
  @diversification_level = args[:diversification_level] if args.key?(:diversification_level)
  @enable_broadening = args[:enable_broadening] if args.key?(:enable_broadening)
  @histogram_queries = args[:histogram_queries] if args.key?(:histogram_queries)
  @job_query = args[:job_query] if args.key?(:job_query)
  @job_view = args[:job_view] if args.key?(:job_view)
  @keyword_match_mode = args[:keyword_match_mode] if args.key?(:keyword_match_mode)
  @max_page_size = args[:max_page_size] if args.key?(:max_page_size)
  @offset = args[:offset] if args.key?(:offset)
  @order_by = args[:order_by] if args.key?(:order_by)
  @page_token = args[:page_token] if args.key?(:page_token)
  @request_metadata = args[:request_metadata] if args.key?(:request_metadata)
  @search_mode = args[:search_mode] if args.key?(:search_mode)
end