chore: regens API reference docs (#889)
diff --git a/docs/dyn/jobs_v3.projects.jobs.html b/docs/dyn/jobs_v3.projects.jobs.html
index 6b5e7e8..aaa6b1f 100644
--- a/docs/dyn/jobs_v3.projects.jobs.html
+++ b/docs/dyn/jobs_v3.projects.jobs.html
@@ -75,10 +75,10 @@
<h1><a href="jobs_v3.html">Cloud Talent Solution API</a> . <a href="jobs_v3.projects.html">projects</a> . <a href="jobs_v3.projects.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a list of Jobs by filter.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new job.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -93,13 +93,13 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates specified job.</p>
<p class="toc_element">
- <code><a href="#search">search(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#search">search(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>
<p class="toc_element">
- <code><a href="#searchForAlert">searchForAlert(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>
<p class="toc_element">
<code><a href="#searchForAlert_next">searchForAlert_next(previous_request, previous_response)</a></code></p>
@@ -109,25 +109,21 @@
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="batchDelete">batchDelete(parent, body, x__xgafv=None)</code>
+ <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
<pre>Deletes a list of Jobs by filter.
Args:
- parent: string, Required.
-
-The resource name of the project under which the job is created.
+ parent: string, Required. The resource name of the project under which the job is created.
The format is "projects/{project_id}", for example,
"projects/api-test-project". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Input only.
#
# Batch delete jobs request.
- "filter": "A String", # Required.
- #
- # The filter string specifies the jobs to be deleted.
+ "filter": "A String", # Required. The filter string specifies the jobs to be deleted.
#
# Supported operator: =, AND
#
@@ -161,33 +157,27 @@
</div>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new job.
Typically, the job becomes searchable within 10 seconds, but it may take
up to 5 minutes.
Args:
- parent: string, Required.
-
-The resource name of the project under which the job is created.
+ parent: string, Required. The resource name of the project under which the job is created.
The format is "projects/{project_id}", for example,
"projects/api-test-project". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Input only.
#
# Create job request.
- "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required.
- #
- # The Job to be created.
+ "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be created.
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -218,38 +208,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -283,14 +290,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -298,21 +301,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -325,9 +322,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -347,9 +342,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -362,9 +355,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -379,9 +370,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -394,17 +383,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -417,9 +400,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -434,9 +415,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -444,9 +423,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -457,78 +434,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -543,20 +483,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -574,7 +514,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -657,20 +597,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -678,15 +605,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -703,14 +635,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -722,19 +650,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -747,9 +669,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -760,7 +680,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -777,9 +697,7 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
},
}
@@ -794,9 +712,7 @@
{ # A Job resource represents a job posting (also referred to as a "job listing"
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -827,38 +743,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -892,14 +825,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -907,21 +836,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -934,9 +857,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -956,9 +877,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -971,9 +890,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -988,9 +905,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -1003,17 +918,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -1026,9 +935,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -1043,9 +950,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -1053,9 +958,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -1066,78 +969,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -1152,20 +1018,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -1183,7 +1049,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -1266,20 +1132,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -1287,15 +1140,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -1312,14 +1170,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -1331,19 +1185,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -1356,9 +1204,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -1369,7 +1215,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -1386,9 +1232,7 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
}</pre>
</div>
@@ -1400,9 +1244,7 @@
up to 5 minutes.
Args:
- name: string, Required.
-
-The resource name of the job to be deleted.
+ name: string, Required. The resource name of the job to be deleted.
The format is "projects/{project_id}/jobs/{job_id}",
for example, "projects/api-test-project/jobs/1234". (required)
@@ -1432,9 +1274,7 @@
within the last 90 days.
Args:
- name: string, Required.
-
-The resource name of the job to retrieve.
+ name: string, Required. The resource name of the job to retrieve.
The format is "projects/{project_id}/jobs/{job_id}",
for example, "projects/api-test-project/jobs/1234". (required)
@@ -1449,9 +1289,7 @@
{ # A Job resource represents a job posting (also referred to as a "job listing"
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -1482,38 +1320,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -1547,14 +1402,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -1562,21 +1413,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -1589,9 +1434,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -1611,9 +1454,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -1626,9 +1467,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -1643,9 +1482,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -1658,17 +1495,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -1681,9 +1512,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -1698,9 +1527,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -1708,9 +1535,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -1721,78 +1546,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -1807,20 +1595,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -1838,7 +1626,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -1921,20 +1709,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -1942,15 +1717,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -1967,14 +1747,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -1986,19 +1762,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -2011,9 +1781,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -2024,7 +1792,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -2041,9 +1809,7 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
}</pre>
</div>
@@ -2052,35 +1818,25 @@
<pre>Lists jobs by filter.
Args:
- parent: string, Required.
-
-The resource name of the project under which the job is created.
+ parent: string, Required. The resource name of the project under which the job is created.
The format is "projects/{project_id}", for example,
"projects/api-test-project". (required)
- pageSize: integer, Optional.
-
-The maximum number of jobs to be returned per page of results.
+ pageSize: integer, Optional. The maximum number of jobs to be returned per page of results.
If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed
page size is 1000. Otherwise, the maximum allowed page size is 100.
-Default is 100 if empty or a number < 1 is specified.
- pageToken: string, Optional.
-
-The starting point of a query result.
+Default is 100 if empty or a number < 1 is specified.
+ pageToken: string, Optional. The starting point of a query result.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- jobView: string, Optional.
-
-The desired job attributes returned for jobs in the
+ jobView: string, Optional. The desired job attributes returned for jobs in the
search response. Defaults to JobView.JOB_VIEW_FULL if no value is
specified.
- filter: string, Required.
-
-The filter string specifies the jobs to be enumerated.
+ filter: string, Required. The filter string specifies the jobs to be enumerated.
Supported operator: =, AND
@@ -2109,9 +1865,7 @@
{ # A Job resource represents a job posting (also referred to as a "job listing"
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -2142,38 +1896,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -2207,14 +1978,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -2222,21 +1989,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -2249,9 +2010,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -2271,9 +2030,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -2286,9 +2043,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -2303,9 +2058,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -2318,17 +2071,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -2341,9 +2088,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -2358,9 +2103,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -2368,9 +2111,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -2381,78 +2122,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -2467,20 +2171,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -2498,7 +2202,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -2581,20 +2285,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -2602,15 +2293,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -2627,14 +2323,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -2646,19 +2338,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -2671,9 +2357,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -2684,7 +2368,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -2701,9 +2385,7 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
},
],
"metadata": { # Output only. # Additional information for the API invocation, such as the request
@@ -2731,7 +2413,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Updates specified job.
Typically, updated contents become visible in search results within 10
@@ -2748,20 +2430,16 @@
Use of this field in job queries and API calls is preferred over the use of
requisition_id since this value is unique. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Input only.
#
# Update job request.
- "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required.
- #
- # The Job to be updated.
+ "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be updated.
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -2792,38 +2470,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -2857,14 +2552,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -2872,21 +2563,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -2899,9 +2584,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -2921,9 +2604,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -2936,9 +2617,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -2953,9 +2632,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -2968,17 +2645,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -2991,9 +2662,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -3008,9 +2677,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -3018,9 +2685,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -3031,78 +2696,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -3117,20 +2745,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -3148,7 +2776,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -3231,20 +2859,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -3252,15 +2867,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -3277,14 +2897,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -3296,19 +2912,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -3321,9 +2931,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -3334,7 +2942,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -3351,9 +2959,7 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
},
"updateMask": "A String", # Optional but strongly recommended to be provided for the best service
# experience.
@@ -3376,9 +2982,7 @@
{ # A Job resource represents a job posting (also referred to as a "job listing"
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -3409,38 +3013,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -3474,14 +3095,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -3489,21 +3106,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -3516,9 +3127,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -3538,9 +3147,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -3553,9 +3160,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -3570,9 +3175,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -3585,17 +3188,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -3608,9 +3205,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -3625,9 +3220,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -3635,9 +3228,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -3648,78 +3239,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -3734,20 +3288,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -3765,7 +3319,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -3848,20 +3402,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -3869,15 +3410,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -3894,14 +3440,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -3913,19 +3455,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -3938,9 +3474,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -3951,7 +3485,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -3968,14 +3502,12 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
}</pre>
</div>
<div class="method">
- <code class="details" id="search">search(parent, body, x__xgafv=None)</code>
+ <code class="details" id="search">search(parent, body=None, x__xgafv=None)</code>
<pre>Searches for jobs using the provided SearchJobsRequest.
This call constrains the visibility of jobs
@@ -3983,53 +3515,47 @@
permission to search against.
Args:
- parent: string, Required.
-
-The resource name of the project to search within.
+ parent: string, Required. The resource name of the project to search within.
The format is "projects/{project_id}", for example,
"projects/api-test-project". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Input only.
#
# The Request body of the `SearchJobs` call.
- "orderBy": "A String", # Optional.
- #
- # The criteria determining how search results are sorted. Default is
+ "orderBy": "A String", # Optional. 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
+ # * `"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
+ # * `"posting_publish_time desc"`: By Job.posting_publish_time
# descending.
- # * "posting`_`update`_`time desc": By Job.posting_update_time
+ # * `"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
+ # * `"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
+ # * `"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
+ # * `"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
+ # * `"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.
- "diversificationLevel": "A String", # Optional.
- #
- # Controls whether highly similar jobs are returned next to each other in
+ "diversificationLevel": "A String", # Optional. 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
@@ -4038,9 +3564,383 @@
#
# Defaults to DiversificationLevel.SIMPLE if no value
# is specified.
- "disableKeywordMatch": True or False, # Optional.
+ "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.
+ # Broadened queries append results to the end of the matching results
+ # list.
#
- # Controls whether to disable exact keyword match on Job.job_title,
+ # Defaults to false.
+ "jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.
+ #
+ # The query required to perform a search query.
+ "disableSpellCheck": True or False, # Optional. 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.
+ "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
+ # Job.custom_attributes marked as `filterable`.
+ #
+ # The syntax for this expression is a subset of SQL syntax.
+ #
+ # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the
+ # left of the operator is a custom field key and the right of the operator
+ # is a number or a quoted string. You must escape backslash (\\) and
+ # quote (\") characters.
+ #
+ # Supported functions are `LOWER([field_name])` to
+ # perform a case insensitive match and `EMPTY([field_name])` to filter on the
+ # existence of a key.
+ #
+ # 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:
+ # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
+ # driving_years > 10`
+ "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
+ # search against, such as EmploymentType.FULL_TIME.
+ #
+ # If a value is not 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.
+ "A String",
+ ],
+ "queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to
+ # better interpret the query.
+ #
+ # 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](https://tools.ietf.org/html/bcp47).
+ "query": "A String", # Optional. The query string that matches against the job title, description, and
+ # location fields.
+ #
+ # The maximum number of allowed characters is 255.
+ "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched
+ # against.
+ "endTime": "A String", # End of the period.
+ "startTime": "A String", # Begin of the period.
+ },
+ "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for
+ # example, driving or public transit). Note: This only works with COMMUTE
+ # MODE. When specified, [JobQuery.location_filters] is
+ # ignored.
+ #
+ # Currently we don't support sorting by commute time.
+ #
+ # Parameters needed for commute search.
+ "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
+ "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as
+ # google.type.TimeOfDay in local time zone.
+ #
+ # Currently traffic model is restricted to hour level resolution.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
+ "hours": 42, # 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.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # 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.
+ },
+ "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the
+ # commute time.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS
+ # coordinates) might also be returned. For city and coarser level addresses,
+ # text matching is used. If this field is set to false or is not specified,
+ # only jobs that include precise addresses are returned by Commute
+ # Search.
+ #
+ # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not
+ # able to calculate accurate commute times to jobs with city level and
+ # coarser address information. Jobs with imprecise addresses will return a
+ # `travel_duration` time of 0 regardless of distance from the job seeker.
+ "travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
+ # (one hour). Format is `123s`.
+ "commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.
+ },
+ "jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.
+ # See Category for more information.
+ #
+ # If a value is not specified, jobs from any category are searched against.
+ #
+ # If multiple values are specified, jobs from any of the specified
+ # categories are searched against.
+ "A String",
+ ],
+ "languageCodes": [ # Optional. 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](https://tools.ietf.org/html/bcp47).
+ #
+ # At most 10 language code filters are allowed.
+ "A String",
+ ],
+ "companyNames": [ # Optional. 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/{project_id}/companies/{company_id}", for example,
+ # "projects/api-test-project/companies/foo".
+ #
+ # At most 20 company filters are allowed.
+ "A String",
+ ],
+ "companyDisplayNames": [ # Optional. This filter specifies the exact company display
+ # name of the jobs to search against.
+ #
+ # 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.
+ "A String",
+ ],
+ "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
+ # search against. See LocationFilter for more information.
+ #
+ # 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
+ # LocationFilter.distance_in_miles parameter, the maximum provided
+ # distance is used for all locations.
+ #
+ # At most 5 location filters are allowed.
+ { # Input only.
+ #
+ # Geographic region of the search.
+ "regionCode": "A String", # Optional. 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 if all the jobs to search against are from a same region,
+ # or jobs are world-wide, but the job seeker is from a specific region.
+ #
+ # See http://cldr.unicode.org/ and
+ # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
+ # for details. Example: "CH" for Switzerland.
+ "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to
+ # search. This field's ignored if `address` is provided.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
+ # identified as a city or smaller. When the location being searched for is a
+ # state or larger, this field is ignored.
+ "telecommutePreference": "A String", # Optional. Allows the client to return jobs without a
+ # set location, specifically, telecommuting jobs (telecommuting is considered
+ # by the service as a special location.
+ # Job.posting_region indicates if a job permits telecommuting.
+ # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,
+ # telecommuting jobs are searched, and address and lat_lng are
+ # ignored. If not set or set to
+ # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not
+ # searched.
+ #
+ # 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.
+ "address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
+ },
+ ],
+ "compensationFilter": { # Input only. # Optional. This search filter is applied only to
+ # Job.compensation_info. For example, if the filter is specified
+ # as "Hourly job with per-hour compensation > $15", only jobs meeting
+ # these criteria are searched. If a filter isn't defined, all open jobs
+ # are searched.
+ #
+ # Filter on job compensation type and amount.
+ "units": [ # Required. Specify desired `base compensation entry's`
+ # CompensationInfo.CompensationUnit.
+ "A String",
+ ],
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
+ # to zero and the currency code is set to match the
+ # currency code of max_compensation.
+ "nanos": 42, # Number of nano (10^-9) units of the amount.
+ # The value must be between -999,999,999 and +999,999,999 inclusive.
+ # If `units` is positive, `nanos` must be positive or zero.
+ # If `units` is zero, `nanos` can be positive, zero, or negative.
+ # If `units` is negative, `nanos` must be negative or zero.
+ # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
+ },
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
+ # to a maximal compensation value and the currency code is set to
+ # match the currency code of
+ # min_compensation.
+ "nanos": 42, # Number of nano (10^-9) units of the amount.
+ # The value must be between -999,999,999 and +999,999,999 inclusive.
+ # If `units` is positive, `nanos` must be positive or zero.
+ # If `units` is zero, `nanos` can be positive, zero, or negative.
+ # If `units` is negative, `nanos` must be negative or zero.
+ # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
+ },
+ },
+ "type": "A String", # Required. Type of filter.
+ "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are
+ # included.
+ },
+ },
+ "pageSize": 42, # Optional. 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.
+ "histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.
+ #
+ # Histogram facets to be specified in SearchJobsRequest.
+ "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,
+ # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
+ "A String",
+ ],
+ "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.
+ # Duplicate values of CustomAttributeHistogramRequest.key are not
+ # allowed.
+ { # Custom attributes histogram request. An error is thrown if neither
+ # string_value_histogram or long_value_histogram_bucketing_option has
+ # been defined.
+ "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for
+ # each key as a string.
+ "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's
+ # filterable long custom field values, or min/max value requirements.
+ #
+ # Use this field to specify bucketing option for the histogram search response.
+ "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
+ # ascending order. For example, if [5, 10, 15] are provided, four buckets are
+ # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
+ # [buckets_bound is supported.
+ 3.14,
+ ],
+ "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
+ # value of the numeric field.
+ },
+ "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified
+ # without `long_value_histogram_bucketing_option`, histogram on string values
+ # of the given `key` is triggered, otherwise histogram is performed on long
+ # values.
+ },
+ ],
+ "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.
+ # Duplicate values of CompensationHistogramRequest.type are not allowed.
+ { # Input only.
+ #
+ # Compensation based histogram request.
+ "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.
+ #
+ # Use this field to specify bucketing option for the histogram search response.
+ "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
+ # ascending order. For example, if [5, 10, 15] are provided, four buckets are
+ # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
+ # [buckets_bound is supported.
+ 3.14,
+ ],
+ "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
+ # value of the numeric field.
+ },
+ "type": "A String", # Required. Type of the request, representing which field the histogramming should be
+ # performed over. A single request can only specify one histogram of each
+ # `CompensationHistogramRequestType`.
+ },
+ ],
+ },
+ "searchMode": "A String", # Optional. Mode of a search.
+ #
+ # Defaults to SearchMode.JOB_SEARCH.
+ "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the
+ # search quality of the service. The identifiers (such as `user_id`) are
+ # provided by users, and must be unique and consistent.
+ #
+ # Meta information related to the job searcher or entity
+ # conducting the job search. This information is used to improve the
+ # performance of the service.
+ "userId": "A String", # Required. A unique user identification string, as determined by the client.
+ # To have the strongest positive impact on search quality
+ # make sure the client-level is unique.
+ # Obfuscate this field for privacy concerns before
+ # providing it to the service.
+ #
+ # If this field is not available for some reason, send "UNKNOWN". Note
+ # that any improvements to the model for a particular tenant
+ # site, rely on this field being set correctly to a unique user_id.
+ #
+ # The maximum number of allowed characters is 255.
+ "sessionId": "A String", # Required. A unique session identification string. A session is defined as the
+ # duration of an end user's interaction with the service over a certain
+ # period.
+ # Obfuscate this field for privacy concerns before
+ # providing it to the service.
+ #
+ # If this field is not available for some reason, send "UNKNOWN". Note
+ # that any improvements to the model for a particular tenant
+ # site, rely on this field being set correctly to some unique session_id.
+ #
+ # The maximum number of allowed characters is 255.
+ "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the
+ # service.
+ # other entity conducting the job search. Providing this information improves
+ # the quality of the search results across devices.
+ "deviceType": "A String", # Optional. Type of the device.
+ "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that
+ # distinguishes the device from other devices.
+ },
+ "domain": "A String", # Required. The client-defined scope or source of the service call, which typically
+ # is the domain on
+ # which the service has been implemented and is currently being run.
+ #
+ # For example, if the service is being run by client <em>Foo, Inc.</em>, on
+ # job board www.foo.com and career site www.bar.com, then this field is
+ # set to "foo.com" for use on the job board, and "bar.com" for use on the
+ # career site.
+ #
+ # If this field isn't available for some reason, send "UNKNOWN".
+ # Any improvements to the model for a particular tenant site rely on this
+ # field being set correctly to a domain.
+ #
+ # The maximum number of allowed characters is 255.
+ },
+ "pageToken": "A String", # Optional. 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.
+ "disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,
# Job.description, Job.company_display_name, Job.locations,
# Job.qualifications. When disable keyword match is turned off, a
# keyword match returns jobs that do not match given category filters when
@@ -4059,482 +3959,7 @@
# keyword match improves recall of subsequent search requests.
#
# Defaults to false.
- "jobQuery": { # Input only. # Optional.
- #
- # Query used to search against jobs, such as keyword, location filters, etc.
- #
- # The query required to perform a search query.
- "disableSpellCheck": True or False, # Optional.
- #
- # 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.
- "customAttributeFilter": "A String", # Optional.
- #
- # This filter specifies a structured syntax to match against the
- # Job.custom_attributes marked as `filterable`.
- #
- # The syntax for this expression is a subset of SQL syntax.
- #
- # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the
- # left of the operator is a custom field key and the right of the operator
- # is a number or a quoted string. You must escape backslash (\\) and
- # quote (\") characters.
- #
- # Supported functions are `LOWER([field_name])` to
- # perform a case insensitive match and `EMPTY([field_name])` to filter on the
- # existence of a key.
- #
- # 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 < 3000 bytes in length.
- #
- # Sample Query:
- # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
- # driving_years > 10`
- "employmentTypes": [ # Optional.
- #
- # The employment type filter specifies the employment type of jobs to
- # search against, such as EmploymentType.FULL_TIME.
- #
- # If a value is not 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.
- "A String",
- ],
- "query": "A String", # Optional.
- #
- # The query string that matches against the job title, description, and
- # location fields.
- #
- # The maximum number of allowed characters is 255.
- "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional.
- #
- # Jobs published within a range specified by this filter are searched
- # against.
- "endTime": "A String", # End of the period.
- "startTime": "A String", # Begin of the period.
- },
- "commuteFilter": { # Input only. # Optional.
- #
- # Allows filtering jobs by commute time with different travel methods (for
- # example, driving or public transit). Note: This only works with COMMUTE
- # MODE. When specified, [JobQuery.location_filters] is
- # ignored.
- #
- # Currently we don't support sorting by commute time.
- #
- # Parameters needed for commute search.
- "roadTraffic": "A String", # Optional.
- #
- # Specifies the traffic density to use when calculating commute time.
- "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional.
- #
- # The departure time used to calculate traffic impact, represented as
- # google.type.TimeOfDay in local time zone.
- #
- # Currently traffic model is restricted to hour level resolution.
- # or are specified elsewhere. An API may choose to allow leap seconds. Related
- # types are google.type.Date and `google.protobuf.Timestamp`.
- "seconds": 42, # 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.
- "hours": 42, # 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": 42, # Minutes of hour of day. Must be from 0 to 59.
- "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- },
- "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required.
- #
- # The latitude and longitude of the location from which to calculate the
- # commute time.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "allowImpreciseAddresses": True or False, # Optional.
- # If true, jobs without "precise" addresses (street level addresses or GPS
- # coordinates) might also be returned. For city and coarser level addresses,
- # text matching is used. If this field is set to false or is not specified,
- # only jobs that include precise addresses are returned by Commute
- # Search.
- #
- # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not
- # able to calculate accurate commute times to jobs with city level and
- # coarser address information. Jobs with imprecise addresses will return a
- # `travel_duration` time of 0 regardless of distance from the job seeker.
- "travelDuration": "A String", # Required.
- #
- # The maximum travel time in seconds. The maximum allowed value is `3600s`
- # (one hour). Format is `123s`.
- "commuteMethod": "A String", # Required.
- #
- # The method of transportation for which to calculate the commute time.
- },
- "jobCategories": [ # Optional.
- #
- # The category filter specifies the categories of jobs to search against.
- # See Category for more information.
- #
- # If a value is not specified, jobs from any category are searched against.
- #
- # If multiple values are specified, jobs from any of the specified
- # categories are searched against.
- "A String",
- ],
- "languageCodes": [ # Optional.
- #
- # 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](https://tools.ietf.org/html/bcp47).
- #
- # At most 10 language code filters are allowed.
- "A String",
- ],
- "companyNames": [ # Optional.
- #
- # 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/{project_id}/companies/{company_id}", for example,
- # "projects/api-test-project/companies/foo".
- #
- # At most 20 company filters are allowed.
- "A String",
- ],
- "companyDisplayNames": [ # Optional.
- #
- # This filter specifies the exact company display
- # name of the jobs to search against.
- #
- # 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.
- "A String",
- ],
- "locationFilters": [ # Optional.
- #
- # The location filter specifies geo-regions containing the jobs to
- # search against. See LocationFilter for more information.
- #
- # 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
- # LocationFilter.distance_in_miles parameter, the maximum provided
- # distance is used for all locations.
- #
- # At most 5 location filters are allowed.
- { # Input only.
- #
- # Geographic region of the search.
- "regionCode": "A String", # Optional.
- #
- # 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 if all the jobs to search against are from a same region,
- # or jobs are world-wide, but the job seeker is from a specific region.
- #
- # See http://cldr.unicode.org/ and
- # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
- # for details. Example: "CH" for Switzerland.
- "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional.
- #
- # The latitude and longitude of the geographic center from which to
- # search. This field's ignored if `address` is provided.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "distanceInMiles": 3.14, # Optional.
- #
- #
- # The distance_in_miles is applied when the location being searched for is
- # identified as a city or smaller. When the location being searched for is a
- # state or larger, this field is ignored.
- "telecommutePreference": "A String", # Optional.
- #
- # Allows the client to return jobs without a
- # set location, specifically, telecommuting jobs (telecomuting is considered
- # by the service as a special location.
- # Job.posting_region indicates if a job permits telecommuting.
- # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,
- # telecommuting jobs are searched, and address and lat_lng are
- # ignored. If not set or set to
- # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not
- # searched.
- #
- # 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.
- "address": "A String", # Optional.
- #
- # The address name, such as "Mountain View" or "Bay Area".
- },
- ],
- "compensationFilter": { # Input only. # Optional.
- #
- # This search filter is applied only to
- # Job.compensation_info. For example, if the filter is specified
- # as "Hourly job with per-hour compensation > $15", only jobs meeting
- # these criteria are searched. If a filter isn't defined, all open jobs
- # are searched.
- #
- # Filter on job compensation type and amount.
- "units": [ # Required.
- #
- # Specify desired `base compensation entry's`
- # CompensationInfo.CompensationUnit.
- "A String",
- ],
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
- # to zero and the currency code is set to match the
- # currency code of max_compensation.
- "nanos": 42, # Number of nano (10^-9) units of the amount.
- # The value must be between -999,999,999 and +999,999,999 inclusive.
- # If `units` is positive, `nanos` must be positive or zero.
- # If `units` is zero, `nanos` can be positive, zero, or negative.
- # If `units` is negative, `nanos` must be negative or zero.
- # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
- },
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
- # to a maximal compensation value and the currency code is set to
- # match the currency code of
- # min_compensation.
- "nanos": 42, # Number of nano (10^-9) units of the amount.
- # The value must be between -999,999,999 and +999,999,999 inclusive.
- # If `units` is positive, `nanos` must be positive or zero.
- # If `units` is zero, `nanos` can be positive, zero, or negative.
- # If `units` is negative, `nanos` must be negative or zero.
- # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
- },
- },
- "type": "A String", # Required.
- #
- # Type of filter.
- "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional.
- #
- # If set to true, jobs with unspecified compensation range fields are
- # included.
- },
- },
- "pageSize": 42, # Optional.
- #
- # 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.
- "histogramFacets": { # Input only. # Optional.
- #
- # Histogram requests for jobs matching JobQuery.
- #
- # Histogram facets to be specified in SearchJobsRequest.
- "simpleHistogramFacets": [ # Optional.
- #
- # Specifies the simple type of histogram facets, for example,
- # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
- "A String",
- ],
- "customAttributeHistogramFacets": [ # Optional.
- #
- # Specifies the custom attributes histogram requests.
- # Duplicate values of CustomAttributeHistogramRequest.key are not
- # allowed.
- { # Custom attributes histogram request. An error is thrown if neither
- # string_value_histogram or long_value_histogram_bucketing_option has
- # been defined.
- "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for
- # each key as a string.
- "longValueHistogramBucketingOption": { # Input only. # Optional.
- #
- # Specifies buckets used to perform a range histogram on Job's
- # filterable long custom field values, or min/max value requirements.
- #
- # Use this field to specify bucketing option for the histogram search response.
- "bucketBounds": [ # Required.
- #
- # Two adjacent values form a histogram bucket. Values should be in
- # ascending order. For example, if [5, 10, 15] are provided, four buckets are
- # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
- # [buckets_bound is supported.
- 3.14,
- ],
- "requiresMinMax": True or False, # Optional.
- #
- # If set to true, the histogram result includes minimum/maximum
- # value of the numeric field.
- },
- "key": "A String", # Required.
- #
- # Specifies the custom field key to perform a histogram on. If specified
- # without `long_value_histogram_bucketing_option`, histogram on string values
- # of the given `key` is triggered, otherwise histogram is performed on long
- # values.
- },
- ],
- "compensationHistogramFacets": [ # Optional.
- #
- # Specifies compensation field-based histogram requests.
- # Duplicate values of CompensationHistogramRequest.type are not allowed.
- { # Input only.
- #
- # Compensation based histogram request.
- "bucketingOption": { # Input only. # Required.
- #
- # Numeric histogram options, like buckets, whether include min or max value.
- #
- # Use this field to specify bucketing option for the histogram search response.
- "bucketBounds": [ # Required.
- #
- # Two adjacent values form a histogram bucket. Values should be in
- # ascending order. For example, if [5, 10, 15] are provided, four buckets are
- # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
- # [buckets_bound is supported.
- 3.14,
- ],
- "requiresMinMax": True or False, # Optional.
- #
- # If set to true, the histogram result includes minimum/maximum
- # value of the numeric field.
- },
- "type": "A String", # Required.
- #
- # Type of the request, representing which field the histogramming should be
- # performed over. A single request can only specify one histogram of each
- # `CompensationHistogramRequestType`.
- },
- ],
- },
- "enableBroadening": True or False, # Optional.
- #
- # 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.
- "searchMode": "A String", # Optional.
- #
- # Mode of a search.
- #
- # Defaults to SearchMode.JOB_SEARCH.
- "pageToken": "A String", # Optional.
- #
- # 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.
- "requestMetadata": { # Input only. # Required.
- #
- # The meta information collected about the job searcher, used to improve the
- # search quality of the service.. The identifiers, (such as `user_id`) are
- # provided by users, and must be unique and consistent.
- #
- # Meta information related to the job searcher or entity
- # conducting the job search. This information is used to improve the
- # performance of the service.
- "userId": "A String", # Required.
- #
- # A unique user identification string, as determined by the client.
- # To have the strongest positive impact on search quality
- # make sure the client-level is unique.
- # Obfuscate this field for privacy concerns before
- # providing it to the service.
- #
- # If this field is not available for some reason, send "UNKNOWN". Note
- # that any improvements to the model for a particular tenant
- # site, rely on this field being set correctly to a unique user_id.
- #
- # The maximum number of allowed characters is 255.
- "sessionId": "A String", # Required.
- #
- # A unique session identification string. A session is defined as the
- # duration of an end user's interaction with the service over a certain
- # period.
- # Obfuscate this field for privacy concerns before
- # providing it to the service.
- #
- # If this field is not available for some reason, send "UNKNOWN". Note
- # that any improvements to the model for a particular tenant
- # site, rely on this field being set correctly to some unique session_id.
- #
- # The maximum number of allowed characters is 255.
- "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional.
- #
- # The type of device used by the job seeker at the time of the call to the
- # service.
- # other entity conducting the job search. Providing this information improves
- # the quality of the search results across devices.
- "deviceType": "A String", # Optional.
- #
- # Type of the device.
- "id": "A String", # Optional.
- #
- # A device-specific ID. The ID must be a unique identifier that
- # distinguishes the device from other devices.
- },
- "domain": "A String", # Required.
- #
- # The client-defined scope or source of the service call, which typically
- # is the domain on
- # which the service has been implemented and is currently being run.
- #
- # For example, if the service is being run by client <em>Foo, Inc.</em>, on
- # job board www.foo.com and career site www.bar.com, then this field is
- # set to "foo.com" for use on the job board, and "bar.com" for use on the
- # career site.
- #
- # If this field isn't available for some reason, send "UNKNOWN".
- # Any improvements to the model for a particular tenant site rely on this
- # field being set correctly to a domain.
- #
- # The maximum number of allowed characters is 255.
- },
- "requirePreciseResultSize": True or False, # Optional.
- #
- # Controls if the search job request requires the return of a precise
+ "requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise
# count of the first 300 results. Setting this to `true` ensures
# consistency in the number of results per page. Best practice is to set this
# value to true if a client allows users to jump directly to a
@@ -4543,16 +3968,14 @@
# Enabling this flag may adversely impact performance.
#
# Defaults to false.
- "jobView": "A String", # Optional.
- #
- # The desired job attributes returned for jobs in the
+ "jobView": "A String", # Optional. The desired job attributes returned for jobs in the
# search response. Defaults to JobView.SMALL if no value is specified.
- "offset": 42, # Optional.
- #
- # An integer that specifies the current offset (that is, starting result
+ "offset": 42, # Optional. 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
@@ -4592,9 +4015,7 @@
"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -4625,38 +4046,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -4690,14 +4128,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -4705,21 +4139,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -4732,9 +4160,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -4754,9 +4180,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -4769,9 +4193,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -4786,9 +4208,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -4801,17 +4221,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -4824,9 +4238,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -4841,9 +4253,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -4851,9 +4261,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -4864,78 +4272,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -4950,20 +4321,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -4981,7 +4352,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -5064,20 +4435,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -5085,15 +4443,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -5110,14 +4473,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -5129,19 +4488,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -5154,9 +4507,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -5167,7 +4518,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -5184,9 +4535,7 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
},
"commuteInfo": { # Output only. # Commute information which is generated based on specified
# CommuteFilter.
@@ -5199,20 +4548,20 @@
"jobLocation": { # Output only. # Location used as the destination in the commute calculation.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -5230,7 +4579,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -5421,20 +4770,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -5452,7 +4801,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -5545,7 +4894,7 @@
</div>
<div class="method">
- <code class="details" id="searchForAlert">searchForAlert(parent, body, x__xgafv=None)</code>
+ <code class="details" id="searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</code>
<pre>Searches for jobs using the provided SearchJobsRequest.
This API call is intended for the use case of targeting passive job
@@ -5558,53 +4907,47 @@
permission to search against.
Args:
- parent: string, Required.
-
-The resource name of the project to search within.
+ parent: string, Required. The resource name of the project to search within.
The format is "projects/{project_id}", for example,
"projects/api-test-project". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Input only.
#
# The Request body of the `SearchJobs` call.
- "orderBy": "A String", # Optional.
- #
- # The criteria determining how search results are sorted. Default is
+ "orderBy": "A String", # Optional. 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
+ # * `"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
+ # * `"posting_publish_time desc"`: By Job.posting_publish_time
# descending.
- # * "posting`_`update`_`time desc": By Job.posting_update_time
+ # * `"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
+ # * `"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
+ # * `"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
+ # * `"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
+ # * `"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.
- "diversificationLevel": "A String", # Optional.
- #
- # Controls whether highly similar jobs are returned next to each other in
+ "diversificationLevel": "A String", # Optional. 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
@@ -5613,9 +4956,383 @@
#
# Defaults to DiversificationLevel.SIMPLE if no value
# is specified.
- "disableKeywordMatch": True or False, # Optional.
+ "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.
+ # Broadened queries append results to the end of the matching results
+ # list.
#
- # Controls whether to disable exact keyword match on Job.job_title,
+ # Defaults to false.
+ "jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.
+ #
+ # The query required to perform a search query.
+ "disableSpellCheck": True or False, # Optional. 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.
+ "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
+ # Job.custom_attributes marked as `filterable`.
+ #
+ # The syntax for this expression is a subset of SQL syntax.
+ #
+ # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the
+ # left of the operator is a custom field key and the right of the operator
+ # is a number or a quoted string. You must escape backslash (\\) and
+ # quote (\") characters.
+ #
+ # Supported functions are `LOWER([field_name])` to
+ # perform a case insensitive match and `EMPTY([field_name])` to filter on the
+ # existence of a key.
+ #
+ # 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:
+ # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
+ # driving_years > 10`
+ "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
+ # search against, such as EmploymentType.FULL_TIME.
+ #
+ # If a value is not 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.
+ "A String",
+ ],
+ "queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to
+ # better interpret the query.
+ #
+ # 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](https://tools.ietf.org/html/bcp47).
+ "query": "A String", # Optional. The query string that matches against the job title, description, and
+ # location fields.
+ #
+ # The maximum number of allowed characters is 255.
+ "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched
+ # against.
+ "endTime": "A String", # End of the period.
+ "startTime": "A String", # Begin of the period.
+ },
+ "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for
+ # example, driving or public transit). Note: This only works with COMMUTE
+ # MODE. When specified, [JobQuery.location_filters] is
+ # ignored.
+ #
+ # Currently we don't support sorting by commute time.
+ #
+ # Parameters needed for commute search.
+ "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
+ "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as
+ # google.type.TimeOfDay in local time zone.
+ #
+ # Currently traffic model is restricted to hour level resolution.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
+ "hours": 42, # 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.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # 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.
+ },
+ "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the
+ # commute time.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS
+ # coordinates) might also be returned. For city and coarser level addresses,
+ # text matching is used. If this field is set to false or is not specified,
+ # only jobs that include precise addresses are returned by Commute
+ # Search.
+ #
+ # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not
+ # able to calculate accurate commute times to jobs with city level and
+ # coarser address information. Jobs with imprecise addresses will return a
+ # `travel_duration` time of 0 regardless of distance from the job seeker.
+ "travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
+ # (one hour). Format is `123s`.
+ "commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.
+ },
+ "jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.
+ # See Category for more information.
+ #
+ # If a value is not specified, jobs from any category are searched against.
+ #
+ # If multiple values are specified, jobs from any of the specified
+ # categories are searched against.
+ "A String",
+ ],
+ "languageCodes": [ # Optional. 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](https://tools.ietf.org/html/bcp47).
+ #
+ # At most 10 language code filters are allowed.
+ "A String",
+ ],
+ "companyNames": [ # Optional. 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/{project_id}/companies/{company_id}", for example,
+ # "projects/api-test-project/companies/foo".
+ #
+ # At most 20 company filters are allowed.
+ "A String",
+ ],
+ "companyDisplayNames": [ # Optional. This filter specifies the exact company display
+ # name of the jobs to search against.
+ #
+ # 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.
+ "A String",
+ ],
+ "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
+ # search against. See LocationFilter for more information.
+ #
+ # 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
+ # LocationFilter.distance_in_miles parameter, the maximum provided
+ # distance is used for all locations.
+ #
+ # At most 5 location filters are allowed.
+ { # Input only.
+ #
+ # Geographic region of the search.
+ "regionCode": "A String", # Optional. 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 if all the jobs to search against are from a same region,
+ # or jobs are world-wide, but the job seeker is from a specific region.
+ #
+ # See http://cldr.unicode.org/ and
+ # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
+ # for details. Example: "CH" for Switzerland.
+ "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to
+ # search. This field's ignored if `address` is provided.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
+ # identified as a city or smaller. When the location being searched for is a
+ # state or larger, this field is ignored.
+ "telecommutePreference": "A String", # Optional. Allows the client to return jobs without a
+ # set location, specifically, telecommuting jobs (telecommuting is considered
+ # by the service as a special location.
+ # Job.posting_region indicates if a job permits telecommuting.
+ # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,
+ # telecommuting jobs are searched, and address and lat_lng are
+ # ignored. If not set or set to
+ # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not
+ # searched.
+ #
+ # 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.
+ "address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
+ },
+ ],
+ "compensationFilter": { # Input only. # Optional. This search filter is applied only to
+ # Job.compensation_info. For example, if the filter is specified
+ # as "Hourly job with per-hour compensation > $15", only jobs meeting
+ # these criteria are searched. If a filter isn't defined, all open jobs
+ # are searched.
+ #
+ # Filter on job compensation type and amount.
+ "units": [ # Required. Specify desired `base compensation entry's`
+ # CompensationInfo.CompensationUnit.
+ "A String",
+ ],
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
+ # to zero and the currency code is set to match the
+ # currency code of max_compensation.
+ "nanos": 42, # Number of nano (10^-9) units of the amount.
+ # The value must be between -999,999,999 and +999,999,999 inclusive.
+ # If `units` is positive, `nanos` must be positive or zero.
+ # If `units` is zero, `nanos` can be positive, zero, or negative.
+ # If `units` is negative, `nanos` must be negative or zero.
+ # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
+ },
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
+ # to a maximal compensation value and the currency code is set to
+ # match the currency code of
+ # min_compensation.
+ "nanos": 42, # Number of nano (10^-9) units of the amount.
+ # The value must be between -999,999,999 and +999,999,999 inclusive.
+ # If `units` is positive, `nanos` must be positive or zero.
+ # If `units` is zero, `nanos` can be positive, zero, or negative.
+ # If `units` is negative, `nanos` must be negative or zero.
+ # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
+ },
+ },
+ "type": "A String", # Required. Type of filter.
+ "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are
+ # included.
+ },
+ },
+ "pageSize": 42, # Optional. 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.
+ "histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.
+ #
+ # Histogram facets to be specified in SearchJobsRequest.
+ "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,
+ # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
+ "A String",
+ ],
+ "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.
+ # Duplicate values of CustomAttributeHistogramRequest.key are not
+ # allowed.
+ { # Custom attributes histogram request. An error is thrown if neither
+ # string_value_histogram or long_value_histogram_bucketing_option has
+ # been defined.
+ "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for
+ # each key as a string.
+ "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's
+ # filterable long custom field values, or min/max value requirements.
+ #
+ # Use this field to specify bucketing option for the histogram search response.
+ "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
+ # ascending order. For example, if [5, 10, 15] are provided, four buckets are
+ # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
+ # [buckets_bound is supported.
+ 3.14,
+ ],
+ "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
+ # value of the numeric field.
+ },
+ "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified
+ # without `long_value_histogram_bucketing_option`, histogram on string values
+ # of the given `key` is triggered, otherwise histogram is performed on long
+ # values.
+ },
+ ],
+ "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.
+ # Duplicate values of CompensationHistogramRequest.type are not allowed.
+ { # Input only.
+ #
+ # Compensation based histogram request.
+ "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.
+ #
+ # Use this field to specify bucketing option for the histogram search response.
+ "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
+ # ascending order. For example, if [5, 10, 15] are provided, four buckets are
+ # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
+ # [buckets_bound is supported.
+ 3.14,
+ ],
+ "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
+ # value of the numeric field.
+ },
+ "type": "A String", # Required. Type of the request, representing which field the histogramming should be
+ # performed over. A single request can only specify one histogram of each
+ # `CompensationHistogramRequestType`.
+ },
+ ],
+ },
+ "searchMode": "A String", # Optional. Mode of a search.
+ #
+ # Defaults to SearchMode.JOB_SEARCH.
+ "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the
+ # search quality of the service. The identifiers (such as `user_id`) are
+ # provided by users, and must be unique and consistent.
+ #
+ # Meta information related to the job searcher or entity
+ # conducting the job search. This information is used to improve the
+ # performance of the service.
+ "userId": "A String", # Required. A unique user identification string, as determined by the client.
+ # To have the strongest positive impact on search quality
+ # make sure the client-level is unique.
+ # Obfuscate this field for privacy concerns before
+ # providing it to the service.
+ #
+ # If this field is not available for some reason, send "UNKNOWN". Note
+ # that any improvements to the model for a particular tenant
+ # site, rely on this field being set correctly to a unique user_id.
+ #
+ # The maximum number of allowed characters is 255.
+ "sessionId": "A String", # Required. A unique session identification string. A session is defined as the
+ # duration of an end user's interaction with the service over a certain
+ # period.
+ # Obfuscate this field for privacy concerns before
+ # providing it to the service.
+ #
+ # If this field is not available for some reason, send "UNKNOWN". Note
+ # that any improvements to the model for a particular tenant
+ # site, rely on this field being set correctly to some unique session_id.
+ #
+ # The maximum number of allowed characters is 255.
+ "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the
+ # service.
+ # other entity conducting the job search. Providing this information improves
+ # the quality of the search results across devices.
+ "deviceType": "A String", # Optional. Type of the device.
+ "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that
+ # distinguishes the device from other devices.
+ },
+ "domain": "A String", # Required. The client-defined scope or source of the service call, which typically
+ # is the domain on
+ # which the service has been implemented and is currently being run.
+ #
+ # For example, if the service is being run by client <em>Foo, Inc.</em>, on
+ # job board www.foo.com and career site www.bar.com, then this field is
+ # set to "foo.com" for use on the job board, and "bar.com" for use on the
+ # career site.
+ #
+ # If this field isn't available for some reason, send "UNKNOWN".
+ # Any improvements to the model for a particular tenant site rely on this
+ # field being set correctly to a domain.
+ #
+ # The maximum number of allowed characters is 255.
+ },
+ "pageToken": "A String", # Optional. 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.
+ "disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,
# Job.description, Job.company_display_name, Job.locations,
# Job.qualifications. When disable keyword match is turned off, a
# keyword match returns jobs that do not match given category filters when
@@ -5634,482 +5351,7 @@
# keyword match improves recall of subsequent search requests.
#
# Defaults to false.
- "jobQuery": { # Input only. # Optional.
- #
- # Query used to search against jobs, such as keyword, location filters, etc.
- #
- # The query required to perform a search query.
- "disableSpellCheck": True or False, # Optional.
- #
- # 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.
- "customAttributeFilter": "A String", # Optional.
- #
- # This filter specifies a structured syntax to match against the
- # Job.custom_attributes marked as `filterable`.
- #
- # The syntax for this expression is a subset of SQL syntax.
- #
- # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the
- # left of the operator is a custom field key and the right of the operator
- # is a number or a quoted string. You must escape backslash (\\) and
- # quote (\") characters.
- #
- # Supported functions are `LOWER([field_name])` to
- # perform a case insensitive match and `EMPTY([field_name])` to filter on the
- # existence of a key.
- #
- # 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 < 3000 bytes in length.
- #
- # Sample Query:
- # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
- # driving_years > 10`
- "employmentTypes": [ # Optional.
- #
- # The employment type filter specifies the employment type of jobs to
- # search against, such as EmploymentType.FULL_TIME.
- #
- # If a value is not 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.
- "A String",
- ],
- "query": "A String", # Optional.
- #
- # The query string that matches against the job title, description, and
- # location fields.
- #
- # The maximum number of allowed characters is 255.
- "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional.
- #
- # Jobs published within a range specified by this filter are searched
- # against.
- "endTime": "A String", # End of the period.
- "startTime": "A String", # Begin of the period.
- },
- "commuteFilter": { # Input only. # Optional.
- #
- # Allows filtering jobs by commute time with different travel methods (for
- # example, driving or public transit). Note: This only works with COMMUTE
- # MODE. When specified, [JobQuery.location_filters] is
- # ignored.
- #
- # Currently we don't support sorting by commute time.
- #
- # Parameters needed for commute search.
- "roadTraffic": "A String", # Optional.
- #
- # Specifies the traffic density to use when calculating commute time.
- "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional.
- #
- # The departure time used to calculate traffic impact, represented as
- # google.type.TimeOfDay in local time zone.
- #
- # Currently traffic model is restricted to hour level resolution.
- # or are specified elsewhere. An API may choose to allow leap seconds. Related
- # types are google.type.Date and `google.protobuf.Timestamp`.
- "seconds": 42, # 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.
- "hours": 42, # 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": 42, # Minutes of hour of day. Must be from 0 to 59.
- "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- },
- "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required.
- #
- # The latitude and longitude of the location from which to calculate the
- # commute time.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "allowImpreciseAddresses": True or False, # Optional.
- # If true, jobs without "precise" addresses (street level addresses or GPS
- # coordinates) might also be returned. For city and coarser level addresses,
- # text matching is used. If this field is set to false or is not specified,
- # only jobs that include precise addresses are returned by Commute
- # Search.
- #
- # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not
- # able to calculate accurate commute times to jobs with city level and
- # coarser address information. Jobs with imprecise addresses will return a
- # `travel_duration` time of 0 regardless of distance from the job seeker.
- "travelDuration": "A String", # Required.
- #
- # The maximum travel time in seconds. The maximum allowed value is `3600s`
- # (one hour). Format is `123s`.
- "commuteMethod": "A String", # Required.
- #
- # The method of transportation for which to calculate the commute time.
- },
- "jobCategories": [ # Optional.
- #
- # The category filter specifies the categories of jobs to search against.
- # See Category for more information.
- #
- # If a value is not specified, jobs from any category are searched against.
- #
- # If multiple values are specified, jobs from any of the specified
- # categories are searched against.
- "A String",
- ],
- "languageCodes": [ # Optional.
- #
- # 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](https://tools.ietf.org/html/bcp47).
- #
- # At most 10 language code filters are allowed.
- "A String",
- ],
- "companyNames": [ # Optional.
- #
- # 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/{project_id}/companies/{company_id}", for example,
- # "projects/api-test-project/companies/foo".
- #
- # At most 20 company filters are allowed.
- "A String",
- ],
- "companyDisplayNames": [ # Optional.
- #
- # This filter specifies the exact company display
- # name of the jobs to search against.
- #
- # 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.
- "A String",
- ],
- "locationFilters": [ # Optional.
- #
- # The location filter specifies geo-regions containing the jobs to
- # search against. See LocationFilter for more information.
- #
- # 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
- # LocationFilter.distance_in_miles parameter, the maximum provided
- # distance is used for all locations.
- #
- # At most 5 location filters are allowed.
- { # Input only.
- #
- # Geographic region of the search.
- "regionCode": "A String", # Optional.
- #
- # 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 if all the jobs to search against are from a same region,
- # or jobs are world-wide, but the job seeker is from a specific region.
- #
- # See http://cldr.unicode.org/ and
- # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
- # for details. Example: "CH" for Switzerland.
- "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional.
- #
- # The latitude and longitude of the geographic center from which to
- # search. This field's ignored if `address` is provided.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "distanceInMiles": 3.14, # Optional.
- #
- #
- # The distance_in_miles is applied when the location being searched for is
- # identified as a city or smaller. When the location being searched for is a
- # state or larger, this field is ignored.
- "telecommutePreference": "A String", # Optional.
- #
- # Allows the client to return jobs without a
- # set location, specifically, telecommuting jobs (telecomuting is considered
- # by the service as a special location.
- # Job.posting_region indicates if a job permits telecommuting.
- # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,
- # telecommuting jobs are searched, and address and lat_lng are
- # ignored. If not set or set to
- # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not
- # searched.
- #
- # 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.
- "address": "A String", # Optional.
- #
- # The address name, such as "Mountain View" or "Bay Area".
- },
- ],
- "compensationFilter": { # Input only. # Optional.
- #
- # This search filter is applied only to
- # Job.compensation_info. For example, if the filter is specified
- # as "Hourly job with per-hour compensation > $15", only jobs meeting
- # these criteria are searched. If a filter isn't defined, all open jobs
- # are searched.
- #
- # Filter on job compensation type and amount.
- "units": [ # Required.
- #
- # Specify desired `base compensation entry's`
- # CompensationInfo.CompensationUnit.
- "A String",
- ],
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
- # to zero and the currency code is set to match the
- # currency code of max_compensation.
- "nanos": 42, # Number of nano (10^-9) units of the amount.
- # The value must be between -999,999,999 and +999,999,999 inclusive.
- # If `units` is positive, `nanos` must be positive or zero.
- # If `units` is zero, `nanos` can be positive, zero, or negative.
- # If `units` is negative, `nanos` must be negative or zero.
- # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
- },
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
- # to a maximal compensation value and the currency code is set to
- # match the currency code of
- # min_compensation.
- "nanos": 42, # Number of nano (10^-9) units of the amount.
- # The value must be between -999,999,999 and +999,999,999 inclusive.
- # If `units` is positive, `nanos` must be positive or zero.
- # If `units` is zero, `nanos` can be positive, zero, or negative.
- # If `units` is negative, `nanos` must be negative or zero.
- # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
- },
- },
- "type": "A String", # Required.
- #
- # Type of filter.
- "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional.
- #
- # If set to true, jobs with unspecified compensation range fields are
- # included.
- },
- },
- "pageSize": 42, # Optional.
- #
- # 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.
- "histogramFacets": { # Input only. # Optional.
- #
- # Histogram requests for jobs matching JobQuery.
- #
- # Histogram facets to be specified in SearchJobsRequest.
- "simpleHistogramFacets": [ # Optional.
- #
- # Specifies the simple type of histogram facets, for example,
- # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
- "A String",
- ],
- "customAttributeHistogramFacets": [ # Optional.
- #
- # Specifies the custom attributes histogram requests.
- # Duplicate values of CustomAttributeHistogramRequest.key are not
- # allowed.
- { # Custom attributes histogram request. An error is thrown if neither
- # string_value_histogram or long_value_histogram_bucketing_option has
- # been defined.
- "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for
- # each key as a string.
- "longValueHistogramBucketingOption": { # Input only. # Optional.
- #
- # Specifies buckets used to perform a range histogram on Job's
- # filterable long custom field values, or min/max value requirements.
- #
- # Use this field to specify bucketing option for the histogram search response.
- "bucketBounds": [ # Required.
- #
- # Two adjacent values form a histogram bucket. Values should be in
- # ascending order. For example, if [5, 10, 15] are provided, four buckets are
- # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
- # [buckets_bound is supported.
- 3.14,
- ],
- "requiresMinMax": True or False, # Optional.
- #
- # If set to true, the histogram result includes minimum/maximum
- # value of the numeric field.
- },
- "key": "A String", # Required.
- #
- # Specifies the custom field key to perform a histogram on. If specified
- # without `long_value_histogram_bucketing_option`, histogram on string values
- # of the given `key` is triggered, otherwise histogram is performed on long
- # values.
- },
- ],
- "compensationHistogramFacets": [ # Optional.
- #
- # Specifies compensation field-based histogram requests.
- # Duplicate values of CompensationHistogramRequest.type are not allowed.
- { # Input only.
- #
- # Compensation based histogram request.
- "bucketingOption": { # Input only. # Required.
- #
- # Numeric histogram options, like buckets, whether include min or max value.
- #
- # Use this field to specify bucketing option for the histogram search response.
- "bucketBounds": [ # Required.
- #
- # Two adjacent values form a histogram bucket. Values should be in
- # ascending order. For example, if [5, 10, 15] are provided, four buckets are
- # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
- # [buckets_bound is supported.
- 3.14,
- ],
- "requiresMinMax": True or False, # Optional.
- #
- # If set to true, the histogram result includes minimum/maximum
- # value of the numeric field.
- },
- "type": "A String", # Required.
- #
- # Type of the request, representing which field the histogramming should be
- # performed over. A single request can only specify one histogram of each
- # `CompensationHistogramRequestType`.
- },
- ],
- },
- "enableBroadening": True or False, # Optional.
- #
- # 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.
- "searchMode": "A String", # Optional.
- #
- # Mode of a search.
- #
- # Defaults to SearchMode.JOB_SEARCH.
- "pageToken": "A String", # Optional.
- #
- # 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.
- "requestMetadata": { # Input only. # Required.
- #
- # The meta information collected about the job searcher, used to improve the
- # search quality of the service.. The identifiers, (such as `user_id`) are
- # provided by users, and must be unique and consistent.
- #
- # Meta information related to the job searcher or entity
- # conducting the job search. This information is used to improve the
- # performance of the service.
- "userId": "A String", # Required.
- #
- # A unique user identification string, as determined by the client.
- # To have the strongest positive impact on search quality
- # make sure the client-level is unique.
- # Obfuscate this field for privacy concerns before
- # providing it to the service.
- #
- # If this field is not available for some reason, send "UNKNOWN". Note
- # that any improvements to the model for a particular tenant
- # site, rely on this field being set correctly to a unique user_id.
- #
- # The maximum number of allowed characters is 255.
- "sessionId": "A String", # Required.
- #
- # A unique session identification string. A session is defined as the
- # duration of an end user's interaction with the service over a certain
- # period.
- # Obfuscate this field for privacy concerns before
- # providing it to the service.
- #
- # If this field is not available for some reason, send "UNKNOWN". Note
- # that any improvements to the model for a particular tenant
- # site, rely on this field being set correctly to some unique session_id.
- #
- # The maximum number of allowed characters is 255.
- "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional.
- #
- # The type of device used by the job seeker at the time of the call to the
- # service.
- # other entity conducting the job search. Providing this information improves
- # the quality of the search results across devices.
- "deviceType": "A String", # Optional.
- #
- # Type of the device.
- "id": "A String", # Optional.
- #
- # A device-specific ID. The ID must be a unique identifier that
- # distinguishes the device from other devices.
- },
- "domain": "A String", # Required.
- #
- # The client-defined scope or source of the service call, which typically
- # is the domain on
- # which the service has been implemented and is currently being run.
- #
- # For example, if the service is being run by client <em>Foo, Inc.</em>, on
- # job board www.foo.com and career site www.bar.com, then this field is
- # set to "foo.com" for use on the job board, and "bar.com" for use on the
- # career site.
- #
- # If this field isn't available for some reason, send "UNKNOWN".
- # Any improvements to the model for a particular tenant site rely on this
- # field being set correctly to a domain.
- #
- # The maximum number of allowed characters is 255.
- },
- "requirePreciseResultSize": True or False, # Optional.
- #
- # Controls if the search job request requires the return of a precise
+ "requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise
# count of the first 300 results. Setting this to `true` ensures
# consistency in the number of results per page. Best practice is to set this
# value to true if a client allows users to jump directly to a
@@ -6118,16 +5360,14 @@
# Enabling this flag may adversely impact performance.
#
# Defaults to false.
- "jobView": "A String", # Optional.
- #
- # The desired job attributes returned for jobs in the
+ "jobView": "A String", # Optional. The desired job attributes returned for jobs in the
# search response. Defaults to JobView.SMALL if no value is specified.
- "offset": 42, # Optional.
- #
- # An integer that specifies the current offset (that is, starting result
+ "offset": 42, # Optional. 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
@@ -6167,9 +5407,7 @@
"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.
# or "job requisition"). A job belongs to a Company, which is the hiring
# entity responsible for the job.
- "languageCode": "A String", # Optional.
- #
- # The language of the posting. This field is distinct from
+ "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
# any requirements for fluency that are associated with the job.
#
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
@@ -6200,38 +5438,55 @@
"A String",
],
"companyDisplayName": "A String", # Output only. Display name of the company listing the job.
- "promotionValue": 42, # Optional.
- #
- # A promotion value of the job, as determined by the client.
+ "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
# The value determines the sort order of the jobs returned when searching for
# jobs using the featured jobs search call, with higher promotional values
# being returned first and ties being resolved by relevance sort. Only the
- # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
+ # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
#
# Default value is 0, and negative values are treated as 0.
- "employmentTypes": [ # Optional.
- #
- # The employment type(s) of a job, for example,
+ "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
# full time or
# part time.
"A String",
],
- "jobEndTime": "A String", # Optional.
- #
- # The end timestamp of the job. Typically this field is used for contracting
+ "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
# engagements. Invalid timestamps are ignored.
- "description": "A String", # Required.
+ "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
#
- # The description of the job, which typically includes a multi-paragraph
- # description of the company and related information. Separate fields are
- # provided on the job object for responsibilities,
- # qualifications, and other job characteristics. Use of
- # these separate job fields is recommended.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 100,000.
+ # Job application information.
+ "instruction": "A String", # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to provide instructions, such as "Mail your application
+ # to ...", that a candidate can follow to apply for the job.
+ #
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
+ #
+ # The maximum number of allowed characters is 3,000.
+ "uris": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this URI field to direct an applicant to a website, for example to
+ # link to an online application form.
+ #
+ # The maximum number of allowed characters for each entry is 2,000.
+ "A String",
+ ],
+ "emails": [ # Optional but at least one of uris,
+ # emails or instruction must be
+ # specified.
+ #
+ # Use this field to specify email address(es) to which resumes or
+ # applications can be sent.
+ #
+ # The maximum number of allowed characters for each entry is 255.
+ "A String",
+ ],
+ },
"postingExpireTime": "A String", # Optional but strongly recommended for the best service
# experience.
#
@@ -6265,14 +5520,10 @@
# expiry_time, or the masks are empty meaning that every field is
# updated, the job posting expires after 30 days from the job's last
# update time. Otherwise the expiration date isn't updated.
- "title": "A String", # Required.
- #
- # The title of the job, such as "Software Engineer"
+ "title": "A String", # Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
- "responsibilities": "A String", # Optional.
- #
- # A description of job responsibilities. The use of this field is
+ "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
# recommended as an alternative to using the more general description
# field.
#
@@ -6280,21 +5531,15 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "jobStartTime": "A String", # Optional.
- #
- # The start timestamp of the job in UTC time zone. Typically this field
+ "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
# is used for contracting engagements. Invalid timestamps are ignored.
- "compensationInfo": { # Job compensation details. # Optional.
- #
- # Job compensation information.
+ "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
# all compensation entries' CompensationEntry.compensation times
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -6307,9 +5552,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -6329,9 +5572,7 @@
# CompensationEntry.expected_units_per_year.
#
# See CompensationEntry for explanation on compensation annualization.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -6344,9 +5585,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -6361,9 +5600,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "entries": [ # Optional.
- #
- # Job compensation information.
+ "entries": [ # Optional. Job compensation information.
#
# At most one entry can be of type
# CompensationInfo.CompensationType.BASE, which is
@@ -6376,17 +5613,11 @@
# - and its expected_units_per_year is set or can be derived.
# Its annualized range is determined as (amount or range) times
# expected_units_per_year.
- "description": "A String", # Optional.
- #
- # Compensation description. For example, could
+ "description": "A String", # Optional. Compensation description. For example, could
# indicate equity terms or provide additional context to an estimated
# bonus.
- "range": { # Compensation range. # Optional.
- #
- # Compensation range.
- "minCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The minimum amount of compensation. If left empty, the value is set
+ "range": { # Compensation range. # Optional. Compensation range.
+ "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
# to zero and the currency code is set to match the
# currency code of max_compensation.
"nanos": 42, # Number of nano (10^-9) units of the amount.
@@ -6399,9 +5630,7 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "maxCompensation": { # Represents an amount of money with its currency type. # Optional.
- #
- # The maximum amount of compensation. If left empty, the value is set
+ "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
# to a maximal compensation value and the currency code is set to
# match the currency code of
# min_compensation.
@@ -6416,9 +5645,7 @@
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
},
- "expectedUnitsPerYear": 3.14, # Optional.
- #
- # Expected number of units paid each year. If not specified, when
+ "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
# Job.employment_types is FULLTIME, a default value is inferred
# based on unit. Default values:
# - HOURLY: 2080
@@ -6426,9 +5653,7 @@
# - WEEKLY: 52
# - MONTHLY: 12
# - ANNUAL: 1
- "amount": { # Represents an amount of money with its currency type. # Optional.
- #
- # Compensation amount.
+ "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -6439,78 +5664,41 @@
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "type": "A String", # Optional.
- #
- # Compensation type.
+ "type": "A String", # Optional. Compensation type.
#
# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
- "unit": "A String", # Optional.
- #
- # Frequency of the specified amount.
+ "unit": "A String", # Optional. Frequency of the specified amount.
#
# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
},
],
},
- "department": "A String", # Optional.
- #
- # The department or functional area within the company with the open
+ "department": "A String", # Optional. The department or functional area within the company with the open
# position.
#
# The maximum number of allowed characters is 255.
"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
- "requisitionId": "A String", # Required.
- #
- # The requisition ID, also referred to as the posting ID, assigned by the
+ "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
# client to identify a job. This field is intended to be used by clients
# for client identification and tracking of postings. A job is not allowed
# to be created if there is another job with the same [company_name],
# language_code and requisition_id.
#
# The maximum number of allowed characters is 255.
- "postingPublishTime": "A String", # Optional.
- #
- # The timestamp this job posting was most recently published. The default
+ "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
# value is the time the request arrives at the server. Invalid timestamps are
# ignored.
- "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
+ "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
+ # description of the company and related information. Separate fields are
+ # provided on the job object for responsibilities,
+ # qualifications, and other job characteristics. Use of
+ # these separate job fields is recommended.
#
- # Job application information.
- "instruction": "A String", # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to provide instructions, such as "Mail your application
- # to ...", that a candidate can follow to apply for the job.
- #
- # This field accepts and sanitizes HTML input, and also accepts
- # bold, italic, ordered list, and unordered list markup tags.
- #
- # The maximum number of allowed characters is 3,000.
- "emails": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this field to specify email address(es) to which resumes or
- # applications can be sent.
- #
- # The maximum number of allowed characters for each entry is 255.
- "A String",
- ],
- "uris": [ # Optional but at least one of uris,
- # emails or instruction must be
- # specified.
- #
- # Use this URI field to direct an applicant to a website, for example to
- # link to an online application form.
- #
- # The maximum number of allowed characters for each entry is 2,000.
- "A String",
- ],
- },
- "companyName": "A String", # Required.
+ # This field accepts and sanitizes HTML input, and also accepts
+ # bold, italic, ordered list, and unordered list markup tags.
#
- # The resource name of the company listing the job, such as
+ # The maximum number of allowed characters is 100,000.
+ "companyName": "A String", # Required. The resource name of the company listing the job, such as
# "projects/api-test-project/companies/foo".
"derivedInfo": { # Output only. # Output only. Derived details about the job posting.
#
@@ -6525,20 +5713,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -6556,7 +5744,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -6639,20 +5827,7 @@
},
],
},
- "incentives": "A String", # Optional.
- #
- # A description of bonus, commission, and other compensation
- # incentives associated with the job not including salary or pay.
- #
- # The maximum number of allowed characters is 10,000.
- "jobBenefits": [ # Optional.
- #
- # The benefits included with the job.
- "A String",
- ],
- "qualifications": "A String", # Optional.
- #
- # A description of the qualifications required to perform the
+ "qualifications": "A String", # Optional. A description of the qualifications required to perform the
# job. The use of this field is recommended
# as an alternative to using the more general description field.
#
@@ -6660,15 +5835,20 @@
# bold, italic, ordered list, and unordered list markup tags.
#
# The maximum number of allowed characters is 10,000.
- "visibility": "A String", # Optional.
+ "jobBenefits": [ # Optional. The benefits included with the job.
+ "A String",
+ ],
+ "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
+ # incentives associated with the job not including salary or pay.
+ #
+ # The maximum number of allowed characters is 10,000.
+ "visibility": "A String", # Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
# Defaults to Visibility.ACCOUNT_ONLY if not specified.
"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
- "postingRegion": "A String", # Optional.
- #
- # The job PostingRegion (for example, state, country) throughout which
+ "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
# the job is available. If this field is set, a
# LocationFilter in a search query within the job region
# finds this job posting if an exact location match isn't specified.
@@ -6685,14 +5865,10 @@
#
# Use of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
- "processingOptions": { # Input only. # Optional.
+ "processingOptions": { # Input only. # Optional. Options for job processing.
#
# Options for job processing.
- #
- # Options for job processing.
- "htmlSanitization": "A String", # Optional.
- #
- # Option for job HTML content sanitization. Applied fields are:
+ "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
#
# * description
# * applicationInfo.instruction
@@ -6704,19 +5880,13 @@
# disabled.
#
# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
- "disableStreetAddressResolution": True or False, # Optional.
- #
- # If set to `true`, the service does not attempt to resolve a
+ "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
# more precise address for the job.
},
- "degreeTypes": [ # Optional.
- #
- # The desired education degrees for the job, such as Bachelors, Masters.
+ "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
"A String",
],
- "customAttributes": { # Optional.
- #
- # A map of fields to hold both filterable and non-filterable custom job
+ "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
# attributes that are not covered by the provided structured fields.
#
# The keys of the map are strings up to 64 bytes and must match the
@@ -6729,9 +5899,7 @@
# `string_values`, the maximum total size of `string_values` across all keys
# is 50KB.
"a_key": { # Custom attribute values that are either filterable or non-filterable.
- "filterable": True or False, # Optional.
- #
- # If the `filterable` flag is true, custom field values are searchable.
+ "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
# If false, values are not searchable.
#
# Default is false.
@@ -6742,7 +5910,7 @@
# `CASE_INSENSITIVE_MATCH`) search.
# For filterable `string_value`s, a maximum total number of 200 values
# is allowed, with each `string_value` has a byte size of no more than
- # 255B. For unfilterable `string_values`, the maximum total byte size of
+ # 500B. For unfilterable `string_values`, the maximum total byte size of
# unfilterable `string_values` is 50KB.
#
# Empty string is not allowed.
@@ -6759,9 +5927,7 @@
],
},
},
- "jobLevel": "A String", # Optional.
- #
- # The experience level associated with the job, such as "Entry Level".
+ "jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
},
"commuteInfo": { # Output only. # Commute information which is generated based on specified
# CommuteFilter.
@@ -6774,20 +5940,20 @@
"jobLocation": { # Output only. # Location used as the destination in the commute calculation.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -6805,7 +5971,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#
@@ -6996,20 +6162,20 @@
{ # Output only.
#
# A resource that represents a location with full geographic information.
+ "locationType": "A String", # The type of a location, which corresponds to the address lines field of
+ # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
+ # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
+ # LocationType#LOCALITY.
"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
# location bounding box in which a circle with the specified radius
# centered from LatLng covers the area associated with the job location.
# For example, currently, "Mountain View, CA, USA" has a radius of
# 6.17 miles.
- "locationType": "A String", # The type of a location, which corresponds to the address lines field of
- # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
- # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
- # LocationType#LOCALITY.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
@@ -7027,7 +6193,7 @@
#
# Advice on address input / editing:
# - Use an i18n-ready address widget such as
- # https://github.com/googlei18n/libaddressinput)
+ # https://github.com/google/libaddressinput)
# - Users should not be presented with UI elements for input or editing of
# fields outside countries where that field is used.
#