Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / jobs_v2.jobs.html
blob: 1fdc281e304c6d20c278ed71b51e02f783b2ca92 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="jobs_v2.html">Cloud Talent Solution API</a> . <a href="jobs_v2.jobs.html">jobs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#batchDelete">batchDelete(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Deletes a list of Job postings by filter.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Creates a new job.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None, disableFastProcess=None)</a></code></p>
85<p class="firstline">Deletes the specified job.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#deleteByFilter">deleteByFilter(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Deprecated. Use BatchDeleteJobs instead.</p>
89<p class="toc_element">
90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Retrieves the specified job, whose status is OPEN or recently EXPIRED</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#histogram">histogram(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Deprecated. Use SearchJobsRequest.histogram_facets instead to make</p>
95<p class="toc_element">
96 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None, idsOnly=None, filter=None)</a></code></p>
97<p class="firstline">Lists jobs by filter.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Updates specified job.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code><a href="#search">search(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code><a href="#searchForAlert">searchForAlert(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>
110<p class="toc_element">
111 <code><a href="#searchForAlert_next">searchForAlert_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
114 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
115<p class="firstline">Retrieves the next page of results.</p>
116<h3>Method Details</h3>
117<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 <code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 <pre>Deletes a list of Job postings by filter.
120
121Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 The object takes the form of:
124
125{ # Input only.
126 #
127 # Batch delete jobs request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]128 "filter": "A String", # Required. The filter string specifies the jobs to be deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 #
130 # Supported operator: =, AND
131 #
132 # The fields eligible for filtering are:
133 #
134 # * `companyName` (Required)
135 # * `requisitionId` (Required)
136 #
137 # Sample Query: companyName = "companies/123" AND requisitionId = "req-1"
138 }
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # A generic empty message that you can re-use to avoid defining duplicated
149 # empty messages in your APIs. A typical example is to use it as the request
150 # or the response type of an API method. For instance:
151 #
152 # service Foo {
153 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
154 # }
155 #
156 # The JSON representation for `Empty` is empty JSON object `{}`.
157 }</pre>
158</div>
159
160<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]161 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 <pre>Creates a new job.
163
164Typically, the job becomes searchable within 10 seconds, but it may take
165up to 5 minutes.
166
167Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 The object takes the form of:
170
171{ # Input only.
172 #
173 # Create job request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]174 "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 # or "job requisition"). A job belongs to a Company, which is the hiring
176 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 # any requirements for fluency that are associated with the job.
179 #
180 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
181 # For more information, see
182 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
183 # class="external" target="_blank" }.
184 #
185 # If this field is unspecified and Job.description is present, detected
186 # language code based on Job.description is assigned, otherwise
187 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]188 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
190 #
191 # Optional.
192 #
193 # A map of fields to hold non-filterable custom job attributes, similar to
194 # filterable_custom_fields. These fields are distinct in that the data
195 # in these fields are not indexed. Therefore, the client cannot search
196 # against them, nor can the client use them to list jobs.
197 #
198 # The key of the map can be any valid string.
199 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]200 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 "A String",
202 ],
203 },
204 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 # is used for contracting engagements.
207 # Dates prior to 1970/1/1 and invalid date formats are ignored.
208 # and time zone are either specified elsewhere or are not significant. The date
209 # is relative to the Proleptic Gregorian Calendar. This can represent:
210 #
211 # * A full date, with non-zero year, month and day values
212 # * A month and day value, with a zero year, e.g. an anniversary
213 # * A year on its own, with zero month and day values
214 # * A year and month value, with a zero day, e.g. a credit card expiration date
215 #
216 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
217 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
218 # month and day.
219 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
220 # if specifying a year by itself or a year and month where the day is not
221 # significant.
222 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
223 # a year.
224 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
226 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227 # is used for contracting engagements.
228 # Dates prior to 1970/1/1 and invalid date formats are ignored.
229 # and time zone are either specified elsewhere or are not significant. The date
230 # is relative to the Proleptic Gregorian Calendar. This can represent:
231 #
232 # * A full date, with non-zero year, month and day values
233 # * A month and day value, with a zero year, e.g. an anniversary
234 # * A year on its own, with zero month and day values
235 # * A year and month value, with a zero day, e.g. a credit card expiration date
236 #
237 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
238 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
239 # month and day.
240 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
241 # if specifying a year by itself or a year and month where the day is not
242 # significant.
243 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
244 # a year.
245 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]246 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 { # Output only.
248 #
249 # A resource that represents a location with full geographic
250 # information.
251 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
252 # location bounding box in which a circle with the specified radius
253 # centered from LatLng coves the area associated with the job location.
254 # For example, currently, "Mountain View, CA, USA" has a radius of
255 # 7885.79 meters.
256 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
257 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
258 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
259 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]260 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
261 # of doubles representing degrees latitude and degrees longitude. Unless
262 # specified otherwise, this must conform to the
263 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
264 # standard&lt;/a&gt;. Values must be within normalized ranges.
265 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
266 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
267 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
269 # such as postal delivery and payments addresses. Given a postal address,
270 # a postal service can deliver items to a premises, P.O. Box, or other
271 # delivery location.
272 # Given a postal address, a postal service can deliver items to a premise, P.O.
273 # Box or similar.
274 # It is not intended to model geographical locations (roads, towns,
275 # mountains).
276 #
277 # In typical usage an address would be created via user input or from importing
278 # existing data, depending on the type of process.
279 #
280 # Advice on address input / editing:
281 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]282 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 # - Users should not be presented with UI elements for input or editing of
284 # fields outside countries where that field is used.
285 #
286 # For more guidance on how to use this schema, please see:
287 # https://support.google.com/business/answer/6397478
288 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
289 # known). This is often the UI language of the input form or is expected
290 # to match one of the languages used in the address' country/region, or their
291 # transliterated equivalents.
292 # This can affect formatting in certain countries, but is not critical
293 # to the correctness of the data and will never affect any validation or
294 # other non-formatting related operations.
295 #
296 # If this value is not known, it should be omitted (rather than specifying a
297 # possibly incorrect default).
298 #
299 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
300 "recipients": [ # Optional. The recipient at the address.
301 # This field may, under certain circumstances, contain multiline information.
302 # For example, it might contain "care of" information.
303 "A String",
304 ],
305 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
306 # Examples: US city, IT comune, UK post town.
307 # In regions of the world where localities are not well defined or do not fit
308 # into this structure well, leave locality empty and use address_lines.
309 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
310 # in most regions. Where it is used, the value is either a string like
311 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
312 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
313 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
314 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
315 # is never inferred and it is up to the user to ensure the value is
316 # correct. See http://cldr.unicode.org/ and
317 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
318 # for details. Example: "CH" for Switzerland.
319 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
320 # addresses of a country or region.
321 # For example, this can be a state, a province, an oblast, or a prefecture.
322 # Specifically, for Spain this is the province and not the autonomous
323 # community (e.g. "Barcelona" and not "Catalonia").
324 # Many countries don't use an administrative area in postal addresses. E.g.
325 # in Switzerland this should be left unpopulated.
326 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
327 #
328 # Because values in address_lines do not have type information and may
329 # sometimes contain multiple values in a single field (e.g.
330 # "Austin, TX"), it is important that the line order is clear. The order of
331 # address lines should be "envelope order" for the country/region of the
332 # address. In places where this can vary (e.g. Japan), address_language is
333 # used to make it explicit (e.g. "ja" for large-to-small ordering and
334 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
335 # an address can be selected based on the language.
336 #
337 # The minimum permitted structural representation of an address consists
338 # of a region_code with all remaining information placed in the
339 # address_lines. It would be possible to format such an address very
340 # approximately without geocoding, but no semantic reasoning could be
341 # made about any of the address components until it was at least
342 # partially resolved.
343 #
344 # Creating an address only containing a region_code and address_lines, and
345 # then geocoding is the recommended way to handle completely unstructured
346 # addresses (as opposed to guessing which parts of the address should be
347 # localities or administrative areas).
348 "A String",
349 ],
350 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
351 # postal codes to be present, but where they are used, they may trigger
352 # additional validation with other parts of the address (e.g. state/zip
353 # validation in the U.S.A.).
354 "organization": "A String", # Optional. The name of the organization at the address.
355 "sublocality": "A String", # Optional. Sublocality of the address.
356 # For example, this can be neighborhoods, boroughs, districts.
357 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
358 # the latest revision.
359 #
360 # All new revisions **must** be backward compatible with old revisions.
361 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]362 },
363 ],
364 "locations": [ # Optional but strongly recommended for the best service experience.
365 #
366 # Location(s) where the emploeyer is looking to hire for this job posting.
367 #
368 # Specifying the full street address(es) of the hiring location enables
369 # better API results, especially job searches by commute time.
370 #
371 # At most 50 locations are allowed for best search performance. If a job has
372 # more locations, it is suggested to split it into multiple jobs with unique
373 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
374 # multiple jobs with the same requisition_id, company_name and
375 # language_code are not allowed. If the original requisition_id must
376 # be preserved, a custom field should be used for storage. It is also
377 # suggested to group the locations that close to each other in the same job
378 # for better search experience.
379 #
380 # The maximum number of allowed characters is 500.
381 "A String",
382 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]383 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384 # full time or
385 # part time.
386 "A String",
387 ],
388 "applicationUrls": [ # Optional but at least one of application_urls,
389 # application_email_list or application_instruction must be
390 # specified.
391 #
392 # Use this URL field to direct an applicant to a website, for example to
393 # link to an online application form.
394 #
395 # The maximum number of allowed characters is 2,000.
396 "A String",
397 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]398 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 # "Bachelors", "Masters", "Doctorate".
400 "A String",
401 ],
402 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
403 #
404 # Optional.
405 #
406 # Job compensation information.
407 #
408 # This field replaces compensation_info. Only
409 # CompensationInfo.entries or extended_compensation_info can be set,
410 # otherwise an exception is thrown.
411 #
412 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]413 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 # the job's all CompensationEntry cannot be annualized.
415 # See CompensationEntry for explanation on annualization and base
416 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 #
419 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]420 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]421 #
422 # Decimal number.
423 "units": "A String", # Whole units.
424 "micros": 42, # Micro (10^-6) units.
425 # The value must be between -999,999 and +999,999 inclusive.
426 # If `units` is positive, `micros` must be positive or zero.
427 # If `units` is zero, `micros` can be positive, zero, or negative.
428 # If `units` is negative, `micros` must be negative or zero.
429 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
430 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]431 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 #
433 # Decimal number.
434 "units": "A String", # Whole units.
435 "micros": 42, # Micro (10^-6) units.
436 # The value must be between -999,999 and +999,999 inclusive.
437 # If `units` is positive, `micros` must be positive or zero.
438 # If `units` is zero, `micros` can be positive, zero, or negative.
439 # If `units` is negative, `micros` must be negative or zero.
440 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
441 },
442 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]443 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444 #
445 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]446 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]447 #
448 # Decimal number.
449 "units": "A String", # Whole units.
450 "micros": 42, # Micro (10^-6) units.
451 # The value must be between -999,999 and +999,999 inclusive.
452 # If `units` is positive, `micros` must be positive or zero.
453 # If `units` is zero, `micros` can be positive, zero, or negative.
454 # If `units` is negative, `micros` must be negative or zero.
455 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
456 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]457 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 #
459 # Decimal number.
460 "units": "A String", # Whole units.
461 "micros": 42, # Micro (10^-6) units.
462 # The value must be between -999,999 and +999,999 inclusive.
463 # If `units` is positive, `micros` must be positive or zero.
464 # If `units` is zero, `micros` can be positive, zero, or negative.
465 # If `units` is negative, `micros` must be negative or zero.
466 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
467 },
468 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]469 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]470 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]471 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]472 # the job's base compensation entry cannot be annualized.
473 # See CompensationEntry for explanation on annualization and base
474 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]475 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]476 #
477 # At most one entry can be of type
478 # ExtendedCompensationInfo.CompensationType.BASE, which is
479 # referred as ** base compensation entry ** for the job.
480 { # Deprecated. See CompensationInfo.
481 #
482 # A compensation entry that represents one component of compensation, such
483 # as base pay, bonus, or other compensation type.
484 #
485 # Annualization: One compensation entry can be annualized if
486 # - it contains valid amount or range.
487 # - and its expected_units_per_year is set or can be derived.
488 # Its annualized range is determined as (amount or range) times
489 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]490 "description": "A String", # Optional. Compensation description.
491 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 #
493 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]494 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]495 #
496 # Decimal number.
497 "units": "A String", # Whole units.
498 "micros": 42, # Micro (10^-6) units.
499 # The value must be between -999,999 and +999,999 inclusive.
500 # If `units` is positive, `micros` must be positive or zero.
501 # If `units` is zero, `micros` can be positive, zero, or negative.
502 # If `units` is negative, `micros` must be negative or zero.
503 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
504 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]505 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]506 #
507 # Decimal number.
508 "units": "A String", # Whole units.
509 "micros": 42, # Micro (10^-6) units.
510 # The value must be between -999,999 and +999,999 inclusive.
511 # If `units` is positive, `micros` must be positive or zero.
512 # If `units` is zero, `micros` can be positive, zero, or negative.
513 # If `units` is negative, `micros` must be negative or zero.
514 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
515 },
516 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]517 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
518 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]519 # Job.employment_types is FULLTIME, a default value is inferred
520 # based on unit. Default values:
521 # - HOURLY: 2080
522 # - DAILY: 260
523 # - WEEKLY: 52
524 # - MONTHLY: 12
525 # - ANNUAL: 1
526 #
527 # Decimal number.
528 "units": "A String", # Whole units.
529 "micros": 42, # Micro (10^-6) units.
530 # The value must be between -999,999 and +999,999 inclusive.
531 # If `units` is positive, `micros` must be positive or zero.
532 # If `units` is zero, `micros` can be positive, zero, or negative.
533 # If `units` is negative, `micros` must be negative or zero.
534 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
535 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]536 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]537 #
538 # Decimal number.
539 "units": "A String", # Whole units.
540 "micros": 42, # Micro (10^-6) units.
541 # The value must be between -999,999 and +999,999 inclusive.
542 # If `units` is positive, `micros` must be positive or zero.
543 # If `units` is zero, `micros` can be positive, zero, or negative.
544 # If `units` is negative, `micros` must be negative or zero.
545 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
546 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]547 "type": "A String", # Required. Compensation type.
548 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]549 #
550 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
551 },
552 ],
553 },
554 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
555 #
556 # Optional.
557 #
558 # A map of fields to hold filterable custom job attributes not captured by
559 # the standard fields such as job_title, company_name, or
560 # level. These custom fields store arbitrary
561 # string values, and can be used for purposes not covered by
562 # the structured fields. For the best search experience, use of the
563 # structured rather than custom fields is recommended.
564 #
565 # Data stored in these custom fields fields are indexed and
566 # searched against by keyword searches (see
567 # SearchJobsRequest.custom_field_filters][]).
568 #
569 # The map key must be a number between 1-20. If an invalid key is
570 # provided on job create or update, an error is returned.
571 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]572 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 "A String",
574 ],
575 },
576 },
577 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
578 #
579 # Optional but strongly recommended to be provided for the best service
580 # experience.
581 #
582 # The expiration date of the job in UTC time. After 12 am on this date, the
583 # job is marked as expired, and it no longer appears in search results.
584 # The expired job can't be deleted or listed by the DeleteJob and
585 # ListJobs APIs, but it can be retrieved with the GetJob API or
586 # updated with the UpdateJob API. An expired job can be updated and
587 # opened again by using a future expiration date. It can also remain expired.
588 # Updating an expired job to be open fails if there is another existing open
589 # job with same requisition_id, company_name and language_code.
590 #
591 # The expired jobs are retained in our system for 90 days. However, the
592 # overall expired job count cannot exceed 3 times the maximum of open jobs
593 # count over the past week, otherwise jobs with earlier expire time are
594 # removed first. Expired jobs are no longer accessible after they are cleaned
595 # out.
596 #
597 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
598 # ignored and treated as expiry date not provided.
599 #
600 # If this value is not provided on job creation or is invalid, the job
601 # posting expires after 30 days from the job's creation time. For example, if
602 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
603 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
604 #
605 # If this value is not provided on job update, it depends on the field masks
606 # set by UpdateJobRequest.update_job_fields. If the field masks include
607 # expiry_date, or the masks are empty meaning that every field is
608 # updated, the job expires after 30 days from the job's last update time.
609 # Otherwise the expiration date isn't updated.
610 # and time zone are either specified elsewhere or are not significant. The date
611 # is relative to the Proleptic Gregorian Calendar. This can represent:
612 #
613 # * A full date, with non-zero year, month and day values
614 # * A month and day value, with a zero year, e.g. an anniversary
615 # * A year on its own, with zero month and day values
616 # * A year and month value, with a zero day, e.g. a credit card expiration date
617 #
618 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
619 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
620 # month and day.
621 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
622 # if specifying a year by itself or a year and month where the day is not
623 # significant.
624 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
625 # a year.
626 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]627 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]628 # recommended as an alternative to using the more general description
629 # field.
630 #
631 # This field accepts and sanitizes HTML input, and also accepts
632 # bold, italic, ordered list, and unordered list markup tags.
633 #
634 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]635 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
636 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]637 # base compensation entry's CompensationEntry.compensation times
638 # CompensationEntry.expected_units_per_year.
639 #
640 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]641 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]642 # to a maximal compensation value and the currency code is set to
643 # match the currency code of
644 # min_compensation.
645 "nanos": 42, # Number of nano (10^-9) units of the amount.
646 # The value must be between -999,999,999 and +999,999,999 inclusive.
647 # If `units` is positive, `nanos` must be positive or zero.
648 # If `units` is zero, `nanos` can be positive, zero, or negative.
649 # If `units` is negative, `nanos` must be negative or zero.
650 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
651 "units": "A String", # The whole units of the amount.
652 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
653 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
654 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]655 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]656 # to zero and the currency code is set to match the
657 # currency code of max_compensation.
658 "nanos": 42, # Number of nano (10^-9) units of the amount.
659 # The value must be between -999,999,999 and +999,999,999 inclusive.
660 # If `units` is positive, `nanos` must be positive or zero.
661 # If `units` is zero, `nanos` can be positive, zero, or negative.
662 # If `units` is negative, `nanos` must be negative or zero.
663 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
664 "units": "A String", # The whole units of the amount.
665 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
666 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
667 },
668 },
669 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
670 #
671 # Optional.
672 #
673 # A lower bound on a range for compensation or pay for the job.
674 # The currency type is specified in compensation_amount.
675 "nanos": 42, # Number of nano (10^-9) units of the amount.
676 # The value must be between -999,999,999 and +999,999,999 inclusive.
677 # If `units` is positive, `nanos` must be positive or zero.
678 # If `units` is zero, `nanos` can be positive, zero, or negative.
679 # If `units` is negative, `nanos` must be negative or zero.
680 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
681 "units": "A String", # The whole units of the amount.
682 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
683 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
684 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]685 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]686 # all compensation entries' CompensationEntry.compensation times
687 # CompensationEntry.expected_units_per_year.
688 #
689 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]690 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]691 # to a maximal compensation value and the currency code is set to
692 # match the currency code of
693 # min_compensation.
694 "nanos": 42, # Number of nano (10^-9) units of the amount.
695 # The value must be between -999,999,999 and +999,999,999 inclusive.
696 # If `units` is positive, `nanos` must be positive or zero.
697 # If `units` is zero, `nanos` can be positive, zero, or negative.
698 # If `units` is negative, `nanos` must be negative or zero.
699 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
700 "units": "A String", # The whole units of the amount.
701 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
702 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
703 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]704 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]705 # to zero and the currency code is set to match the
706 # currency code of max_compensation.
707 "nanos": 42, # Number of nano (10^-9) units of the amount.
708 # The value must be between -999,999,999 and +999,999,999 inclusive.
709 # If `units` is positive, `nanos` must be positive or zero.
710 # If `units` is zero, `nanos` can be positive, zero, or negative.
711 # If `units` is negative, `nanos` must be negative or zero.
712 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
713 "units": "A String", # The whole units of the amount.
714 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
715 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
716 },
717 },
718 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
719 #
720 # Optional.
721 #
722 # An upper bound on a range for compensation or pay for the job.
723 # The currency type is specified in compensation_amount.
724 "nanos": 42, # Number of nano (10^-9) units of the amount.
725 # The value must be between -999,999,999 and +999,999,999 inclusive.
726 # If `units` is positive, `nanos` must be positive or zero.
727 # If `units` is zero, `nanos` can be positive, zero, or negative.
728 # If `units` is negative, `nanos` must be negative or zero.
729 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
730 "units": "A String", # The whole units of the amount.
731 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
732 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
733 },
734 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
735 #
736 # Optional.
737 #
738 # The amount of compensation or pay for the job.
739 # As an alternative, compensation_amount_min and
740 # compensation_amount_max may be used to define a range of
741 # compensation.
742 "nanos": 42, # Number of nano (10^-9) units of the amount.
743 # The value must be between -999,999,999 and +999,999,999 inclusive.
744 # If `units` is positive, `nanos` must be positive or zero.
745 # If `units` is zero, `nanos` can be positive, zero, or negative.
746 # If `units` is negative, `nanos` must be negative or zero.
747 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
748 "units": "A String", # The whole units of the amount.
749 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
750 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
751 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]752 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]753 #
754 # At most one entry can be of type
755 # CompensationInfo.CompensationType.BASE, which is
756 # referred as ** base compensation entry ** for the job.
757 { # A compensation entry that represents one component of compensation, such
758 # as base pay, bonus, or other compensation type.
759 #
760 # Annualization: One compensation entry can be annualized if
761 # - it contains valid amount or range.
762 # - and its expected_units_per_year is set or can be derived.
763 # Its annualized range is determined as (amount or range) times
764 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]765 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]766 # indicate equity terms or provide additional context to an estimated
767 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]768 "range": { # Compensation range. # Optional. Compensation range.
769 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]770 # to a maximal compensation value and the currency code is set to
771 # match the currency code of
772 # min_compensation.
773 "nanos": 42, # Number of nano (10^-9) units of the amount.
774 # The value must be between -999,999,999 and +999,999,999 inclusive.
775 # If `units` is positive, `nanos` must be positive or zero.
776 # If `units` is zero, `nanos` can be positive, zero, or negative.
777 # If `units` is negative, `nanos` must be negative or zero.
778 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
779 "units": "A String", # The whole units of the amount.
780 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
781 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
782 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]783 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]784 # to zero and the currency code is set to match the
785 # currency code of max_compensation.
786 "nanos": 42, # Number of nano (10^-9) units of the amount.
787 # The value must be between -999,999,999 and +999,999,999 inclusive.
788 # If `units` is positive, `nanos` must be positive or zero.
789 # If `units` is zero, `nanos` can be positive, zero, or negative.
790 # If `units` is negative, `nanos` must be negative or zero.
791 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
792 "units": "A String", # The whole units of the amount.
793 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
794 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
795 },
796 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]797 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]798 # Job.employment_types is FULLTIME, a default value is inferred
799 # based on unit. Default values:
800 # - HOURLY: 2080
801 # - DAILY: 260
802 # - WEEKLY: 52
803 # - MONTHLY: 12
804 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]805 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]806 "nanos": 42, # Number of nano (10^-9) units of the amount.
807 # The value must be between -999,999,999 and +999,999,999 inclusive.
808 # If `units` is positive, `nanos` must be positive or zero.
809 # If `units` is zero, `nanos` can be positive, zero, or negative.
810 # If `units` is negative, `nanos` must be negative or zero.
811 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
812 "units": "A String", # The whole units of the amount.
813 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
814 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
815 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]816 "type": "A String", # Required. Compensation type.
817 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]818 #
819 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
820 },
821 ],
822 "type": "A String", # Deprecated. Use entries instead.
823 #
824 # Optional.
825 #
826 # Type of job compensation.
827 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]828 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]829 # position.
830 #
831 # The maximum number of allowed characters is 255.
832 "applicationInstruction": "A String", # Optional but at least one of application_urls,
833 # application_email_list or application_instruction must be
834 # specified.
835 #
836 # Use this field to provide instructions, such as "Mail your application
837 # to ...", that a candidate can follow to apply for the job.
838 #
839 # This field accepts and sanitizes HTML input, and also accepts
840 # bold, italic, ordered list, and unordered list markup tags.
841 #
842 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]843 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
844 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]845 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]846 # The maximum number of allowed characters is 10,000.
847 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]848 # description of the company and related information. Separate fields are
849 # provided on the job object for responsibilities,
850 # qualifications, and other job characteristics. Use of
851 # these separate job fields is recommended.
852 #
853 # This field accepts and sanitizes HTML input, and also accepts
854 # bold, italic, ordered list, and unordered list markup tags.
855 #
856 # The maximum number of allowed characters is 100,000.
857 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
858 # provided.
859 #
860 # The resource name of the company listing the job, such as
861 # /companies/foo. This field takes precedence over the
862 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]863 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]864 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]865 # The maximum number of allowed characters is 500.
866 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]867 # client to identify a job. This field is intended to be used by clients
868 # for client identification and tracking of listings. A job is not allowed
869 # to be created if there is another job with the same requisition_id,
870 # company_name and language_code.
871 #
872 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]873 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]874 # job. The use of this field is recommended
875 # as an alternative to using the more general description field.
876 #
877 # This field accepts and sanitizes HTML input, and also accepts
878 # bold, italic, ordered list, and unordered list markup tags.
879 #
880 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]881 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]882 # Defaults to JobVisibility.PRIVATE if not specified.
883 # Currently only JobVisibility.PRIVATE is supported.
884 "expireTime": "A String", # Optional but strongly recommended for the best service
885 # experience.
886 #
887 # The expiration timestamp of the job. After this timestamp, the
888 # job is marked as expired, and it no longer appears in search results. The
889 # expired job can't be deleted or listed by the DeleteJob and
890 # ListJobs APIs, but it can be retrieved with the GetJob API or
891 # updated with the UpdateJob API. An expired job can be updated and
892 # opened again by using a future expiration timestamp. Updating an expired
893 # job fails if there is another existing open job with same
894 # requisition_id, company_name and language_code.
895 #
896 # The expired jobs are retained in our system for 90 days. However, the
897 # overall expired job count cannot exceed 3 times the maximum of open jobs
898 # count over the past week, otherwise jobs with earlier expire time are
899 # cleaned first. Expired jobs are no longer accessible after they are cleaned
900 # out.
901 # The format of this field is RFC 3339 date strings. Example:
902 # 2000-01-01T00:00:00.999999999Z
903 # See
904 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
905 #
906 # A valid date range is between 1970-01-01T00:00:00.0Z and
907 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
908 # time not provided.
909 #
910 # If this value is not provided at the time of job creation or is invalid,
911 # the job posting expires after 30 days from the job's creation time. For
912 # example, if the job was created on 2017/01/01 13:00AM UTC with an
913 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
914 #
915 # If this value is not provided but expiry_date is, expiry_date is
916 # used.
917 #
918 # If this value is not provided on job update, it depends on the field masks
919 # set by UpdateJobRequest.update_job_fields. If the field masks include
920 # expiry_time, or the masks are empty meaning that every field is
921 # updated, the job posting expires after 30 days from the job's last
922 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]923 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]924 # value is the time the request arrives at the server.
925 # and time zone are either specified elsewhere or are not significant. The date
926 # is relative to the Proleptic Gregorian Calendar. This can represent:
927 #
928 # * A full date, with non-zero year, month and day values
929 # * A month and day value, with a zero year, e.g. an anniversary
930 # * A year on its own, with zero month and day values
931 # * A year and month value, with a zero day, e.g. a credit card expiration date
932 #
933 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
934 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
935 # month and day.
936 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
937 # if specifying a year by itself or a year and month where the day is not
938 # significant.
939 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
940 # a year.
941 },
942 "applicationEmailList": [ # Optional but at least one of application_urls,
943 # application_email_list or application_instruction must be
944 # specified.
945 #
946 # Use this field to specify email address(es) to which resumes or
947 # applications can be sent.
948 #
949 # The maximum number of allowed characters is 255.
950 "A String",
951 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]952 "createTime": "A String", # Output only. The timestamp when this job was created.
953 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]954 "A String",
955 ],
956 "name": "A String", # Required during job update.
957 #
958 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
959 # of this field in job queries and API calls is preferred over the use of
960 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]961 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]962 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
963 #
964 # Output only.
965 #
966 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]967 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]968 # is available. If this field is set, a
969 # LocationFilter in a search query within the job region
970 # finds this job if an exact location match is not specified.
971 # If this field is set, setting job locations
972 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]973 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]974 # The value determines the sort order of the jobs returned when searching for
975 # jobs using the featured jobs search call, with higher promotional values
976 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]977 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 #
979 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]980 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
981 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]982 # attributes that are not covered by the provided structured fields.
983 #
984 # This field is a more general combination of the deprecated id-based
985 # filterable_custom_fields and string-based
986 # non_filterable_custom_fields.
987 #
988 # The keys of the map are strings up to 64 bytes and must match the
989 # pattern: a-zA-Z*.
990 #
991 # At most 100 filterable and at most 100 unfilterable keys are supported.
992 # For filterable `string_values`, across all keys at most 200 values are
993 # allowed, with each string no more than 255 characters. For unfilterable
994 # `string_values`, the maximum total size of `string_values` across all keys
995 # is 50KB.
996 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]997 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]998 # If false, values are not searchable.
999 #
1000 # Default is false.
1001 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
1002 # be specified.
1003 #
1004 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
1005 # `CASE_INSENSITIVE_MATCH`) search.
1006 # For filterable `string_values`, a maximum total number of 200 values
1007 # is allowed, with each `string_value` has a byte size of no more than
1008 # 255B. For unfilterable `string_values`, the maximum total byte size of
1009 # unfilterable `string_values` is 50KB.
1010 #
1011 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1012 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1013 "A String",
1014 ],
1015 },
1016 "longValue": "A String", # Optional but at least one of string_values or long_value must
1017 # be specified.
1018 #
1019 # This field is used to perform number range search.
1020 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
1021 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
1022 },
1023 },
1024 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
1025 # provided.
1026 #
1027 # A unique company identifier used by job distributors to identify an
1028 # employer's company entity. company_name takes precedence over
1029 # this field, and is the recommended field to use to identify companies.
1030 #
1031 # The maximum number of allowed characters is 255.
1032 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1033 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1034 #
1035 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1036 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1037 #
1038 # * description
1039 # * applicationInstruction
1040 # * incentives
1041 # * qualifications
1042 # * responsibilities
1043 #
1044 # HTML tags in these fields may be stripped if sanitiazation is not disabled.
1045 #
1046 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1047 "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1048 # more precise address for the job.
1049 },
1050 "disableStreetAddressResolution": True or False, # Deprecated. Please use processing_options. This flag is ignored if
1051 # processing_options is set.
1052 #
1053 # Optional.
1054 #
1055 # If set to `true`, the service does not attempt to resolve a
1056 # more precise address for the job.
1057 }
1058
1059 x__xgafv: string, V1 error format.
1060 Allowed values
1061 1 - v1 error format
1062 2 - v2 error format
1063
1064Returns:
1065 An object of the form:
1066
1067 { # A Job resource represents a job posting (also referred to as a "job listing"
1068 # or "job requisition"). A job belongs to a Company, which is the hiring
1069 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1070 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1071 # any requirements for fluency that are associated with the job.
1072 #
1073 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
1074 # For more information, see
1075 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
1076 # class="external" target="_blank" }.
1077 #
1078 # If this field is unspecified and Job.description is present, detected
1079 # language code based on Job.description is assigned, otherwise
1080 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1081 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1082 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
1083 #
1084 # Optional.
1085 #
1086 # A map of fields to hold non-filterable custom job attributes, similar to
1087 # filterable_custom_fields. These fields are distinct in that the data
1088 # in these fields are not indexed. Therefore, the client cannot search
1089 # against them, nor can the client use them to list jobs.
1090 #
1091 # The key of the map can be any valid string.
1092 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1093 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1094 "A String",
1095 ],
1096 },
1097 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1098 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1099 # is used for contracting engagements.
1100 # Dates prior to 1970/1/1 and invalid date formats are ignored.
1101 # and time zone are either specified elsewhere or are not significant. The date
1102 # is relative to the Proleptic Gregorian Calendar. This can represent:
1103 #
1104 # * A full date, with non-zero year, month and day values
1105 # * A month and day value, with a zero year, e.g. an anniversary
1106 # * A year on its own, with zero month and day values
1107 # * A year and month value, with a zero day, e.g. a credit card expiration date
1108 #
1109 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
1110 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1111 # month and day.
1112 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1113 # if specifying a year by itself or a year and month where the day is not
1114 # significant.
1115 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1116 # a year.
1117 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1118 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
1119 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1120 # is used for contracting engagements.
1121 # Dates prior to 1970/1/1 and invalid date formats are ignored.
1122 # and time zone are either specified elsewhere or are not significant. The date
1123 # is relative to the Proleptic Gregorian Calendar. This can represent:
1124 #
1125 # * A full date, with non-zero year, month and day values
1126 # * A month and day value, with a zero year, e.g. an anniversary
1127 # * A year on its own, with zero month and day values
1128 # * A year and month value, with a zero day, e.g. a credit card expiration date
1129 #
1130 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
1131 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1132 # month and day.
1133 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1134 # if specifying a year by itself or a year and month where the day is not
1135 # significant.
1136 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1137 # a year.
1138 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1139 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1140 { # Output only.
1141 #
1142 # A resource that represents a location with full geographic
1143 # information.
1144 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
1145 # location bounding box in which a circle with the specified radius
1146 # centered from LatLng coves the area associated with the job location.
1147 # For example, currently, "Mountain View, CA, USA" has a radius of
1148 # 7885.79 meters.
1149 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
1150 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
1151 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
1152 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1153 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
1154 # of doubles representing degrees latitude and degrees longitude. Unless
1155 # specified otherwise, this must conform to the
1156 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
1157 # standard&lt;/a&gt;. Values must be within normalized ranges.
1158 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
1159 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
1160 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1161 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
1162 # such as postal delivery and payments addresses. Given a postal address,
1163 # a postal service can deliver items to a premises, P.O. Box, or other
1164 # delivery location.
1165 # Given a postal address, a postal service can deliver items to a premise, P.O.
1166 # Box or similar.
1167 # It is not intended to model geographical locations (roads, towns,
1168 # mountains).
1169 #
1170 # In typical usage an address would be created via user input or from importing
1171 # existing data, depending on the type of process.
1172 #
1173 # Advice on address input / editing:
1174 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1175 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1176 # - Users should not be presented with UI elements for input or editing of
1177 # fields outside countries where that field is used.
1178 #
1179 # For more guidance on how to use this schema, please see:
1180 # https://support.google.com/business/answer/6397478
1181 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
1182 # known). This is often the UI language of the input form or is expected
1183 # to match one of the languages used in the address' country/region, or their
1184 # transliterated equivalents.
1185 # This can affect formatting in certain countries, but is not critical
1186 # to the correctness of the data and will never affect any validation or
1187 # other non-formatting related operations.
1188 #
1189 # If this value is not known, it should be omitted (rather than specifying a
1190 # possibly incorrect default).
1191 #
1192 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
1193 "recipients": [ # Optional. The recipient at the address.
1194 # This field may, under certain circumstances, contain multiline information.
1195 # For example, it might contain "care of" information.
1196 "A String",
1197 ],
1198 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
1199 # Examples: US city, IT comune, UK post town.
1200 # In regions of the world where localities are not well defined or do not fit
1201 # into this structure well, leave locality empty and use address_lines.
1202 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
1203 # in most regions. Where it is used, the value is either a string like
1204 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
1205 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
1206 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
1207 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
1208 # is never inferred and it is up to the user to ensure the value is
1209 # correct. See http://cldr.unicode.org/ and
1210 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
1211 # for details. Example: "CH" for Switzerland.
1212 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
1213 # addresses of a country or region.
1214 # For example, this can be a state, a province, an oblast, or a prefecture.
1215 # Specifically, for Spain this is the province and not the autonomous
1216 # community (e.g. "Barcelona" and not "Catalonia").
1217 # Many countries don't use an administrative area in postal addresses. E.g.
1218 # in Switzerland this should be left unpopulated.
1219 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
1220 #
1221 # Because values in address_lines do not have type information and may
1222 # sometimes contain multiple values in a single field (e.g.
1223 # "Austin, TX"), it is important that the line order is clear. The order of
1224 # address lines should be "envelope order" for the country/region of the
1225 # address. In places where this can vary (e.g. Japan), address_language is
1226 # used to make it explicit (e.g. "ja" for large-to-small ordering and
1227 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
1228 # an address can be selected based on the language.
1229 #
1230 # The minimum permitted structural representation of an address consists
1231 # of a region_code with all remaining information placed in the
1232 # address_lines. It would be possible to format such an address very
1233 # approximately without geocoding, but no semantic reasoning could be
1234 # made about any of the address components until it was at least
1235 # partially resolved.
1236 #
1237 # Creating an address only containing a region_code and address_lines, and
1238 # then geocoding is the recommended way to handle completely unstructured
1239 # addresses (as opposed to guessing which parts of the address should be
1240 # localities or administrative areas).
1241 "A String",
1242 ],
1243 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
1244 # postal codes to be present, but where they are used, they may trigger
1245 # additional validation with other parts of the address (e.g. state/zip
1246 # validation in the U.S.A.).
1247 "organization": "A String", # Optional. The name of the organization at the address.
1248 "sublocality": "A String", # Optional. Sublocality of the address.
1249 # For example, this can be neighborhoods, boroughs, districts.
1250 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
1251 # the latest revision.
1252 #
1253 # All new revisions **must** be backward compatible with old revisions.
1254 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1255 },
1256 ],
1257 "locations": [ # Optional but strongly recommended for the best service experience.
1258 #
1259 # Location(s) where the emploeyer is looking to hire for this job posting.
1260 #
1261 # Specifying the full street address(es) of the hiring location enables
1262 # better API results, especially job searches by commute time.
1263 #
1264 # At most 50 locations are allowed for best search performance. If a job has
1265 # more locations, it is suggested to split it into multiple jobs with unique
1266 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
1267 # multiple jobs with the same requisition_id, company_name and
1268 # language_code are not allowed. If the original requisition_id must
1269 # be preserved, a custom field should be used for storage. It is also
1270 # suggested to group the locations that close to each other in the same job
1271 # for better search experience.
1272 #
1273 # The maximum number of allowed characters is 500.
1274 "A String",
1275 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1276 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1277 # full time or
1278 # part time.
1279 "A String",
1280 ],
1281 "applicationUrls": [ # Optional but at least one of application_urls,
1282 # application_email_list or application_instruction must be
1283 # specified.
1284 #
1285 # Use this URL field to direct an applicant to a website, for example to
1286 # link to an online application form.
1287 #
1288 # The maximum number of allowed characters is 2,000.
1289 "A String",
1290 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1291 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1292 # "Bachelors", "Masters", "Doctorate".
1293 "A String",
1294 ],
1295 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
1296 #
1297 # Optional.
1298 #
1299 # Job compensation information.
1300 #
1301 # This field replaces compensation_info. Only
1302 # CompensationInfo.entries or extended_compensation_info can be set,
1303 # otherwise an exception is thrown.
1304 #
1305 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1306 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1307 # the job's all CompensationEntry cannot be annualized.
1308 # See CompensationEntry for explanation on annualization and base
1309 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1310 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1311 #
1312 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1313 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1314 #
1315 # Decimal number.
1316 "units": "A String", # Whole units.
1317 "micros": 42, # Micro (10^-6) units.
1318 # The value must be between -999,999 and +999,999 inclusive.
1319 # If `units` is positive, `micros` must be positive or zero.
1320 # If `units` is zero, `micros` can be positive, zero, or negative.
1321 # If `units` is negative, `micros` must be negative or zero.
1322 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1323 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1324 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1325 #
1326 # Decimal number.
1327 "units": "A String", # Whole units.
1328 "micros": 42, # Micro (10^-6) units.
1329 # The value must be between -999,999 and +999,999 inclusive.
1330 # If `units` is positive, `micros` must be positive or zero.
1331 # If `units` is zero, `micros` can be positive, zero, or negative.
1332 # If `units` is negative, `micros` must be negative or zero.
1333 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1334 },
1335 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1336 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1337 #
1338 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1339 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1340 #
1341 # Decimal number.
1342 "units": "A String", # Whole units.
1343 "micros": 42, # Micro (10^-6) units.
1344 # The value must be between -999,999 and +999,999 inclusive.
1345 # If `units` is positive, `micros` must be positive or zero.
1346 # If `units` is zero, `micros` can be positive, zero, or negative.
1347 # If `units` is negative, `micros` must be negative or zero.
1348 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1349 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1350 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1351 #
1352 # Decimal number.
1353 "units": "A String", # Whole units.
1354 "micros": 42, # Micro (10^-6) units.
1355 # The value must be between -999,999 and +999,999 inclusive.
1356 # If `units` is positive, `micros` must be positive or zero.
1357 # If `units` is zero, `micros` can be positive, zero, or negative.
1358 # If `units` is negative, `micros` must be negative or zero.
1359 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1360 },
1361 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1362 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1363 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1364 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1365 # the job's base compensation entry cannot be annualized.
1366 # See CompensationEntry for explanation on annualization and base
1367 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1368 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1369 #
1370 # At most one entry can be of type
1371 # ExtendedCompensationInfo.CompensationType.BASE, which is
1372 # referred as ** base compensation entry ** for the job.
1373 { # Deprecated. See CompensationInfo.
1374 #
1375 # A compensation entry that represents one component of compensation, such
1376 # as base pay, bonus, or other compensation type.
1377 #
1378 # Annualization: One compensation entry can be annualized if
1379 # - it contains valid amount or range.
1380 # - and its expected_units_per_year is set or can be derived.
1381 # Its annualized range is determined as (amount or range) times
1382 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1383 "description": "A String", # Optional. Compensation description.
1384 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1385 #
1386 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1387 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1388 #
1389 # Decimal number.
1390 "units": "A String", # Whole units.
1391 "micros": 42, # Micro (10^-6) units.
1392 # The value must be between -999,999 and +999,999 inclusive.
1393 # If `units` is positive, `micros` must be positive or zero.
1394 # If `units` is zero, `micros` can be positive, zero, or negative.
1395 # If `units` is negative, `micros` must be negative or zero.
1396 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1397 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1398 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1399 #
1400 # Decimal number.
1401 "units": "A String", # Whole units.
1402 "micros": 42, # Micro (10^-6) units.
1403 # The value must be between -999,999 and +999,999 inclusive.
1404 # If `units` is positive, `micros` must be positive or zero.
1405 # If `units` is zero, `micros` can be positive, zero, or negative.
1406 # If `units` is negative, `micros` must be negative or zero.
1407 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1408 },
1409 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1410 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
1411 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1412 # Job.employment_types is FULLTIME, a default value is inferred
1413 # based on unit. Default values:
1414 # - HOURLY: 2080
1415 # - DAILY: 260
1416 # - WEEKLY: 52
1417 # - MONTHLY: 12
1418 # - ANNUAL: 1
1419 #
1420 # Decimal number.
1421 "units": "A String", # Whole units.
1422 "micros": 42, # Micro (10^-6) units.
1423 # The value must be between -999,999 and +999,999 inclusive.
1424 # If `units` is positive, `micros` must be positive or zero.
1425 # If `units` is zero, `micros` can be positive, zero, or negative.
1426 # If `units` is negative, `micros` must be negative or zero.
1427 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1428 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1429 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1430 #
1431 # Decimal number.
1432 "units": "A String", # Whole units.
1433 "micros": 42, # Micro (10^-6) units.
1434 # The value must be between -999,999 and +999,999 inclusive.
1435 # If `units` is positive, `micros` must be positive or zero.
1436 # If `units` is zero, `micros` can be positive, zero, or negative.
1437 # If `units` is negative, `micros` must be negative or zero.
1438 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
1439 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1440 "type": "A String", # Required. Compensation type.
1441 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1442 #
1443 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
1444 },
1445 ],
1446 },
1447 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
1448 #
1449 # Optional.
1450 #
1451 # A map of fields to hold filterable custom job attributes not captured by
1452 # the standard fields such as job_title, company_name, or
1453 # level. These custom fields store arbitrary
1454 # string values, and can be used for purposes not covered by
1455 # the structured fields. For the best search experience, use of the
1456 # structured rather than custom fields is recommended.
1457 #
1458 # Data stored in these custom fields fields are indexed and
1459 # searched against by keyword searches (see
1460 # SearchJobsRequest.custom_field_filters][]).
1461 #
1462 # The map key must be a number between 1-20. If an invalid key is
1463 # provided on job create or update, an error is returned.
1464 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1465 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1466 "A String",
1467 ],
1468 },
1469 },
1470 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
1471 #
1472 # Optional but strongly recommended to be provided for the best service
1473 # experience.
1474 #
1475 # The expiration date of the job in UTC time. After 12 am on this date, the
1476 # job is marked as expired, and it no longer appears in search results.
1477 # The expired job can't be deleted or listed by the DeleteJob and
1478 # ListJobs APIs, but it can be retrieved with the GetJob API or
1479 # updated with the UpdateJob API. An expired job can be updated and
1480 # opened again by using a future expiration date. It can also remain expired.
1481 # Updating an expired job to be open fails if there is another existing open
1482 # job with same requisition_id, company_name and language_code.
1483 #
1484 # The expired jobs are retained in our system for 90 days. However, the
1485 # overall expired job count cannot exceed 3 times the maximum of open jobs
1486 # count over the past week, otherwise jobs with earlier expire time are
1487 # removed first. Expired jobs are no longer accessible after they are cleaned
1488 # out.
1489 #
1490 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
1491 # ignored and treated as expiry date not provided.
1492 #
1493 # If this value is not provided on job creation or is invalid, the job
1494 # posting expires after 30 days from the job's creation time. For example, if
1495 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
1496 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
1497 #
1498 # If this value is not provided on job update, it depends on the field masks
1499 # set by UpdateJobRequest.update_job_fields. If the field masks include
1500 # expiry_date, or the masks are empty meaning that every field is
1501 # updated, the job expires after 30 days from the job's last update time.
1502 # Otherwise the expiration date isn't updated.
1503 # and time zone are either specified elsewhere or are not significant. The date
1504 # is relative to the Proleptic Gregorian Calendar. This can represent:
1505 #
1506 # * A full date, with non-zero year, month and day values
1507 # * A month and day value, with a zero year, e.g. an anniversary
1508 # * A year on its own, with zero month and day values
1509 # * A year and month value, with a zero day, e.g. a credit card expiration date
1510 #
1511 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
1512 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1513 # month and day.
1514 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1515 # if specifying a year by itself or a year and month where the day is not
1516 # significant.
1517 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1518 # a year.
1519 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1520 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1521 # recommended as an alternative to using the more general description
1522 # field.
1523 #
1524 # This field accepts and sanitizes HTML input, and also accepts
1525 # bold, italic, ordered list, and unordered list markup tags.
1526 #
1527 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1528 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
1529 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1530 # base compensation entry's CompensationEntry.compensation times
1531 # CompensationEntry.expected_units_per_year.
1532 #
1533 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1534 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1535 # to a maximal compensation value and the currency code is set to
1536 # match the currency code of
1537 # min_compensation.
1538 "nanos": 42, # Number of nano (10^-9) units of the amount.
1539 # The value must be between -999,999,999 and +999,999,999 inclusive.
1540 # If `units` is positive, `nanos` must be positive or zero.
1541 # If `units` is zero, `nanos` can be positive, zero, or negative.
1542 # If `units` is negative, `nanos` must be negative or zero.
1543 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1544 "units": "A String", # The whole units of the amount.
1545 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1546 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1547 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1548 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1549 # to zero and the currency code is set to match the
1550 # currency code of max_compensation.
1551 "nanos": 42, # Number of nano (10^-9) units of the amount.
1552 # The value must be between -999,999,999 and +999,999,999 inclusive.
1553 # If `units` is positive, `nanos` must be positive or zero.
1554 # If `units` is zero, `nanos` can be positive, zero, or negative.
1555 # If `units` is negative, `nanos` must be negative or zero.
1556 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1557 "units": "A String", # The whole units of the amount.
1558 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1559 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1560 },
1561 },
1562 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
1563 #
1564 # Optional.
1565 #
1566 # A lower bound on a range for compensation or pay for the job.
1567 # The currency type is specified in compensation_amount.
1568 "nanos": 42, # Number of nano (10^-9) units of the amount.
1569 # The value must be between -999,999,999 and +999,999,999 inclusive.
1570 # If `units` is positive, `nanos` must be positive or zero.
1571 # If `units` is zero, `nanos` can be positive, zero, or negative.
1572 # If `units` is negative, `nanos` must be negative or zero.
1573 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1574 "units": "A String", # The whole units of the amount.
1575 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1576 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1577 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1578 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1579 # all compensation entries' CompensationEntry.compensation times
1580 # CompensationEntry.expected_units_per_year.
1581 #
1582 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1583 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1584 # to a maximal compensation value and the currency code is set to
1585 # match the currency code of
1586 # min_compensation.
1587 "nanos": 42, # Number of nano (10^-9) units of the amount.
1588 # The value must be between -999,999,999 and +999,999,999 inclusive.
1589 # If `units` is positive, `nanos` must be positive or zero.
1590 # If `units` is zero, `nanos` can be positive, zero, or negative.
1591 # If `units` is negative, `nanos` must be negative or zero.
1592 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1593 "units": "A String", # The whole units of the amount.
1594 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1595 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1596 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1597 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1598 # to zero and the currency code is set to match the
1599 # currency code of max_compensation.
1600 "nanos": 42, # Number of nano (10^-9) units of the amount.
1601 # The value must be between -999,999,999 and +999,999,999 inclusive.
1602 # If `units` is positive, `nanos` must be positive or zero.
1603 # If `units` is zero, `nanos` can be positive, zero, or negative.
1604 # If `units` is negative, `nanos` must be negative or zero.
1605 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1606 "units": "A String", # The whole units of the amount.
1607 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1608 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1609 },
1610 },
1611 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
1612 #
1613 # Optional.
1614 #
1615 # An upper bound on a range for compensation or pay for the job.
1616 # The currency type is specified in compensation_amount.
1617 "nanos": 42, # Number of nano (10^-9) units of the amount.
1618 # The value must be between -999,999,999 and +999,999,999 inclusive.
1619 # If `units` is positive, `nanos` must be positive or zero.
1620 # If `units` is zero, `nanos` can be positive, zero, or negative.
1621 # If `units` is negative, `nanos` must be negative or zero.
1622 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1623 "units": "A String", # The whole units of the amount.
1624 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1625 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1626 },
1627 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
1628 #
1629 # Optional.
1630 #
1631 # The amount of compensation or pay for the job.
1632 # As an alternative, compensation_amount_min and
1633 # compensation_amount_max may be used to define a range of
1634 # compensation.
1635 "nanos": 42, # Number of nano (10^-9) units of the amount.
1636 # The value must be between -999,999,999 and +999,999,999 inclusive.
1637 # If `units` is positive, `nanos` must be positive or zero.
1638 # If `units` is zero, `nanos` can be positive, zero, or negative.
1639 # If `units` is negative, `nanos` must be negative or zero.
1640 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1641 "units": "A String", # The whole units of the amount.
1642 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1643 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1644 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1645 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1646 #
1647 # At most one entry can be of type
1648 # CompensationInfo.CompensationType.BASE, which is
1649 # referred as ** base compensation entry ** for the job.
1650 { # A compensation entry that represents one component of compensation, such
1651 # as base pay, bonus, or other compensation type.
1652 #
1653 # Annualization: One compensation entry can be annualized if
1654 # - it contains valid amount or range.
1655 # - and its expected_units_per_year is set or can be derived.
1656 # Its annualized range is determined as (amount or range) times
1657 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1658 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1659 # indicate equity terms or provide additional context to an estimated
1660 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1661 "range": { # Compensation range. # Optional. Compensation range.
1662 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1663 # to a maximal compensation value and the currency code is set to
1664 # match the currency code of
1665 # min_compensation.
1666 "nanos": 42, # Number of nano (10^-9) units of the amount.
1667 # The value must be between -999,999,999 and +999,999,999 inclusive.
1668 # If `units` is positive, `nanos` must be positive or zero.
1669 # If `units` is zero, `nanos` can be positive, zero, or negative.
1670 # If `units` is negative, `nanos` must be negative or zero.
1671 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1672 "units": "A String", # The whole units of the amount.
1673 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1674 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1675 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1676 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1677 # to zero and the currency code is set to match the
1678 # currency code of max_compensation.
1679 "nanos": 42, # Number of nano (10^-9) units of the amount.
1680 # The value must be between -999,999,999 and +999,999,999 inclusive.
1681 # If `units` is positive, `nanos` must be positive or zero.
1682 # If `units` is zero, `nanos` can be positive, zero, or negative.
1683 # If `units` is negative, `nanos` must be negative or zero.
1684 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1685 "units": "A String", # The whole units of the amount.
1686 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1687 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1688 },
1689 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1690 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1691 # Job.employment_types is FULLTIME, a default value is inferred
1692 # based on unit. Default values:
1693 # - HOURLY: 2080
1694 # - DAILY: 260
1695 # - WEEKLY: 52
1696 # - MONTHLY: 12
1697 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1698 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1699 "nanos": 42, # Number of nano (10^-9) units of the amount.
1700 # The value must be between -999,999,999 and +999,999,999 inclusive.
1701 # If `units` is positive, `nanos` must be positive or zero.
1702 # If `units` is zero, `nanos` can be positive, zero, or negative.
1703 # If `units` is negative, `nanos` must be negative or zero.
1704 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1705 "units": "A String", # The whole units of the amount.
1706 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1707 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1708 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1709 "type": "A String", # Required. Compensation type.
1710 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1711 #
1712 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
1713 },
1714 ],
1715 "type": "A String", # Deprecated. Use entries instead.
1716 #
1717 # Optional.
1718 #
1719 # Type of job compensation.
1720 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1721 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1722 # position.
1723 #
1724 # The maximum number of allowed characters is 255.
1725 "applicationInstruction": "A String", # Optional but at least one of application_urls,
1726 # application_email_list or application_instruction must be
1727 # specified.
1728 #
1729 # Use this field to provide instructions, such as "Mail your application
1730 # to ...", that a candidate can follow to apply for the job.
1731 #
1732 # This field accepts and sanitizes HTML input, and also accepts
1733 # bold, italic, ordered list, and unordered list markup tags.
1734 #
1735 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1736 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
1737 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1738 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1739 # The maximum number of allowed characters is 10,000.
1740 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1741 # description of the company and related information. Separate fields are
1742 # provided on the job object for responsibilities,
1743 # qualifications, and other job characteristics. Use of
1744 # these separate job fields is recommended.
1745 #
1746 # This field accepts and sanitizes HTML input, and also accepts
1747 # bold, italic, ordered list, and unordered list markup tags.
1748 #
1749 # The maximum number of allowed characters is 100,000.
1750 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
1751 # provided.
1752 #
1753 # The resource name of the company listing the job, such as
1754 # /companies/foo. This field takes precedence over the
1755 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1756 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1757 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1758 # The maximum number of allowed characters is 500.
1759 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1760 # client to identify a job. This field is intended to be used by clients
1761 # for client identification and tracking of listings. A job is not allowed
1762 # to be created if there is another job with the same requisition_id,
1763 # company_name and language_code.
1764 #
1765 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1766 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1767 # job. The use of this field is recommended
1768 # as an alternative to using the more general description field.
1769 #
1770 # This field accepts and sanitizes HTML input, and also accepts
1771 # bold, italic, ordered list, and unordered list markup tags.
1772 #
1773 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1774 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1775 # Defaults to JobVisibility.PRIVATE if not specified.
1776 # Currently only JobVisibility.PRIVATE is supported.
1777 "expireTime": "A String", # Optional but strongly recommended for the best service
1778 # experience.
1779 #
1780 # The expiration timestamp of the job. After this timestamp, the
1781 # job is marked as expired, and it no longer appears in search results. The
1782 # expired job can't be deleted or listed by the DeleteJob and
1783 # ListJobs APIs, but it can be retrieved with the GetJob API or
1784 # updated with the UpdateJob API. An expired job can be updated and
1785 # opened again by using a future expiration timestamp. Updating an expired
1786 # job fails if there is another existing open job with same
1787 # requisition_id, company_name and language_code.
1788 #
1789 # The expired jobs are retained in our system for 90 days. However, the
1790 # overall expired job count cannot exceed 3 times the maximum of open jobs
1791 # count over the past week, otherwise jobs with earlier expire time are
1792 # cleaned first. Expired jobs are no longer accessible after they are cleaned
1793 # out.
1794 # The format of this field is RFC 3339 date strings. Example:
1795 # 2000-01-01T00:00:00.999999999Z
1796 # See
1797 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
1798 #
1799 # A valid date range is between 1970-01-01T00:00:00.0Z and
1800 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
1801 # time not provided.
1802 #
1803 # If this value is not provided at the time of job creation or is invalid,
1804 # the job posting expires after 30 days from the job's creation time. For
1805 # example, if the job was created on 2017/01/01 13:00AM UTC with an
1806 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
1807 #
1808 # If this value is not provided but expiry_date is, expiry_date is
1809 # used.
1810 #
1811 # If this value is not provided on job update, it depends on the field masks
1812 # set by UpdateJobRequest.update_job_fields. If the field masks include
1813 # expiry_time, or the masks are empty meaning that every field is
1814 # updated, the job posting expires after 30 days from the job's last
1815 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1816 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1817 # value is the time the request arrives at the server.
1818 # and time zone are either specified elsewhere or are not significant. The date
1819 # is relative to the Proleptic Gregorian Calendar. This can represent:
1820 #
1821 # * A full date, with non-zero year, month and day values
1822 # * A month and day value, with a zero year, e.g. an anniversary
1823 # * A year on its own, with zero month and day values
1824 # * A year and month value, with a zero day, e.g. a credit card expiration date
1825 #
1826 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
1827 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1828 # month and day.
1829 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1830 # if specifying a year by itself or a year and month where the day is not
1831 # significant.
1832 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1833 # a year.
1834 },
1835 "applicationEmailList": [ # Optional but at least one of application_urls,
1836 # application_email_list or application_instruction must be
1837 # specified.
1838 #
1839 # Use this field to specify email address(es) to which resumes or
1840 # applications can be sent.
1841 #
1842 # The maximum number of allowed characters is 255.
1843 "A String",
1844 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1845 "createTime": "A String", # Output only. The timestamp when this job was created.
1846 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1847 "A String",
1848 ],
1849 "name": "A String", # Required during job update.
1850 #
1851 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
1852 # of this field in job queries and API calls is preferred over the use of
1853 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1854 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1855 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
1856 #
1857 # Output only.
1858 #
1859 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1860 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1861 # is available. If this field is set, a
1862 # LocationFilter in a search query within the job region
1863 # finds this job if an exact location match is not specified.
1864 # If this field is set, setting job locations
1865 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1866 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1867 # The value determines the sort order of the jobs returned when searching for
1868 # jobs using the featured jobs search call, with higher promotional values
1869 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1870 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1871 #
1872 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1873 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
1874 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1875 # attributes that are not covered by the provided structured fields.
1876 #
1877 # This field is a more general combination of the deprecated id-based
1878 # filterable_custom_fields and string-based
1879 # non_filterable_custom_fields.
1880 #
1881 # The keys of the map are strings up to 64 bytes and must match the
1882 # pattern: a-zA-Z*.
1883 #
1884 # At most 100 filterable and at most 100 unfilterable keys are supported.
1885 # For filterable `string_values`, across all keys at most 200 values are
1886 # allowed, with each string no more than 255 characters. For unfilterable
1887 # `string_values`, the maximum total size of `string_values` across all keys
1888 # is 50KB.
1889 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1890 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1891 # If false, values are not searchable.
1892 #
1893 # Default is false.
1894 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
1895 # be specified.
1896 #
1897 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
1898 # `CASE_INSENSITIVE_MATCH`) search.
1899 # For filterable `string_values`, a maximum total number of 200 values
1900 # is allowed, with each `string_value` has a byte size of no more than
1901 # 255B. For unfilterable `string_values`, the maximum total byte size of
1902 # unfilterable `string_values` is 50KB.
1903 #
1904 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1905 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1906 "A String",
1907 ],
1908 },
1909 "longValue": "A String", # Optional but at least one of string_values or long_value must
1910 # be specified.
1911 #
1912 # This field is used to perform number range search.
1913 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
1914 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
1915 },
1916 },
1917 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
1918 # provided.
1919 #
1920 # A unique company identifier used by job distributors to identify an
1921 # employer's company entity. company_name takes precedence over
1922 # this field, and is the recommended field to use to identify companies.
1923 #
1924 # The maximum number of allowed characters is 255.
1925 }</pre>
1926</div>
1927
1928<div class="method">
1929 <code class="details" id="delete">delete(name, x__xgafv=None, disableFastProcess=None)</code>
1930 <pre>Deletes the specified job.
1931
1932Typically, the job becomes unsearchable within 10 seconds, but it may take
1933up to 5 minutes.
1934
1935Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1936 name: string, Required. The resource name of the job to be deleted, such as "jobs/11111111". (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1937 x__xgafv: string, V1 error format.
1938 Allowed values
1939 1 - v1 error format
1940 2 - v2 error format
1941 disableFastProcess: boolean, Deprecated. This field is not working anymore.
1942
1943Optional.
1944
1945If set to true, this call waits for all processing steps to complete
1946before the job is cleaned up. Otherwise, the call returns while some
1947steps are still taking place asynchronously, hence faster.
1948
1949Returns:
1950 An object of the form:
1951
1952 { # A generic empty message that you can re-use to avoid defining duplicated
1953 # empty messages in your APIs. A typical example is to use it as the request
1954 # or the response type of an API method. For instance:
1955 #
1956 # service Foo {
1957 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1958 # }
1959 #
1960 # The JSON representation for `Empty` is empty JSON object `{}`.
1961 }</pre>
1962</div>
1963
1964<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1965 <code class="details" id="deleteByFilter">deleteByFilter(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1966 <pre>Deprecated. Use BatchDeleteJobs instead.
1967
1968Deletes the specified job by filter. You can specify whether to
1969synchronously wait for validation, indexing, and general processing to be
1970completed before the response is returned.
1971
1972Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1973 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1974 The object takes the form of:
1975
1976{ # Deprecated. Use BatchDeleteJobsRequest instead.
1977 #
1978 # Input only.
1979 #
1980 # Delete job by filter request.
1981 #
1982 # The job typically becomes unsearchable within 10 seconds, but it may take
1983 # up to 5 minutes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1984 "filter": { # Deprecated. Use BatchDeleteJobsRequest instead. # Required. Restrictions on the scope of the delete request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1985 #
1986 # Input only.
1987 #
1988 # Filter for jobs to be deleted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1989 "requisitionId": "A String", # Required. The requisition ID (or posting ID) assigned by the client to identify a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1990 # job. This is intended for client identification and tracking of
1991 # listings.
1992 # name takes precedence over this field
1993 # The maximum number of allowed characters is 225.
1994 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1995 "disableFastProcess": True or False, # Optional. If set to true, this call waits for all processing steps to complete
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1996 # before the job is cleaned up. Otherwise, the call returns while some
1997 # steps are still taking place asynchronously, hence faster.
1998 }
1999
2000 x__xgafv: string, V1 error format.
2001 Allowed values
2002 1 - v1 error format
2003 2 - v2 error format
2004
2005Returns:
2006 An object of the form:
2007
2008 { # A generic empty message that you can re-use to avoid defining duplicated
2009 # empty messages in your APIs. A typical example is to use it as the request
2010 # or the response type of an API method. For instance:
2011 #
2012 # service Foo {
2013 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
2014 # }
2015 #
2016 # The JSON representation for `Empty` is empty JSON object `{}`.
2017 }</pre>
2018</div>
2019
2020<div class="method">
2021 <code class="details" id="get">get(name, x__xgafv=None)</code>
2022 <pre>Retrieves the specified job, whose status is OPEN or recently EXPIRED
2023within the last 90 days.
2024
2025Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2026 name: string, Required. The resource name of the job to retrieve, such as "jobs/11111111". (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2027 x__xgafv: string, V1 error format.
2028 Allowed values
2029 1 - v1 error format
2030 2 - v2 error format
2031
2032Returns:
2033 An object of the form:
2034
2035 { # A Job resource represents a job posting (also referred to as a "job listing"
2036 # or "job requisition"). A job belongs to a Company, which is the hiring
2037 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2038 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2039 # any requirements for fluency that are associated with the job.
2040 #
2041 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
2042 # For more information, see
2043 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
2044 # class="external" target="_blank" }.
2045 #
2046 # If this field is unspecified and Job.description is present, detected
2047 # language code based on Job.description is assigned, otherwise
2048 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2049 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2050 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
2051 #
2052 # Optional.
2053 #
2054 # A map of fields to hold non-filterable custom job attributes, similar to
2055 # filterable_custom_fields. These fields are distinct in that the data
2056 # in these fields are not indexed. Therefore, the client cannot search
2057 # against them, nor can the client use them to list jobs.
2058 #
2059 # The key of the map can be any valid string.
2060 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2061 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2062 "A String",
2063 ],
2064 },
2065 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2066 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2067 # is used for contracting engagements.
2068 # Dates prior to 1970/1/1 and invalid date formats are ignored.
2069 # and time zone are either specified elsewhere or are not significant. The date
2070 # is relative to the Proleptic Gregorian Calendar. This can represent:
2071 #
2072 # * A full date, with non-zero year, month and day values
2073 # * A month and day value, with a zero year, e.g. an anniversary
2074 # * A year on its own, with zero month and day values
2075 # * A year and month value, with a zero day, e.g. a credit card expiration date
2076 #
2077 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
2078 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2079 # month and day.
2080 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2081 # if specifying a year by itself or a year and month where the day is not
2082 # significant.
2083 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2084 # a year.
2085 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2086 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
2087 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2088 # is used for contracting engagements.
2089 # Dates prior to 1970/1/1 and invalid date formats are ignored.
2090 # and time zone are either specified elsewhere or are not significant. The date
2091 # is relative to the Proleptic Gregorian Calendar. This can represent:
2092 #
2093 # * A full date, with non-zero year, month and day values
2094 # * A month and day value, with a zero year, e.g. an anniversary
2095 # * A year on its own, with zero month and day values
2096 # * A year and month value, with a zero day, e.g. a credit card expiration date
2097 #
2098 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
2099 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2100 # month and day.
2101 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2102 # if specifying a year by itself or a year and month where the day is not
2103 # significant.
2104 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2105 # a year.
2106 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2107 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2108 { # Output only.
2109 #
2110 # A resource that represents a location with full geographic
2111 # information.
2112 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
2113 # location bounding box in which a circle with the specified radius
2114 # centered from LatLng coves the area associated with the job location.
2115 # For example, currently, "Mountain View, CA, USA" has a radius of
2116 # 7885.79 meters.
2117 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
2118 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
2119 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
2120 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2121 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
2122 # of doubles representing degrees latitude and degrees longitude. Unless
2123 # specified otherwise, this must conform to the
2124 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
2125 # standard&lt;/a&gt;. Values must be within normalized ranges.
2126 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
2127 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
2128 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2129 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
2130 # such as postal delivery and payments addresses. Given a postal address,
2131 # a postal service can deliver items to a premises, P.O. Box, or other
2132 # delivery location.
2133 # Given a postal address, a postal service can deliver items to a premise, P.O.
2134 # Box or similar.
2135 # It is not intended to model geographical locations (roads, towns,
2136 # mountains).
2137 #
2138 # In typical usage an address would be created via user input or from importing
2139 # existing data, depending on the type of process.
2140 #
2141 # Advice on address input / editing:
2142 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2143 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2144 # - Users should not be presented with UI elements for input or editing of
2145 # fields outside countries where that field is used.
2146 #
2147 # For more guidance on how to use this schema, please see:
2148 # https://support.google.com/business/answer/6397478
2149 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
2150 # known). This is often the UI language of the input form or is expected
2151 # to match one of the languages used in the address' country/region, or their
2152 # transliterated equivalents.
2153 # This can affect formatting in certain countries, but is not critical
2154 # to the correctness of the data and will never affect any validation or
2155 # other non-formatting related operations.
2156 #
2157 # If this value is not known, it should be omitted (rather than specifying a
2158 # possibly incorrect default).
2159 #
2160 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
2161 "recipients": [ # Optional. The recipient at the address.
2162 # This field may, under certain circumstances, contain multiline information.
2163 # For example, it might contain "care of" information.
2164 "A String",
2165 ],
2166 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
2167 # Examples: US city, IT comune, UK post town.
2168 # In regions of the world where localities are not well defined or do not fit
2169 # into this structure well, leave locality empty and use address_lines.
2170 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
2171 # in most regions. Where it is used, the value is either a string like
2172 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
2173 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
2174 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
2175 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
2176 # is never inferred and it is up to the user to ensure the value is
2177 # correct. See http://cldr.unicode.org/ and
2178 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
2179 # for details. Example: "CH" for Switzerland.
2180 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
2181 # addresses of a country or region.
2182 # For example, this can be a state, a province, an oblast, or a prefecture.
2183 # Specifically, for Spain this is the province and not the autonomous
2184 # community (e.g. "Barcelona" and not "Catalonia").
2185 # Many countries don't use an administrative area in postal addresses. E.g.
2186 # in Switzerland this should be left unpopulated.
2187 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
2188 #
2189 # Because values in address_lines do not have type information and may
2190 # sometimes contain multiple values in a single field (e.g.
2191 # "Austin, TX"), it is important that the line order is clear. The order of
2192 # address lines should be "envelope order" for the country/region of the
2193 # address. In places where this can vary (e.g. Japan), address_language is
2194 # used to make it explicit (e.g. "ja" for large-to-small ordering and
2195 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
2196 # an address can be selected based on the language.
2197 #
2198 # The minimum permitted structural representation of an address consists
2199 # of a region_code with all remaining information placed in the
2200 # address_lines. It would be possible to format such an address very
2201 # approximately without geocoding, but no semantic reasoning could be
2202 # made about any of the address components until it was at least
2203 # partially resolved.
2204 #
2205 # Creating an address only containing a region_code and address_lines, and
2206 # then geocoding is the recommended way to handle completely unstructured
2207 # addresses (as opposed to guessing which parts of the address should be
2208 # localities or administrative areas).
2209 "A String",
2210 ],
2211 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
2212 # postal codes to be present, but where they are used, they may trigger
2213 # additional validation with other parts of the address (e.g. state/zip
2214 # validation in the U.S.A.).
2215 "organization": "A String", # Optional. The name of the organization at the address.
2216 "sublocality": "A String", # Optional. Sublocality of the address.
2217 # For example, this can be neighborhoods, boroughs, districts.
2218 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
2219 # the latest revision.
2220 #
2221 # All new revisions **must** be backward compatible with old revisions.
2222 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2223 },
2224 ],
2225 "locations": [ # Optional but strongly recommended for the best service experience.
2226 #
2227 # Location(s) where the emploeyer is looking to hire for this job posting.
2228 #
2229 # Specifying the full street address(es) of the hiring location enables
2230 # better API results, especially job searches by commute time.
2231 #
2232 # At most 50 locations are allowed for best search performance. If a job has
2233 # more locations, it is suggested to split it into multiple jobs with unique
2234 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
2235 # multiple jobs with the same requisition_id, company_name and
2236 # language_code are not allowed. If the original requisition_id must
2237 # be preserved, a custom field should be used for storage. It is also
2238 # suggested to group the locations that close to each other in the same job
2239 # for better search experience.
2240 #
2241 # The maximum number of allowed characters is 500.
2242 "A String",
2243 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2244 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2245 # full time or
2246 # part time.
2247 "A String",
2248 ],
2249 "applicationUrls": [ # Optional but at least one of application_urls,
2250 # application_email_list or application_instruction must be
2251 # specified.
2252 #
2253 # Use this URL field to direct an applicant to a website, for example to
2254 # link to an online application form.
2255 #
2256 # The maximum number of allowed characters is 2,000.
2257 "A String",
2258 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2259 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2260 # "Bachelors", "Masters", "Doctorate".
2261 "A String",
2262 ],
2263 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
2264 #
2265 # Optional.
2266 #
2267 # Job compensation information.
2268 #
2269 # This field replaces compensation_info. Only
2270 # CompensationInfo.entries or extended_compensation_info can be set,
2271 # otherwise an exception is thrown.
2272 #
2273 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2274 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2275 # the job's all CompensationEntry cannot be annualized.
2276 # See CompensationEntry for explanation on annualization and base
2277 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2278 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2279 #
2280 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2281 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2282 #
2283 # Decimal number.
2284 "units": "A String", # Whole units.
2285 "micros": 42, # Micro (10^-6) units.
2286 # The value must be between -999,999 and +999,999 inclusive.
2287 # If `units` is positive, `micros` must be positive or zero.
2288 # If `units` is zero, `micros` can be positive, zero, or negative.
2289 # If `units` is negative, `micros` must be negative or zero.
2290 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2291 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2292 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2293 #
2294 # Decimal number.
2295 "units": "A String", # Whole units.
2296 "micros": 42, # Micro (10^-6) units.
2297 # The value must be between -999,999 and +999,999 inclusive.
2298 # If `units` is positive, `micros` must be positive or zero.
2299 # If `units` is zero, `micros` can be positive, zero, or negative.
2300 # If `units` is negative, `micros` must be negative or zero.
2301 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2302 },
2303 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2304 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2305 #
2306 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2307 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2308 #
2309 # Decimal number.
2310 "units": "A String", # Whole units.
2311 "micros": 42, # Micro (10^-6) units.
2312 # The value must be between -999,999 and +999,999 inclusive.
2313 # If `units` is positive, `micros` must be positive or zero.
2314 # If `units` is zero, `micros` can be positive, zero, or negative.
2315 # If `units` is negative, `micros` must be negative or zero.
2316 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2317 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2318 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2319 #
2320 # Decimal number.
2321 "units": "A String", # Whole units.
2322 "micros": 42, # Micro (10^-6) units.
2323 # The value must be between -999,999 and +999,999 inclusive.
2324 # If `units` is positive, `micros` must be positive or zero.
2325 # If `units` is zero, `micros` can be positive, zero, or negative.
2326 # If `units` is negative, `micros` must be negative or zero.
2327 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2328 },
2329 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2330 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2331 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2332 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2333 # the job's base compensation entry cannot be annualized.
2334 # See CompensationEntry for explanation on annualization and base
2335 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2336 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2337 #
2338 # At most one entry can be of type
2339 # ExtendedCompensationInfo.CompensationType.BASE, which is
2340 # referred as ** base compensation entry ** for the job.
2341 { # Deprecated. See CompensationInfo.
2342 #
2343 # A compensation entry that represents one component of compensation, such
2344 # as base pay, bonus, or other compensation type.
2345 #
2346 # Annualization: One compensation entry can be annualized if
2347 # - it contains valid amount or range.
2348 # - and its expected_units_per_year is set or can be derived.
2349 # Its annualized range is determined as (amount or range) times
2350 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2351 "description": "A String", # Optional. Compensation description.
2352 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2353 #
2354 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2355 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2356 #
2357 # Decimal number.
2358 "units": "A String", # Whole units.
2359 "micros": 42, # Micro (10^-6) units.
2360 # The value must be between -999,999 and +999,999 inclusive.
2361 # If `units` is positive, `micros` must be positive or zero.
2362 # If `units` is zero, `micros` can be positive, zero, or negative.
2363 # If `units` is negative, `micros` must be negative or zero.
2364 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2365 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2366 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2367 #
2368 # Decimal number.
2369 "units": "A String", # Whole units.
2370 "micros": 42, # Micro (10^-6) units.
2371 # The value must be between -999,999 and +999,999 inclusive.
2372 # If `units` is positive, `micros` must be positive or zero.
2373 # If `units` is zero, `micros` can be positive, zero, or negative.
2374 # If `units` is negative, `micros` must be negative or zero.
2375 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2376 },
2377 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2378 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
2379 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2380 # Job.employment_types is FULLTIME, a default value is inferred
2381 # based on unit. Default values:
2382 # - HOURLY: 2080
2383 # - DAILY: 260
2384 # - WEEKLY: 52
2385 # - MONTHLY: 12
2386 # - ANNUAL: 1
2387 #
2388 # Decimal number.
2389 "units": "A String", # Whole units.
2390 "micros": 42, # Micro (10^-6) units.
2391 # The value must be between -999,999 and +999,999 inclusive.
2392 # If `units` is positive, `micros` must be positive or zero.
2393 # If `units` is zero, `micros` can be positive, zero, or negative.
2394 # If `units` is negative, `micros` must be negative or zero.
2395 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2396 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2397 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2398 #
2399 # Decimal number.
2400 "units": "A String", # Whole units.
2401 "micros": 42, # Micro (10^-6) units.
2402 # The value must be between -999,999 and +999,999 inclusive.
2403 # If `units` is positive, `micros` must be positive or zero.
2404 # If `units` is zero, `micros` can be positive, zero, or negative.
2405 # If `units` is negative, `micros` must be negative or zero.
2406 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
2407 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2408 "type": "A String", # Required. Compensation type.
2409 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2410 #
2411 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
2412 },
2413 ],
2414 },
2415 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
2416 #
2417 # Optional.
2418 #
2419 # A map of fields to hold filterable custom job attributes not captured by
2420 # the standard fields such as job_title, company_name, or
2421 # level. These custom fields store arbitrary
2422 # string values, and can be used for purposes not covered by
2423 # the structured fields. For the best search experience, use of the
2424 # structured rather than custom fields is recommended.
2425 #
2426 # Data stored in these custom fields fields are indexed and
2427 # searched against by keyword searches (see
2428 # SearchJobsRequest.custom_field_filters][]).
2429 #
2430 # The map key must be a number between 1-20. If an invalid key is
2431 # provided on job create or update, an error is returned.
2432 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2433 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2434 "A String",
2435 ],
2436 },
2437 },
2438 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
2439 #
2440 # Optional but strongly recommended to be provided for the best service
2441 # experience.
2442 #
2443 # The expiration date of the job in UTC time. After 12 am on this date, the
2444 # job is marked as expired, and it no longer appears in search results.
2445 # The expired job can't be deleted or listed by the DeleteJob and
2446 # ListJobs APIs, but it can be retrieved with the GetJob API or
2447 # updated with the UpdateJob API. An expired job can be updated and
2448 # opened again by using a future expiration date. It can also remain expired.
2449 # Updating an expired job to be open fails if there is another existing open
2450 # job with same requisition_id, company_name and language_code.
2451 #
2452 # The expired jobs are retained in our system for 90 days. However, the
2453 # overall expired job count cannot exceed 3 times the maximum of open jobs
2454 # count over the past week, otherwise jobs with earlier expire time are
2455 # removed first. Expired jobs are no longer accessible after they are cleaned
2456 # out.
2457 #
2458 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
2459 # ignored and treated as expiry date not provided.
2460 #
2461 # If this value is not provided on job creation or is invalid, the job
2462 # posting expires after 30 days from the job's creation time. For example, if
2463 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
2464 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
2465 #
2466 # If this value is not provided on job update, it depends on the field masks
2467 # set by UpdateJobRequest.update_job_fields. If the field masks include
2468 # expiry_date, or the masks are empty meaning that every field is
2469 # updated, the job expires after 30 days from the job's last update time.
2470 # Otherwise the expiration date isn't updated.
2471 # and time zone are either specified elsewhere or are not significant. The date
2472 # is relative to the Proleptic Gregorian Calendar. This can represent:
2473 #
2474 # * A full date, with non-zero year, month and day values
2475 # * A month and day value, with a zero year, e.g. an anniversary
2476 # * A year on its own, with zero month and day values
2477 # * A year and month value, with a zero day, e.g. a credit card expiration date
2478 #
2479 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
2480 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2481 # month and day.
2482 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2483 # if specifying a year by itself or a year and month where the day is not
2484 # significant.
2485 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2486 # a year.
2487 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2488 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2489 # recommended as an alternative to using the more general description
2490 # field.
2491 #
2492 # This field accepts and sanitizes HTML input, and also accepts
2493 # bold, italic, ordered list, and unordered list markup tags.
2494 #
2495 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2496 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
2497 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2498 # base compensation entry's CompensationEntry.compensation times
2499 # CompensationEntry.expected_units_per_year.
2500 #
2501 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2502 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2503 # to a maximal compensation value and the currency code is set to
2504 # match the currency code of
2505 # min_compensation.
2506 "nanos": 42, # Number of nano (10^-9) units of the amount.
2507 # The value must be between -999,999,999 and +999,999,999 inclusive.
2508 # If `units` is positive, `nanos` must be positive or zero.
2509 # If `units` is zero, `nanos` can be positive, zero, or negative.
2510 # If `units` is negative, `nanos` must be negative or zero.
2511 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2512 "units": "A String", # The whole units of the amount.
2513 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2514 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2515 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2516 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2517 # to zero and the currency code is set to match the
2518 # currency code of max_compensation.
2519 "nanos": 42, # Number of nano (10^-9) units of the amount.
2520 # The value must be between -999,999,999 and +999,999,999 inclusive.
2521 # If `units` is positive, `nanos` must be positive or zero.
2522 # If `units` is zero, `nanos` can be positive, zero, or negative.
2523 # If `units` is negative, `nanos` must be negative or zero.
2524 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2525 "units": "A String", # The whole units of the amount.
2526 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2527 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2528 },
2529 },
2530 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
2531 #
2532 # Optional.
2533 #
2534 # A lower bound on a range for compensation or pay for the job.
2535 # The currency type is specified in compensation_amount.
2536 "nanos": 42, # Number of nano (10^-9) units of the amount.
2537 # The value must be between -999,999,999 and +999,999,999 inclusive.
2538 # If `units` is positive, `nanos` must be positive or zero.
2539 # If `units` is zero, `nanos` can be positive, zero, or negative.
2540 # If `units` is negative, `nanos` must be negative or zero.
2541 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2542 "units": "A String", # The whole units of the amount.
2543 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2544 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2545 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2546 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2547 # all compensation entries' CompensationEntry.compensation times
2548 # CompensationEntry.expected_units_per_year.
2549 #
2550 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2551 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2552 # to a maximal compensation value and the currency code is set to
2553 # match the currency code of
2554 # min_compensation.
2555 "nanos": 42, # Number of nano (10^-9) units of the amount.
2556 # The value must be between -999,999,999 and +999,999,999 inclusive.
2557 # If `units` is positive, `nanos` must be positive or zero.
2558 # If `units` is zero, `nanos` can be positive, zero, or negative.
2559 # If `units` is negative, `nanos` must be negative or zero.
2560 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2561 "units": "A String", # The whole units of the amount.
2562 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2563 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2564 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2565 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2566 # to zero and the currency code is set to match the
2567 # currency code of max_compensation.
2568 "nanos": 42, # Number of nano (10^-9) units of the amount.
2569 # The value must be between -999,999,999 and +999,999,999 inclusive.
2570 # If `units` is positive, `nanos` must be positive or zero.
2571 # If `units` is zero, `nanos` can be positive, zero, or negative.
2572 # If `units` is negative, `nanos` must be negative or zero.
2573 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2574 "units": "A String", # The whole units of the amount.
2575 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2576 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2577 },
2578 },
2579 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
2580 #
2581 # Optional.
2582 #
2583 # An upper bound on a range for compensation or pay for the job.
2584 # The currency type is specified in compensation_amount.
2585 "nanos": 42, # Number of nano (10^-9) units of the amount.
2586 # The value must be between -999,999,999 and +999,999,999 inclusive.
2587 # If `units` is positive, `nanos` must be positive or zero.
2588 # If `units` is zero, `nanos` can be positive, zero, or negative.
2589 # If `units` is negative, `nanos` must be negative or zero.
2590 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2591 "units": "A String", # The whole units of the amount.
2592 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2593 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2594 },
2595 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
2596 #
2597 # Optional.
2598 #
2599 # The amount of compensation or pay for the job.
2600 # As an alternative, compensation_amount_min and
2601 # compensation_amount_max may be used to define a range of
2602 # compensation.
2603 "nanos": 42, # Number of nano (10^-9) units of the amount.
2604 # The value must be between -999,999,999 and +999,999,999 inclusive.
2605 # If `units` is positive, `nanos` must be positive or zero.
2606 # If `units` is zero, `nanos` can be positive, zero, or negative.
2607 # If `units` is negative, `nanos` must be negative or zero.
2608 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2609 "units": "A String", # The whole units of the amount.
2610 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2611 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2612 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2613 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2614 #
2615 # At most one entry can be of type
2616 # CompensationInfo.CompensationType.BASE, which is
2617 # referred as ** base compensation entry ** for the job.
2618 { # A compensation entry that represents one component of compensation, such
2619 # as base pay, bonus, or other compensation type.
2620 #
2621 # Annualization: One compensation entry can be annualized if
2622 # - it contains valid amount or range.
2623 # - and its expected_units_per_year is set or can be derived.
2624 # Its annualized range is determined as (amount or range) times
2625 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2626 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2627 # indicate equity terms or provide additional context to an estimated
2628 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2629 "range": { # Compensation range. # Optional. Compensation range.
2630 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2631 # to a maximal compensation value and the currency code is set to
2632 # match the currency code of
2633 # min_compensation.
2634 "nanos": 42, # Number of nano (10^-9) units of the amount.
2635 # The value must be between -999,999,999 and +999,999,999 inclusive.
2636 # If `units` is positive, `nanos` must be positive or zero.
2637 # If `units` is zero, `nanos` can be positive, zero, or negative.
2638 # If `units` is negative, `nanos` must be negative or zero.
2639 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2640 "units": "A String", # The whole units of the amount.
2641 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2642 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2643 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2644 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2645 # to zero and the currency code is set to match the
2646 # currency code of max_compensation.
2647 "nanos": 42, # Number of nano (10^-9) units of the amount.
2648 # The value must be between -999,999,999 and +999,999,999 inclusive.
2649 # If `units` is positive, `nanos` must be positive or zero.
2650 # If `units` is zero, `nanos` can be positive, zero, or negative.
2651 # If `units` is negative, `nanos` must be negative or zero.
2652 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2653 "units": "A String", # The whole units of the amount.
2654 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2655 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2656 },
2657 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2658 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2659 # Job.employment_types is FULLTIME, a default value is inferred
2660 # based on unit. Default values:
2661 # - HOURLY: 2080
2662 # - DAILY: 260
2663 # - WEEKLY: 52
2664 # - MONTHLY: 12
2665 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2666 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2667 "nanos": 42, # Number of nano (10^-9) units of the amount.
2668 # The value must be between -999,999,999 and +999,999,999 inclusive.
2669 # If `units` is positive, `nanos` must be positive or zero.
2670 # If `units` is zero, `nanos` can be positive, zero, or negative.
2671 # If `units` is negative, `nanos` must be negative or zero.
2672 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2673 "units": "A String", # The whole units of the amount.
2674 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2675 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2676 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2677 "type": "A String", # Required. Compensation type.
2678 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2679 #
2680 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
2681 },
2682 ],
2683 "type": "A String", # Deprecated. Use entries instead.
2684 #
2685 # Optional.
2686 #
2687 # Type of job compensation.
2688 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2689 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2690 # position.
2691 #
2692 # The maximum number of allowed characters is 255.
2693 "applicationInstruction": "A String", # Optional but at least one of application_urls,
2694 # application_email_list or application_instruction must be
2695 # specified.
2696 #
2697 # Use this field to provide instructions, such as "Mail your application
2698 # to ...", that a candidate can follow to apply for the job.
2699 #
2700 # This field accepts and sanitizes HTML input, and also accepts
2701 # bold, italic, ordered list, and unordered list markup tags.
2702 #
2703 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2704 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
2705 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2706 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2707 # The maximum number of allowed characters is 10,000.
2708 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2709 # description of the company and related information. Separate fields are
2710 # provided on the job object for responsibilities,
2711 # qualifications, and other job characteristics. Use of
2712 # these separate job fields is recommended.
2713 #
2714 # This field accepts and sanitizes HTML input, and also accepts
2715 # bold, italic, ordered list, and unordered list markup tags.
2716 #
2717 # The maximum number of allowed characters is 100,000.
2718 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
2719 # provided.
2720 #
2721 # The resource name of the company listing the job, such as
2722 # /companies/foo. This field takes precedence over the
2723 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2724 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2725 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2726 # The maximum number of allowed characters is 500.
2727 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2728 # client to identify a job. This field is intended to be used by clients
2729 # for client identification and tracking of listings. A job is not allowed
2730 # to be created if there is another job with the same requisition_id,
2731 # company_name and language_code.
2732 #
2733 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2734 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2735 # job. The use of this field is recommended
2736 # as an alternative to using the more general description field.
2737 #
2738 # This field accepts and sanitizes HTML input, and also accepts
2739 # bold, italic, ordered list, and unordered list markup tags.
2740 #
2741 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2742 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2743 # Defaults to JobVisibility.PRIVATE if not specified.
2744 # Currently only JobVisibility.PRIVATE is supported.
2745 "expireTime": "A String", # Optional but strongly recommended for the best service
2746 # experience.
2747 #
2748 # The expiration timestamp of the job. After this timestamp, the
2749 # job is marked as expired, and it no longer appears in search results. The
2750 # expired job can't be deleted or listed by the DeleteJob and
2751 # ListJobs APIs, but it can be retrieved with the GetJob API or
2752 # updated with the UpdateJob API. An expired job can be updated and
2753 # opened again by using a future expiration timestamp. Updating an expired
2754 # job fails if there is another existing open job with same
2755 # requisition_id, company_name and language_code.
2756 #
2757 # The expired jobs are retained in our system for 90 days. However, the
2758 # overall expired job count cannot exceed 3 times the maximum of open jobs
2759 # count over the past week, otherwise jobs with earlier expire time are
2760 # cleaned first. Expired jobs are no longer accessible after they are cleaned
2761 # out.
2762 # The format of this field is RFC 3339 date strings. Example:
2763 # 2000-01-01T00:00:00.999999999Z
2764 # See
2765 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
2766 #
2767 # A valid date range is between 1970-01-01T00:00:00.0Z and
2768 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
2769 # time not provided.
2770 #
2771 # If this value is not provided at the time of job creation or is invalid,
2772 # the job posting expires after 30 days from the job's creation time. For
2773 # example, if the job was created on 2017/01/01 13:00AM UTC with an
2774 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
2775 #
2776 # If this value is not provided but expiry_date is, expiry_date is
2777 # used.
2778 #
2779 # If this value is not provided on job update, it depends on the field masks
2780 # set by UpdateJobRequest.update_job_fields. If the field masks include
2781 # expiry_time, or the masks are empty meaning that every field is
2782 # updated, the job posting expires after 30 days from the job's last
2783 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2784 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2785 # value is the time the request arrives at the server.
2786 # and time zone are either specified elsewhere or are not significant. The date
2787 # is relative to the Proleptic Gregorian Calendar. This can represent:
2788 #
2789 # * A full date, with non-zero year, month and day values
2790 # * A month and day value, with a zero year, e.g. an anniversary
2791 # * A year on its own, with zero month and day values
2792 # * A year and month value, with a zero day, e.g. a credit card expiration date
2793 #
2794 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
2795 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2796 # month and day.
2797 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2798 # if specifying a year by itself or a year and month where the day is not
2799 # significant.
2800 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2801 # a year.
2802 },
2803 "applicationEmailList": [ # Optional but at least one of application_urls,
2804 # application_email_list or application_instruction must be
2805 # specified.
2806 #
2807 # Use this field to specify email address(es) to which resumes or
2808 # applications can be sent.
2809 #
2810 # The maximum number of allowed characters is 255.
2811 "A String",
2812 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2813 "createTime": "A String", # Output only. The timestamp when this job was created.
2814 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2815 "A String",
2816 ],
2817 "name": "A String", # Required during job update.
2818 #
2819 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
2820 # of this field in job queries and API calls is preferred over the use of
2821 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2822 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2823 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
2824 #
2825 # Output only.
2826 #
2827 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2828 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2829 # is available. If this field is set, a
2830 # LocationFilter in a search query within the job region
2831 # finds this job if an exact location match is not specified.
2832 # If this field is set, setting job locations
2833 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2834 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2835 # The value determines the sort order of the jobs returned when searching for
2836 # jobs using the featured jobs search call, with higher promotional values
2837 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2838 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2839 #
2840 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2841 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
2842 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2843 # attributes that are not covered by the provided structured fields.
2844 #
2845 # This field is a more general combination of the deprecated id-based
2846 # filterable_custom_fields and string-based
2847 # non_filterable_custom_fields.
2848 #
2849 # The keys of the map are strings up to 64 bytes and must match the
2850 # pattern: a-zA-Z*.
2851 #
2852 # At most 100 filterable and at most 100 unfilterable keys are supported.
2853 # For filterable `string_values`, across all keys at most 200 values are
2854 # allowed, with each string no more than 255 characters. For unfilterable
2855 # `string_values`, the maximum total size of `string_values` across all keys
2856 # is 50KB.
2857 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2858 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2859 # If false, values are not searchable.
2860 #
2861 # Default is false.
2862 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
2863 # be specified.
2864 #
2865 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
2866 # `CASE_INSENSITIVE_MATCH`) search.
2867 # For filterable `string_values`, a maximum total number of 200 values
2868 # is allowed, with each `string_value` has a byte size of no more than
2869 # 255B. For unfilterable `string_values`, the maximum total byte size of
2870 # unfilterable `string_values` is 50KB.
2871 #
2872 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2873 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2874 "A String",
2875 ],
2876 },
2877 "longValue": "A String", # Optional but at least one of string_values or long_value must
2878 # be specified.
2879 #
2880 # This field is used to perform number range search.
2881 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
2882 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
2883 },
2884 },
2885 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
2886 # provided.
2887 #
2888 # A unique company identifier used by job distributors to identify an
2889 # employer's company entity. company_name takes precedence over
2890 # this field, and is the recommended field to use to identify companies.
2891 #
2892 # The maximum number of allowed characters is 255.
2893 }</pre>
2894</div>
2895
2896<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2897 <code class="details" id="histogram">histogram(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2898 <pre>Deprecated. Use SearchJobsRequest.histogram_facets instead to make
2899a single call with both search and histogram.
2900
2901Retrieves a histogram for the given
2902GetHistogramRequest. This call provides a structured
2903count of jobs that match against the search query, grouped by specified
2904facets.
2905
2906This call constrains the visibility of jobs
2907present in the database, and only counts jobs the caller has
2908permission to search against.
2909
2910For example, use this call to generate the
2911number of jobs in the U.S. by state.
2912
2913Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2914 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2915 The object takes the form of:
2916
2917{ # Deprecated. Use SearchJobsRequest.histogram_facets instead to make
2918 # a single call with both search and histogram.
2919 #
2920 # Input only.
2921 #
2922 # A request for the `GetHistogram` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2923 "query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2924 #
2925 # The query required to perform a search query or histogram.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2926 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2927 # service attempts to correct a misspelled query,
2928 # for example, "enginee" is corrected to "engineer".
2929 #
2930 # Defaults to false: a spell check is performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2931 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2932 # Job.custom_attributes marked as `filterable`.
2933 #
2934 # The syntax for this expression is a subset of Google SQL syntax.
2935 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2936 # Supported operators are: =, !=, &lt;, &lt;=, &gt;, &gt;= where the left of the operator
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2937 # is a custom field key and the right of the operator is a number or string
2938 # (surrounded by quotes) value.
2939 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2940 # Supported functions are LOWER(&lt;field_name&gt;) to
2941 # perform case insensitive match and EMPTY(&lt;field_name&gt;) to filter on the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2942 # existence of a key.
2943 #
2944 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
2945 # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50
2946 # comparisons/functions are allowed in the expression. The expression
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2947 # must be &lt; 2000 characters in length.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2948 #
2949 # Sample Query:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2950 # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 &gt; 100
2951 "companyDisplayNames": [ # Optional. This filter specifies the exact company display
2952 # name of the jobs to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2953 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2954 # If a value isn't specified, jobs within the search results are
2955 # associated with any company.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2956 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2957 # If multiple values are specified, jobs within the search results may be
2958 # associated with any of the specified companies.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2959 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2960 # At most 20 company display name filters are allowed.
2961 "A String",
2962 ],
2963 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2964 # search against, such as EmploymentType.FULL_TIME.
2965 #
2966 # If a value is not specified, jobs in the search results include any
2967 # employment type.
2968 #
2969 # If multiple values are specified, jobs in the search results include
2970 # any of the specified employment types.
2971 "A String",
2972 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2973 "query": "A String", # Optional. The query string that matches against the job title, description, and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2974 # location fields.
2975 #
2976 # The maximum query size is 255 bytes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2977 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
2978 # Job.compensation_info. For example, if the filter is specified
2979 # as "Hourly job with per-hour compensation &gt; $15", only jobs meeting
2980 # these criteria are searched. If a filter isn't defined, all open jobs
2981 # are searched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2982 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2983 # Filter on job compensation type and amount.
2984 "units": [ # Required. Specify desired `base compensation entry's`
2985 # CompensationInfo.CompensationUnit.
2986 "A String",
2987 ],
2988 "range": { # Compensation range. # Optional. Compensation range.
2989 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
2990 # to a maximal compensation value and the currency code is set to
2991 # match the currency code of
2992 # min_compensation.
2993 "nanos": 42, # Number of nano (10^-9) units of the amount.
2994 # The value must be between -999,999,999 and +999,999,999 inclusive.
2995 # If `units` is positive, `nanos` must be positive or zero.
2996 # If `units` is zero, `nanos` can be positive, zero, or negative.
2997 # If `units` is negative, `nanos` must be negative or zero.
2998 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2999 "units": "A String", # The whole units of the amount.
3000 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3001 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3002 },
3003 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
3004 # to zero and the currency code is set to match the
3005 # currency code of max_compensation.
3006 "nanos": 42, # Number of nano (10^-9) units of the amount.
3007 # The value must be between -999,999,999 and +999,999,999 inclusive.
3008 # If `units` is positive, `nanos` must be positive or zero.
3009 # If `units` is zero, `nanos` can be positive, zero, or negative.
3010 # If `units` is negative, `nanos` must be negative or zero.
3011 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3012 "units": "A String", # The whole units of the amount.
3013 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3014 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3015 },
3016 },
3017 "type": "A String", # Required. Type of filter.
3018 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
3019 },
3020 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for
3021 # example, driving or public transit). Note: This only works with COMMUTE
3022 # MODE. When specified, [JobQuery.location_filters] is
3023 # ignored.
3024 #
3025 # Currently we don't support sorting by commute time.
3026 #
3027 # Parameters needed for commute search.
3028 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
3029 # integer between 0 and 23, representing the hour in the time zone of the
3030 # start_location. Must not be present if road_traffic is specified.
3031 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
3032 # Must not be present if departure_hour_local is specified.
3033 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
3034 # For city level addresses, the city center is used. For state and coarser
3035 # level addresses, text matching is used.
3036 # If this field is set to `false` or is not specified, only jobs that include
3037 # street level addresses will be returned by commute search.
3038 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
3039 "startLocation": { # 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
3040 # commute time.
3041 # of doubles representing degrees latitude and degrees longitude. Unless
3042 # specified otherwise, this must conform to the
3043 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3044 # standard&lt;/a&gt;. Values must be within normalized ranges.
3045 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3046 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3047 },
3048 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
3049 # (one hour). Format is `123s`.
3050 },
3051 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3052 # for example, "en-US".
3053 #
3054 # If a value isn't specified, the search results can contain jobs in any
3055 # locale.
3056 #
3057 #
3058 # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".
3059 # For more information, see
3060 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
3061 #
3062 # At most 10 language code filters are allowed.
3063 "A String",
3064 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3065 "companyNames": [ # Optional. This filter specifies the company entities to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3066 #
3067 # If a value isn't specified, jobs are searched for against all
3068 # companies.
3069 #
3070 # If multiple values are specified, jobs are searched against the
3071 # companies specified.
3072 #
3073 # At most 20 company filters are allowed.
3074 "A String",
3075 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3076 "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched
3077 # against, for example, DateRange.PAST_MONTH. If a value isn't
3078 # specified, all open jobs are searched against regardless of their
3079 # published date.
3080 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3081 # search against. See LocationFilter for more information.
3082 #
3083 # If a location value isn't specified, jobs fitting the other search
3084 # criteria are retrieved regardless of where they're located.
3085 #
3086 # If multiple values are specified, jobs are retrieved from any of the
3087 # specified locations. If different values are specified for the
3088 # LocationFilter.distance_in_miles parameter, the maximum provided
3089 # distance is used for all locations.
3090 #
3091 # At most 5 location filters are allowed.
3092 { # Input only.
3093 #
3094 # Geographic region of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3095 "isTelecommute": True or False, # Optional. Allows the client to return jobs without a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3096 # set location, specifically, telecommuting jobs (telecomuting is considered
3097 # by the service as a special location.
3098 # Job.allow_telecommute indicates if a job permits telecommuting.
3099 # If this field is true, telecommuting jobs are searched, and
3100 # name and lat_lng are
3101 # ignored.
3102 # This filter can be used by itself to search exclusively for telecommuting
3103 # jobs, or it can be combined with another location
3104 # filter to search for a combination of job locations,
3105 # such as "Mountain View" or "telecommuting" jobs. However, when used in
3106 # combination with other location filters, telecommuting jobs can be
3107 # treated as less relevant than other jobs in the search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3108 "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
3109 # search. This field is ignored if `location_name` is provided.
3110 # of doubles representing degrees latitude and degrees longitude. Unless
3111 # specified otherwise, this must conform to the
3112 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3113 # standard&lt;/a&gt;. Values must be within normalized ranges.
3114 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3115 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3116 },
3117 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3118 # identified as a city or smaller. When the location being searched for is a
3119 # state or larger, this field is ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3120 "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
3121 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used
3122 # to address ambiguity of the user-input location, e.g. "Liverpool"
3123 # against "Liverpool, NY, US" or "Liverpool, UK".
3124 #
3125 # Set this field if all the jobs to search against are from a same region,
3126 # or jobs are world-wide but the job seeker is from a specific region.
3127 #
3128 # See http://cldr.unicode.org/ and
3129 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
3130 # for details. Example: "CH" for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3131 },
3132 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3133 "categories": [ # Optional. The category filter specifies the categories of jobs to search against.
3134 # See Category for more information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3135 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3136 # If a value is not specified, jobs from any category are searched against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3137 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3138 # If multiple values are specified, jobs from any of the specified
3139 # categories are searched against.
3140 "A String",
3141 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3142 },
3143 "requestMetadata": { # Input only. # Meta information, such as `user_id`, collected from the job searcher or
3144 # other entity conducting a job search, is used to improve the service's
3145 # search quality. Users determine identifier values, which must be
3146 # unique and consist.
3147 #
3148 # Meta information related to the job searcher or entity
3149 # conducting the job search. This information is used to improve the
3150 # performance of the service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3151 "deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3152 # service.
3153 #
3154 # Device information collected from the job seeker, candidate, or
3155 # other entity conducting the job search. Providing this information improves
3156 # the quality of the search results across devices.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3157 "deviceType": "A String", # Optional. Type of the device.
3158 "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3159 # the device from other devices.
3160 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3161 "sessionId": "A String", # Required. A unique session identification string. A session is defined as the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3162 # duration of an end user's interaction with the service over a period.
3163 # Obfuscate this field for privacy concerns before
3164 # providing it to the API.
3165 #
3166 # If this field is not available for some reason, please send "UNKNOWN". Note
3167 # that any improvements to the service model for a particular tenant site,
3168 # rely on this field being set correctly to some unique session_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3169 "userId": "A String", # Required. A unique user identification string, as determined by the client. The
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3170 # client is responsible for ensuring client-level uniqueness of this value
3171 # in order to have the strongest positive impact on search quality.
3172 # Obfuscate this field for privacy concerns before
3173 # providing it to the service.
3174 #
3175 # If this field is not available for some reason, please send "UNKNOWN". Note
3176 # that any improvements to the service model for a particular tenant site,
3177 # rely on this field being set correctly to some unique user_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3178 "domain": "A String", # Required. The client-defined scope or source of the service call, which typically
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3179 # is the domain on
3180 # which the service has been implemented and is currently being run.
3181 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3182 # For example, if the service is being run by client &lt;em&gt;Foo, Inc.&lt;/em&gt;, on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3183 # job board www.foo.com and career site www.bar.com, then this field is
3184 # set to "foo.com" for use on the job board, and "bar.com" for use on the
3185 # career site.
3186 #
3187 # If this field is not available for some reason, send "UNKNOWN". Note that
3188 # any improvements to the service model for a particular tenant site rely on
3189 # this field being set correctly to some domain.
3190 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3191 "searchTypes": [ # Required. A list of facets that specify the histogram data to be calculated
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3192 # against and returned.
3193 #
3194 # Histogram response times can be slow, and counts
3195 # can be approximations. This call may be temporarily or permanently removed
3196 # prior to the production release of Cloud Talent Solution.
3197 "A String",
3198 ],
3199 "filters": { # Input only. # Deprecated. Use query instead.
3200 #
3201 # Optional.
3202 #
3203 # Restrictions on the scope of the histogram.
3204 #
3205 # Deprecated. Use JobQuery instead.
3206 #
3207 # The filters required to perform a search query or histogram.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3208 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3209 # service attempts to correct a misspelled query,
3210 # for example, "enginee" is corrected to "engineer".
3211 #
3212 # Defaults to false: a spell check is performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3213 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3214 # Job.custom_attributes that are marked as `filterable`.
3215 #
3216 # The syntax for this expression is a subset of Google SQL syntax.
3217 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3218 # Supported operators are: =, !=, &lt;, &lt;=, &gt;, &gt;= where the left of the operator
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3219 # is a custom field key and the right of the operator is a number or string
3220 # (surrounded by quotes) value.
3221 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3222 # Supported functions are LOWER(&lt;field_name&gt;) to
3223 # perform case insensitive match and EMPTY(&lt;field_name&gt;) to filter on the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3224 # existence of a key.
3225 #
3226 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
3227 # nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can
3228 # be a maximum of 100 comparisons/functions in the expression. The expression
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3229 # must be &lt; 3000 bytes in length.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3230 #
3231 # Sample Query:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3232 # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 &gt; 100
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3233 "customFieldFilters": { # Deprecated. Use custom_attribute_filter instead.
3234 #
3235 # Optional.
3236 #
3237 # This filter specifies searching against
3238 # custom field values. See Job.filterable_custom_fields for information.
3239 # The key value specifies a number between 1-20 (the service
3240 # supports 20 custom fields) corresponding to the desired custom field map
3241 # value. If an invalid key is provided or specified together with
3242 # custom_attribute_filter, an error is thrown.
3243 "a_key": { # Input only.
3244 #
3245 # Custom field filter of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3246 "type": "A String", # Optional. The type of filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3247 # Defaults to FilterType.OR.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3248 "queries": [ # Required. The query strings for the filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3249 "A String",
3250 ],
3251 },
3252 },
3253 "tenantJobOnly": True or False, # Deprecated. Do not use this field.
3254 #
3255 # This flag controls whether the job search should be restricted to jobs
3256 # owned by the current user.
3257 #
3258 # Defaults to false where all jobs accessible to the
3259 # user are searched against.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3260 "categories": [ # Optional. The category filter specifies the categories of jobs to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3261 # See Category for more information.
3262 #
3263 # If a value is not specified, jobs from any category are searched against.
3264 #
3265 # If multiple values are specified, jobs from any of the specified
3266 # categories are searched against.
3267 "A String",
3268 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3269 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3270 # search against, such as EmploymentType.FULL_TIME.
3271 #
3272 # If a value is not specified, jobs in the search results include any
3273 # employment type.
3274 #
3275 # If multiple values are specified, jobs in the search results include any
3276 # of the specified employment types.
3277 "A String",
3278 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3279 "companyTitles": [ # Optional. This filter specifies the exact company titles
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3280 # of jobs to search against.
3281 #
3282 # If a value is not specified, jobs within the search results can be
3283 # associated with any company.
3284 #
3285 # If multiple values are specified, jobs within the search results may be
3286 # associated with any of the specified companies.
3287 #
3288 # At most 20 company title filters are allowed.
3289 "A String",
3290 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3291 "query": "A String", # Optional. The query filter contains the keywords that match against the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3292 # title, description, and location fields.
3293 #
3294 # The maximum query size is 255 bytes/characters.
3295 "extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter.
3296 #
3297 # Optional.
3298 #
3299 # This search filter is applied only to
3300 # Job.extended_compensation_info. For example, if the filter is specified
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3301 # as "Hourly job with per-hour compensation &gt; $15", only jobs that meet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3302 # these criteria are searched. If a filter is not defined, all open jobs
3303 # are searched.
3304 #
3305 # Input only.
3306 #
3307 # Filter on job compensation type and amount.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3308 "includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
3309 "type": "A String", # Required. Type of filter.
3310 "compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3311 #
3312 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3313 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3314 #
3315 # Decimal number.
3316 "units": "A String", # Whole units.
3317 "micros": 42, # Micro (10^-6) units.
3318 # The value must be between -999,999 and +999,999 inclusive.
3319 # If `units` is positive, `micros` must be positive or zero.
3320 # If `units` is zero, `micros` can be positive, zero, or negative.
3321 # If `units` is negative, `micros` must be negative or zero.
3322 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3323 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3324 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3325 #
3326 # Decimal number.
3327 "units": "A String", # Whole units.
3328 "micros": 42, # Micro (10^-6) units.
3329 # The value must be between -999,999 and +999,999 inclusive.
3330 # If `units` is positive, `micros` must be positive or zero.
3331 # If `units` is zero, `micros` can be positive, zero, or negative.
3332 # If `units` is negative, `micros` must be negative or zero.
3333 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3334 },
3335 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3336 "compensationUnits": [ # Required. Specify desired `base compensation entry's`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3337 # ExtendedCompensationInfo.CompensationUnit.
3338 "A String",
3339 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3340 "currency": "A String", # Optional. Specify currency in 3-letter
3341 # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If
3342 # unspecified, jobs are returned regardless of currency.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3343 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3344 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3345 # driving or public transit). Note: this only works with COMMUTE
3346 # MODE. When specified, [JobFilters.location_filters] will be
3347 # ignored.
3348 #
3349 # Currently we do not support sorting by commute time.
3350 #
3351 # Parameters needed for commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3352 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3353 # integer between 0 and 23, representing the hour in the time zone of the
3354 # start_location. Must not be present if road_traffic is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3355 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3356 # Must not be present if departure_hour_local is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3357 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3358 # For city level addresses, the city center is used. For state and coarser
3359 # level addresses, text matching is used.
3360 # If this field is set to `false` or is not specified, only jobs that include
3361 # street level addresses will be returned by commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3362 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
3363 "startLocation": { # 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3364 # commute time.
3365 # of doubles representing degrees latitude and degrees longitude. Unless
3366 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3367 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3368 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3369 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3370 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3371 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3372 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
3373 # (one hour). Format is `123s`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3374 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3375 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3376 # for example, "en-US".
3377 #
3378 # If a value is not specified, the search results may contain jobs in any
3379 # locale.
3380 #
3381 #
3382 # Language codes should be in BCP-47 format, for example, "en-US" or
3383 # "sr-Latn". For more information, see [Tags for Identifying
3384 # Languages](https://tools.ietf.org/html/bcp47).
3385 #
3386 # At most 10 language code filters are allowed.
3387 "A String",
3388 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3389 "companyNames": [ # Optional. The company names filter specifies the company entities to search
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3390 # against.
3391 #
3392 # If a value is not specified, jobs are searched for against all companies.
3393 #
3394 # If multiple values are specified, jobs are searched against the
3395 # specified companies.
3396 #
3397 # At most 20 company filters are allowed.
3398 "A String",
3399 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3400 "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3401 # against, for example, DateRange.PAST_MONTH. If a value is not
3402 # specified, all open jobs are searched against regardless of the
3403 # date they were published.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3404 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3405 # search against. See LocationFilter for more information.
3406 #
3407 # If a location value is not specified, jobs are retrieved
3408 # from all locations.
3409 #
3410 # If multiple values are specified, jobs are retrieved from any of the
3411 # specified locations. If different values are specified for the
3412 # LocationFilter.distance_in_miles parameter, the maximum provided
3413 # distance is used for all locations.
3414 #
3415 # At most 5 location filters are allowed.
3416 { # Input only.
3417 #
3418 # Geographic region of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3419 "isTelecommute": True or False, # Optional. Allows the client to return jobs without a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3420 # set location, specifically, telecommuting jobs (telecomuting is considered
3421 # by the service as a special location.
3422 # Job.allow_telecommute indicates if a job permits telecommuting.
3423 # If this field is true, telecommuting jobs are searched, and
3424 # name and lat_lng are
3425 # ignored.
3426 # This filter can be used by itself to search exclusively for telecommuting
3427 # jobs, or it can be combined with another location
3428 # filter to search for a combination of job locations,
3429 # such as "Mountain View" or "telecommuting" jobs. However, when used in
3430 # combination with other location filters, telecommuting jobs can be
3431 # treated as less relevant than other jobs in the search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3432 "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
3433 # search. This field is ignored if `location_name` is provided.
3434 # of doubles representing degrees latitude and degrees longitude. Unless
3435 # specified otherwise, this must conform to the
3436 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3437 # standard&lt;/a&gt;. Values must be within normalized ranges.
3438 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3439 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3440 },
3441 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3442 # identified as a city or smaller. When the location being searched for is a
3443 # state or larger, this field is ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3444 "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
3445 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used
3446 # to address ambiguity of the user-input location, e.g. "Liverpool"
3447 # against "Liverpool, NY, US" or "Liverpool, UK".
3448 #
3449 # Set this field if all the jobs to search against are from a same region,
3450 # or jobs are world-wide but the job seeker is from a specific region.
3451 #
3452 # See http://cldr.unicode.org/ and
3453 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
3454 # for details. Example: "CH" for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3455 },
3456 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3457 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3458 # Job.compensation_info. For example, if the filter is specified
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3459 # as "Hourly job with per-hour compensation &gt; $15", only jobs that meet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3460 # this criteria are searched. If a filter is not defined, all open jobs
3461 # are searched.
3462 #
3463 # Filter on job compensation type and amount.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3464 "units": [ # Required. Specify desired `base compensation entry's`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3465 # CompensationInfo.CompensationUnit.
3466 "A String",
3467 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3468 "range": { # Compensation range. # Optional. Compensation range.
3469 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3470 # to a maximal compensation value and the currency code is set to
3471 # match the currency code of
3472 # min_compensation.
3473 "nanos": 42, # Number of nano (10^-9) units of the amount.
3474 # The value must be between -999,999,999 and +999,999,999 inclusive.
3475 # If `units` is positive, `nanos` must be positive or zero.
3476 # If `units` is zero, `nanos` can be positive, zero, or negative.
3477 # If `units` is negative, `nanos` must be negative or zero.
3478 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3479 "units": "A String", # The whole units of the amount.
3480 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3481 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3482 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3483 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3484 # to zero and the currency code is set to match the
3485 # currency code of max_compensation.
3486 "nanos": 42, # Number of nano (10^-9) units of the amount.
3487 # The value must be between -999,999,999 and +999,999,999 inclusive.
3488 # If `units` is positive, `nanos` must be positive or zero.
3489 # If `units` is zero, `nanos` can be positive, zero, or negative.
3490 # If `units` is negative, `nanos` must be negative or zero.
3491 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3492 "units": "A String", # The whole units of the amount.
3493 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3494 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3495 },
3496 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3497 "type": "A String", # Required. Type of filter.
3498 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3499 },
3500 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3501 "allowBroadening": True or False, # Optional. Controls whether to broaden the search to avoid too few results for a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3502 # given query in instances where a search has sparse results. Results from a
3503 # broadened query is a superset of the results from the original query.
3504 #
3505 # Defaults to false.
3506 }
3507
3508 x__xgafv: string, V1 error format.
3509 Allowed values
3510 1 - v1 error format
3511 2 - v2 error format
3512
3513Returns:
3514 An object of the form:
3515
3516 { # Deprecated. Use SearchJobsRequest.histogram_facets instead to make
3517 # a single call with both search and histogram.
3518 #
3519 # Output only.
3520 #
3521 # The response of the GetHistogram method.
3522 "results": [ # The Histogram results.
3523 { # Output only.
3524 #
3525 # Result of a histogram call. The response contains the histogram map for the
3526 # search type specified by HistogramResult.field.
3527 # The response is a map of each filter value to the corresponding count of
3528 # jobs for that filter.
3529 "values": { # A map from the values of field to the number of jobs with that value
3530 # in this search result.
3531 #
3532 # Key: search type (filter names, such as the companyName).
3533 #
3534 # Values: the count of jobs that match the filter for this search.
3535 "a_key": 42,
3536 },
3537 "searchType": "A String", # The Histogram search filters.
3538 },
3539 ],
3540 "metadata": { # Output only. # Additional information for the API invocation, such as the request
3541 # tracking id.
3542 #
3543 # Additional information returned to client, such as debugging
3544 # information.
3545 "requestId": "A String", # A unique id associated with this call.
3546 # This id is logged for tracking purposes.
3547 "experimentIdList": [ # Identifiers for the versions of the search algorithm used during
3548 # this API invocation if multiple algorithms are used.
3549 # The default value is empty.
3550 # For search response only.
3551 42,
3552 ],
3553 "mode": "A String", # For search response only. Indicates the mode of a performed search.
3554 },
3555 }</pre>
3556</div>
3557
3558<div class="method">
3559 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None, idsOnly=None, filter=None)</code>
3560 <pre>Lists jobs by filter.
3561
3562Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3563 pageSize: integer, Optional. The maximum number of jobs to be returned per page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3564
3565If ids_only is set to true, the maximum allowed page size
3566is 1000. Otherwise, the maximum allowed page size is 100.
3567
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3568Default is 100 if empty or a number &lt; 1 is specified.
3569 pageToken: string, Optional. The starting point of a query result.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3570 x__xgafv: string, V1 error format.
3571 Allowed values
3572 1 - v1 error format
3573 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3574 idsOnly: boolean, Optional. If set to `true`, only Job.name, Job.requisition_id and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3575Job.language_code will be returned.
3576
3577A typical use case is to synchronize job repositories.
3578
3579Defaults to false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3580 filter: string, Required. The filter string specifies the jobs to be enumerated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3581
3582Supported operator: =, AND
3583
3584The fields eligible for filtering are:
3585
3586* `companyName` (Required)
3587* `requisitionId` (Optional)
3588
3589Sample Query:
3590
3591* companyName = "companies/123"
3592* companyName = "companies/123" AND requisitionId = "req-1"
3593
3594Returns:
3595 An object of the form:
3596
3597 { # Output only.
3598 #
3599 # List jobs response.
3600 "nextPageToken": "A String", # A token to retrieve the next page of results.
3601 "jobs": [ # The Jobs for a given company.
3602 #
3603 # The maximum number of items returned is based on the limit field
3604 # provided in the request.
3605 { # A Job resource represents a job posting (also referred to as a "job listing"
3606 # or "job requisition"). A job belongs to a Company, which is the hiring
3607 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3608 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3609 # any requirements for fluency that are associated with the job.
3610 #
3611 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
3612 # For more information, see
3613 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
3614 # class="external" target="_blank" }.
3615 #
3616 # If this field is unspecified and Job.description is present, detected
3617 # language code based on Job.description is assigned, otherwise
3618 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3619 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3620 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
3621 #
3622 # Optional.
3623 #
3624 # A map of fields to hold non-filterable custom job attributes, similar to
3625 # filterable_custom_fields. These fields are distinct in that the data
3626 # in these fields are not indexed. Therefore, the client cannot search
3627 # against them, nor can the client use them to list jobs.
3628 #
3629 # The key of the map can be any valid string.
3630 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3631 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3632 "A String",
3633 ],
3634 },
3635 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3636 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3637 # is used for contracting engagements.
3638 # Dates prior to 1970/1/1 and invalid date formats are ignored.
3639 # and time zone are either specified elsewhere or are not significant. The date
3640 # is relative to the Proleptic Gregorian Calendar. This can represent:
3641 #
3642 # * A full date, with non-zero year, month and day values
3643 # * A month and day value, with a zero year, e.g. an anniversary
3644 # * A year on its own, with zero month and day values
3645 # * A year and month value, with a zero day, e.g. a credit card expiration date
3646 #
3647 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
3648 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3649 # month and day.
3650 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3651 # if specifying a year by itself or a year and month where the day is not
3652 # significant.
3653 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3654 # a year.
3655 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3656 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
3657 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3658 # is used for contracting engagements.
3659 # Dates prior to 1970/1/1 and invalid date formats are ignored.
3660 # and time zone are either specified elsewhere or are not significant. The date
3661 # is relative to the Proleptic Gregorian Calendar. This can represent:
3662 #
3663 # * A full date, with non-zero year, month and day values
3664 # * A month and day value, with a zero year, e.g. an anniversary
3665 # * A year on its own, with zero month and day values
3666 # * A year and month value, with a zero day, e.g. a credit card expiration date
3667 #
3668 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
3669 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3670 # month and day.
3671 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3672 # if specifying a year by itself or a year and month where the day is not
3673 # significant.
3674 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3675 # a year.
3676 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3677 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3678 { # Output only.
3679 #
3680 # A resource that represents a location with full geographic
3681 # information.
3682 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
3683 # location bounding box in which a circle with the specified radius
3684 # centered from LatLng coves the area associated with the job location.
3685 # For example, currently, "Mountain View, CA, USA" has a radius of
3686 # 7885.79 meters.
3687 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
3688 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
3689 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
3690 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3691 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
3692 # of doubles representing degrees latitude and degrees longitude. Unless
3693 # specified otherwise, this must conform to the
3694 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3695 # standard&lt;/a&gt;. Values must be within normalized ranges.
3696 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3697 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3698 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3699 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
3700 # such as postal delivery and payments addresses. Given a postal address,
3701 # a postal service can deliver items to a premises, P.O. Box, or other
3702 # delivery location.
3703 # Given a postal address, a postal service can deliver items to a premise, P.O.
3704 # Box or similar.
3705 # It is not intended to model geographical locations (roads, towns,
3706 # mountains).
3707 #
3708 # In typical usage an address would be created via user input or from importing
3709 # existing data, depending on the type of process.
3710 #
3711 # Advice on address input / editing:
3712 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3713 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3714 # - Users should not be presented with UI elements for input or editing of
3715 # fields outside countries where that field is used.
3716 #
3717 # For more guidance on how to use this schema, please see:
3718 # https://support.google.com/business/answer/6397478
3719 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
3720 # known). This is often the UI language of the input form or is expected
3721 # to match one of the languages used in the address' country/region, or their
3722 # transliterated equivalents.
3723 # This can affect formatting in certain countries, but is not critical
3724 # to the correctness of the data and will never affect any validation or
3725 # other non-formatting related operations.
3726 #
3727 # If this value is not known, it should be omitted (rather than specifying a
3728 # possibly incorrect default).
3729 #
3730 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
3731 "recipients": [ # Optional. The recipient at the address.
3732 # This field may, under certain circumstances, contain multiline information.
3733 # For example, it might contain "care of" information.
3734 "A String",
3735 ],
3736 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
3737 # Examples: US city, IT comune, UK post town.
3738 # In regions of the world where localities are not well defined or do not fit
3739 # into this structure well, leave locality empty and use address_lines.
3740 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
3741 # in most regions. Where it is used, the value is either a string like
3742 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
3743 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
3744 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
3745 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
3746 # is never inferred and it is up to the user to ensure the value is
3747 # correct. See http://cldr.unicode.org/ and
3748 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
3749 # for details. Example: "CH" for Switzerland.
3750 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
3751 # addresses of a country or region.
3752 # For example, this can be a state, a province, an oblast, or a prefecture.
3753 # Specifically, for Spain this is the province and not the autonomous
3754 # community (e.g. "Barcelona" and not "Catalonia").
3755 # Many countries don't use an administrative area in postal addresses. E.g.
3756 # in Switzerland this should be left unpopulated.
3757 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
3758 #
3759 # Because values in address_lines do not have type information and may
3760 # sometimes contain multiple values in a single field (e.g.
3761 # "Austin, TX"), it is important that the line order is clear. The order of
3762 # address lines should be "envelope order" for the country/region of the
3763 # address. In places where this can vary (e.g. Japan), address_language is
3764 # used to make it explicit (e.g. "ja" for large-to-small ordering and
3765 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
3766 # an address can be selected based on the language.
3767 #
3768 # The minimum permitted structural representation of an address consists
3769 # of a region_code with all remaining information placed in the
3770 # address_lines. It would be possible to format such an address very
3771 # approximately without geocoding, but no semantic reasoning could be
3772 # made about any of the address components until it was at least
3773 # partially resolved.
3774 #
3775 # Creating an address only containing a region_code and address_lines, and
3776 # then geocoding is the recommended way to handle completely unstructured
3777 # addresses (as opposed to guessing which parts of the address should be
3778 # localities or administrative areas).
3779 "A String",
3780 ],
3781 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
3782 # postal codes to be present, but where they are used, they may trigger
3783 # additional validation with other parts of the address (e.g. state/zip
3784 # validation in the U.S.A.).
3785 "organization": "A String", # Optional. The name of the organization at the address.
3786 "sublocality": "A String", # Optional. Sublocality of the address.
3787 # For example, this can be neighborhoods, boroughs, districts.
3788 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
3789 # the latest revision.
3790 #
3791 # All new revisions **must** be backward compatible with old revisions.
3792 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3793 },
3794 ],
3795 "locations": [ # Optional but strongly recommended for the best service experience.
3796 #
3797 # Location(s) where the emploeyer is looking to hire for this job posting.
3798 #
3799 # Specifying the full street address(es) of the hiring location enables
3800 # better API results, especially job searches by commute time.
3801 #
3802 # At most 50 locations are allowed for best search performance. If a job has
3803 # more locations, it is suggested to split it into multiple jobs with unique
3804 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
3805 # multiple jobs with the same requisition_id, company_name and
3806 # language_code are not allowed. If the original requisition_id must
3807 # be preserved, a custom field should be used for storage. It is also
3808 # suggested to group the locations that close to each other in the same job
3809 # for better search experience.
3810 #
3811 # The maximum number of allowed characters is 500.
3812 "A String",
3813 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3814 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3815 # full time or
3816 # part time.
3817 "A String",
3818 ],
3819 "applicationUrls": [ # Optional but at least one of application_urls,
3820 # application_email_list or application_instruction must be
3821 # specified.
3822 #
3823 # Use this URL field to direct an applicant to a website, for example to
3824 # link to an online application form.
3825 #
3826 # The maximum number of allowed characters is 2,000.
3827 "A String",
3828 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3829 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3830 # "Bachelors", "Masters", "Doctorate".
3831 "A String",
3832 ],
3833 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
3834 #
3835 # Optional.
3836 #
3837 # Job compensation information.
3838 #
3839 # This field replaces compensation_info. Only
3840 # CompensationInfo.entries or extended_compensation_info can be set,
3841 # otherwise an exception is thrown.
3842 #
3843 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3844 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3845 # the job's all CompensationEntry cannot be annualized.
3846 # See CompensationEntry for explanation on annualization and base
3847 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3848 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3849 #
3850 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3851 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3852 #
3853 # Decimal number.
3854 "units": "A String", # Whole units.
3855 "micros": 42, # Micro (10^-6) units.
3856 # The value must be between -999,999 and +999,999 inclusive.
3857 # If `units` is positive, `micros` must be positive or zero.
3858 # If `units` is zero, `micros` can be positive, zero, or negative.
3859 # If `units` is negative, `micros` must be negative or zero.
3860 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3861 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3862 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3863 #
3864 # Decimal number.
3865 "units": "A String", # Whole units.
3866 "micros": 42, # Micro (10^-6) units.
3867 # The value must be between -999,999 and +999,999 inclusive.
3868 # If `units` is positive, `micros` must be positive or zero.
3869 # If `units` is zero, `micros` can be positive, zero, or negative.
3870 # If `units` is negative, `micros` must be negative or zero.
3871 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3872 },
3873 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3874 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3875 #
3876 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3877 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3878 #
3879 # Decimal number.
3880 "units": "A String", # Whole units.
3881 "micros": 42, # Micro (10^-6) units.
3882 # The value must be between -999,999 and +999,999 inclusive.
3883 # If `units` is positive, `micros` must be positive or zero.
3884 # If `units` is zero, `micros` can be positive, zero, or negative.
3885 # If `units` is negative, `micros` must be negative or zero.
3886 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3887 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3888 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3889 #
3890 # Decimal number.
3891 "units": "A String", # Whole units.
3892 "micros": 42, # Micro (10^-6) units.
3893 # The value must be between -999,999 and +999,999 inclusive.
3894 # If `units` is positive, `micros` must be positive or zero.
3895 # If `units` is zero, `micros` can be positive, zero, or negative.
3896 # If `units` is negative, `micros` must be negative or zero.
3897 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3898 },
3899 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3900 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3901 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3902 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3903 # the job's base compensation entry cannot be annualized.
3904 # See CompensationEntry for explanation on annualization and base
3905 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3906 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3907 #
3908 # At most one entry can be of type
3909 # ExtendedCompensationInfo.CompensationType.BASE, which is
3910 # referred as ** base compensation entry ** for the job.
3911 { # Deprecated. See CompensationInfo.
3912 #
3913 # A compensation entry that represents one component of compensation, such
3914 # as base pay, bonus, or other compensation type.
3915 #
3916 # Annualization: One compensation entry can be annualized if
3917 # - it contains valid amount or range.
3918 # - and its expected_units_per_year is set or can be derived.
3919 # Its annualized range is determined as (amount or range) times
3920 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3921 "description": "A String", # Optional. Compensation description.
3922 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3923 #
3924 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3925 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3926 #
3927 # Decimal number.
3928 "units": "A String", # Whole units.
3929 "micros": 42, # Micro (10^-6) units.
3930 # The value must be between -999,999 and +999,999 inclusive.
3931 # If `units` is positive, `micros` must be positive or zero.
3932 # If `units` is zero, `micros` can be positive, zero, or negative.
3933 # If `units` is negative, `micros` must be negative or zero.
3934 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3935 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3936 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3937 #
3938 # Decimal number.
3939 "units": "A String", # Whole units.
3940 "micros": 42, # Micro (10^-6) units.
3941 # The value must be between -999,999 and +999,999 inclusive.
3942 # If `units` is positive, `micros` must be positive or zero.
3943 # If `units` is zero, `micros` can be positive, zero, or negative.
3944 # If `units` is negative, `micros` must be negative or zero.
3945 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3946 },
3947 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3948 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
3949 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3950 # Job.employment_types is FULLTIME, a default value is inferred
3951 # based on unit. Default values:
3952 # - HOURLY: 2080
3953 # - DAILY: 260
3954 # - WEEKLY: 52
3955 # - MONTHLY: 12
3956 # - ANNUAL: 1
3957 #
3958 # Decimal number.
3959 "units": "A String", # Whole units.
3960 "micros": 42, # Micro (10^-6) units.
3961 # The value must be between -999,999 and +999,999 inclusive.
3962 # If `units` is positive, `micros` must be positive or zero.
3963 # If `units` is zero, `micros` can be positive, zero, or negative.
3964 # If `units` is negative, `micros` must be negative or zero.
3965 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3966 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3967 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3968 #
3969 # Decimal number.
3970 "units": "A String", # Whole units.
3971 "micros": 42, # Micro (10^-6) units.
3972 # The value must be between -999,999 and +999,999 inclusive.
3973 # If `units` is positive, `micros` must be positive or zero.
3974 # If `units` is zero, `micros` can be positive, zero, or negative.
3975 # If `units` is negative, `micros` must be negative or zero.
3976 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
3977 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3978 "type": "A String", # Required. Compensation type.
3979 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3980 #
3981 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
3982 },
3983 ],
3984 },
3985 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
3986 #
3987 # Optional.
3988 #
3989 # A map of fields to hold filterable custom job attributes not captured by
3990 # the standard fields such as job_title, company_name, or
3991 # level. These custom fields store arbitrary
3992 # string values, and can be used for purposes not covered by
3993 # the structured fields. For the best search experience, use of the
3994 # structured rather than custom fields is recommended.
3995 #
3996 # Data stored in these custom fields fields are indexed and
3997 # searched against by keyword searches (see
3998 # SearchJobsRequest.custom_field_filters][]).
3999 #
4000 # The map key must be a number between 1-20. If an invalid key is
4001 # provided on job create or update, an error is returned.
4002 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4003 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4004 "A String",
4005 ],
4006 },
4007 },
4008 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
4009 #
4010 # Optional but strongly recommended to be provided for the best service
4011 # experience.
4012 #
4013 # The expiration date of the job in UTC time. After 12 am on this date, the
4014 # job is marked as expired, and it no longer appears in search results.
4015 # The expired job can't be deleted or listed by the DeleteJob and
4016 # ListJobs APIs, but it can be retrieved with the GetJob API or
4017 # updated with the UpdateJob API. An expired job can be updated and
4018 # opened again by using a future expiration date. It can also remain expired.
4019 # Updating an expired job to be open fails if there is another existing open
4020 # job with same requisition_id, company_name and language_code.
4021 #
4022 # The expired jobs are retained in our system for 90 days. However, the
4023 # overall expired job count cannot exceed 3 times the maximum of open jobs
4024 # count over the past week, otherwise jobs with earlier expire time are
4025 # removed first. Expired jobs are no longer accessible after they are cleaned
4026 # out.
4027 #
4028 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
4029 # ignored and treated as expiry date not provided.
4030 #
4031 # If this value is not provided on job creation or is invalid, the job
4032 # posting expires after 30 days from the job's creation time. For example, if
4033 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
4034 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
4035 #
4036 # If this value is not provided on job update, it depends on the field masks
4037 # set by UpdateJobRequest.update_job_fields. If the field masks include
4038 # expiry_date, or the masks are empty meaning that every field is
4039 # updated, the job expires after 30 days from the job's last update time.
4040 # Otherwise the expiration date isn't updated.
4041 # and time zone are either specified elsewhere or are not significant. The date
4042 # is relative to the Proleptic Gregorian Calendar. This can represent:
4043 #
4044 # * A full date, with non-zero year, month and day values
4045 # * A month and day value, with a zero year, e.g. an anniversary
4046 # * A year on its own, with zero month and day values
4047 # * A year and month value, with a zero day, e.g. a credit card expiration date
4048 #
4049 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
4050 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4051 # month and day.
4052 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4053 # if specifying a year by itself or a year and month where the day is not
4054 # significant.
4055 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4056 # a year.
4057 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4058 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4059 # recommended as an alternative to using the more general description
4060 # field.
4061 #
4062 # This field accepts and sanitizes HTML input, and also accepts
4063 # bold, italic, ordered list, and unordered list markup tags.
4064 #
4065 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4066 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
4067 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4068 # base compensation entry's CompensationEntry.compensation times
4069 # CompensationEntry.expected_units_per_year.
4070 #
4071 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4072 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4073 # to a maximal compensation value and the currency code is set to
4074 # match the currency code of
4075 # min_compensation.
4076 "nanos": 42, # Number of nano (10^-9) units of the amount.
4077 # The value must be between -999,999,999 and +999,999,999 inclusive.
4078 # If `units` is positive, `nanos` must be positive or zero.
4079 # If `units` is zero, `nanos` can be positive, zero, or negative.
4080 # If `units` is negative, `nanos` must be negative or zero.
4081 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4082 "units": "A String", # The whole units of the amount.
4083 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4084 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4085 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4086 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4087 # to zero and the currency code is set to match the
4088 # currency code of max_compensation.
4089 "nanos": 42, # Number of nano (10^-9) units of the amount.
4090 # The value must be between -999,999,999 and +999,999,999 inclusive.
4091 # If `units` is positive, `nanos` must be positive or zero.
4092 # If `units` is zero, `nanos` can be positive, zero, or negative.
4093 # If `units` is negative, `nanos` must be negative or zero.
4094 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4095 "units": "A String", # The whole units of the amount.
4096 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4097 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4098 },
4099 },
4100 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
4101 #
4102 # Optional.
4103 #
4104 # A lower bound on a range for compensation or pay for the job.
4105 # The currency type is specified in compensation_amount.
4106 "nanos": 42, # Number of nano (10^-9) units of the amount.
4107 # The value must be between -999,999,999 and +999,999,999 inclusive.
4108 # If `units` is positive, `nanos` must be positive or zero.
4109 # If `units` is zero, `nanos` can be positive, zero, or negative.
4110 # If `units` is negative, `nanos` must be negative or zero.
4111 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4112 "units": "A String", # The whole units of the amount.
4113 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4114 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4115 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4116 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4117 # all compensation entries' CompensationEntry.compensation times
4118 # CompensationEntry.expected_units_per_year.
4119 #
4120 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4121 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4122 # to a maximal compensation value and the currency code is set to
4123 # match the currency code of
4124 # min_compensation.
4125 "nanos": 42, # Number of nano (10^-9) units of the amount.
4126 # The value must be between -999,999,999 and +999,999,999 inclusive.
4127 # If `units` is positive, `nanos` must be positive or zero.
4128 # If `units` is zero, `nanos` can be positive, zero, or negative.
4129 # If `units` is negative, `nanos` must be negative or zero.
4130 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4131 "units": "A String", # The whole units of the amount.
4132 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4133 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4134 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4135 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4136 # to zero and the currency code is set to match the
4137 # currency code of max_compensation.
4138 "nanos": 42, # Number of nano (10^-9) units of the amount.
4139 # The value must be between -999,999,999 and +999,999,999 inclusive.
4140 # If `units` is positive, `nanos` must be positive or zero.
4141 # If `units` is zero, `nanos` can be positive, zero, or negative.
4142 # If `units` is negative, `nanos` must be negative or zero.
4143 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4144 "units": "A String", # The whole units of the amount.
4145 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4146 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4147 },
4148 },
4149 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
4150 #
4151 # Optional.
4152 #
4153 # An upper bound on a range for compensation or pay for the job.
4154 # The currency type is specified in compensation_amount.
4155 "nanos": 42, # Number of nano (10^-9) units of the amount.
4156 # The value must be between -999,999,999 and +999,999,999 inclusive.
4157 # If `units` is positive, `nanos` must be positive or zero.
4158 # If `units` is zero, `nanos` can be positive, zero, or negative.
4159 # If `units` is negative, `nanos` must be negative or zero.
4160 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4161 "units": "A String", # The whole units of the amount.
4162 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4163 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4164 },
4165 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
4166 #
4167 # Optional.
4168 #
4169 # The amount of compensation or pay for the job.
4170 # As an alternative, compensation_amount_min and
4171 # compensation_amount_max may be used to define a range of
4172 # compensation.
4173 "nanos": 42, # Number of nano (10^-9) units of the amount.
4174 # The value must be between -999,999,999 and +999,999,999 inclusive.
4175 # If `units` is positive, `nanos` must be positive or zero.
4176 # If `units` is zero, `nanos` can be positive, zero, or negative.
4177 # If `units` is negative, `nanos` must be negative or zero.
4178 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4179 "units": "A String", # The whole units of the amount.
4180 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4181 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4182 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4183 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4184 #
4185 # At most one entry can be of type
4186 # CompensationInfo.CompensationType.BASE, which is
4187 # referred as ** base compensation entry ** for the job.
4188 { # A compensation entry that represents one component of compensation, such
4189 # as base pay, bonus, or other compensation type.
4190 #
4191 # Annualization: One compensation entry can be annualized if
4192 # - it contains valid amount or range.
4193 # - and its expected_units_per_year is set or can be derived.
4194 # Its annualized range is determined as (amount or range) times
4195 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4196 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4197 # indicate equity terms or provide additional context to an estimated
4198 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4199 "range": { # Compensation range. # Optional. Compensation range.
4200 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4201 # to a maximal compensation value and the currency code is set to
4202 # match the currency code of
4203 # min_compensation.
4204 "nanos": 42, # Number of nano (10^-9) units of the amount.
4205 # The value must be between -999,999,999 and +999,999,999 inclusive.
4206 # If `units` is positive, `nanos` must be positive or zero.
4207 # If `units` is zero, `nanos` can be positive, zero, or negative.
4208 # If `units` is negative, `nanos` must be negative or zero.
4209 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4210 "units": "A String", # The whole units of the amount.
4211 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4212 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4213 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4214 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4215 # to zero and the currency code is set to match the
4216 # currency code of max_compensation.
4217 "nanos": 42, # Number of nano (10^-9) units of the amount.
4218 # The value must be between -999,999,999 and +999,999,999 inclusive.
4219 # If `units` is positive, `nanos` must be positive or zero.
4220 # If `units` is zero, `nanos` can be positive, zero, or negative.
4221 # If `units` is negative, `nanos` must be negative or zero.
4222 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4223 "units": "A String", # The whole units of the amount.
4224 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4225 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4226 },
4227 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4228 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4229 # Job.employment_types is FULLTIME, a default value is inferred
4230 # based on unit. Default values:
4231 # - HOURLY: 2080
4232 # - DAILY: 260
4233 # - WEEKLY: 52
4234 # - MONTHLY: 12
4235 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4236 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4237 "nanos": 42, # Number of nano (10^-9) units of the amount.
4238 # The value must be between -999,999,999 and +999,999,999 inclusive.
4239 # If `units` is positive, `nanos` must be positive or zero.
4240 # If `units` is zero, `nanos` can be positive, zero, or negative.
4241 # If `units` is negative, `nanos` must be negative or zero.
4242 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4243 "units": "A String", # The whole units of the amount.
4244 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4245 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4246 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4247 "type": "A String", # Required. Compensation type.
4248 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4249 #
4250 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
4251 },
4252 ],
4253 "type": "A String", # Deprecated. Use entries instead.
4254 #
4255 # Optional.
4256 #
4257 # Type of job compensation.
4258 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4259 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4260 # position.
4261 #
4262 # The maximum number of allowed characters is 255.
4263 "applicationInstruction": "A String", # Optional but at least one of application_urls,
4264 # application_email_list or application_instruction must be
4265 # specified.
4266 #
4267 # Use this field to provide instructions, such as "Mail your application
4268 # to ...", that a candidate can follow to apply for the job.
4269 #
4270 # This field accepts and sanitizes HTML input, and also accepts
4271 # bold, italic, ordered list, and unordered list markup tags.
4272 #
4273 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4274 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
4275 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4276 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4277 # The maximum number of allowed characters is 10,000.
4278 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4279 # description of the company and related information. Separate fields are
4280 # provided on the job object for responsibilities,
4281 # qualifications, and other job characteristics. Use of
4282 # these separate job fields is recommended.
4283 #
4284 # This field accepts and sanitizes HTML input, and also accepts
4285 # bold, italic, ordered list, and unordered list markup tags.
4286 #
4287 # The maximum number of allowed characters is 100,000.
4288 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
4289 # provided.
4290 #
4291 # The resource name of the company listing the job, such as
4292 # /companies/foo. This field takes precedence over the
4293 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4294 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4295 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4296 # The maximum number of allowed characters is 500.
4297 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4298 # client to identify a job. This field is intended to be used by clients
4299 # for client identification and tracking of listings. A job is not allowed
4300 # to be created if there is another job with the same requisition_id,
4301 # company_name and language_code.
4302 #
4303 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4304 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4305 # job. The use of this field is recommended
4306 # as an alternative to using the more general description field.
4307 #
4308 # This field accepts and sanitizes HTML input, and also accepts
4309 # bold, italic, ordered list, and unordered list markup tags.
4310 #
4311 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4312 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4313 # Defaults to JobVisibility.PRIVATE if not specified.
4314 # Currently only JobVisibility.PRIVATE is supported.
4315 "expireTime": "A String", # Optional but strongly recommended for the best service
4316 # experience.
4317 #
4318 # The expiration timestamp of the job. After this timestamp, the
4319 # job is marked as expired, and it no longer appears in search results. The
4320 # expired job can't be deleted or listed by the DeleteJob and
4321 # ListJobs APIs, but it can be retrieved with the GetJob API or
4322 # updated with the UpdateJob API. An expired job can be updated and
4323 # opened again by using a future expiration timestamp. Updating an expired
4324 # job fails if there is another existing open job with same
4325 # requisition_id, company_name and language_code.
4326 #
4327 # The expired jobs are retained in our system for 90 days. However, the
4328 # overall expired job count cannot exceed 3 times the maximum of open jobs
4329 # count over the past week, otherwise jobs with earlier expire time are
4330 # cleaned first. Expired jobs are no longer accessible after they are cleaned
4331 # out.
4332 # The format of this field is RFC 3339 date strings. Example:
4333 # 2000-01-01T00:00:00.999999999Z
4334 # See
4335 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
4336 #
4337 # A valid date range is between 1970-01-01T00:00:00.0Z and
4338 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
4339 # time not provided.
4340 #
4341 # If this value is not provided at the time of job creation or is invalid,
4342 # the job posting expires after 30 days from the job's creation time. For
4343 # example, if the job was created on 2017/01/01 13:00AM UTC with an
4344 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
4345 #
4346 # If this value is not provided but expiry_date is, expiry_date is
4347 # used.
4348 #
4349 # If this value is not provided on job update, it depends on the field masks
4350 # set by UpdateJobRequest.update_job_fields. If the field masks include
4351 # expiry_time, or the masks are empty meaning that every field is
4352 # updated, the job posting expires after 30 days from the job's last
4353 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4354 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4355 # value is the time the request arrives at the server.
4356 # and time zone are either specified elsewhere or are not significant. The date
4357 # is relative to the Proleptic Gregorian Calendar. This can represent:
4358 #
4359 # * A full date, with non-zero year, month and day values
4360 # * A month and day value, with a zero year, e.g. an anniversary
4361 # * A year on its own, with zero month and day values
4362 # * A year and month value, with a zero day, e.g. a credit card expiration date
4363 #
4364 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
4365 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4366 # month and day.
4367 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4368 # if specifying a year by itself or a year and month where the day is not
4369 # significant.
4370 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4371 # a year.
4372 },
4373 "applicationEmailList": [ # Optional but at least one of application_urls,
4374 # application_email_list or application_instruction must be
4375 # specified.
4376 #
4377 # Use this field to specify email address(es) to which resumes or
4378 # applications can be sent.
4379 #
4380 # The maximum number of allowed characters is 255.
4381 "A String",
4382 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4383 "createTime": "A String", # Output only. The timestamp when this job was created.
4384 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4385 "A String",
4386 ],
4387 "name": "A String", # Required during job update.
4388 #
4389 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
4390 # of this field in job queries and API calls is preferred over the use of
4391 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4392 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4393 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
4394 #
4395 # Output only.
4396 #
4397 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4398 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4399 # is available. If this field is set, a
4400 # LocationFilter in a search query within the job region
4401 # finds this job if an exact location match is not specified.
4402 # If this field is set, setting job locations
4403 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4404 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4405 # The value determines the sort order of the jobs returned when searching for
4406 # jobs using the featured jobs search call, with higher promotional values
4407 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4408 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4409 #
4410 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4411 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
4412 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4413 # attributes that are not covered by the provided structured fields.
4414 #
4415 # This field is a more general combination of the deprecated id-based
4416 # filterable_custom_fields and string-based
4417 # non_filterable_custom_fields.
4418 #
4419 # The keys of the map are strings up to 64 bytes and must match the
4420 # pattern: a-zA-Z*.
4421 #
4422 # At most 100 filterable and at most 100 unfilterable keys are supported.
4423 # For filterable `string_values`, across all keys at most 200 values are
4424 # allowed, with each string no more than 255 characters. For unfilterable
4425 # `string_values`, the maximum total size of `string_values` across all keys
4426 # is 50KB.
4427 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4428 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4429 # If false, values are not searchable.
4430 #
4431 # Default is false.
4432 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
4433 # be specified.
4434 #
4435 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
4436 # `CASE_INSENSITIVE_MATCH`) search.
4437 # For filterable `string_values`, a maximum total number of 200 values
4438 # is allowed, with each `string_value` has a byte size of no more than
4439 # 255B. For unfilterable `string_values`, the maximum total byte size of
4440 # unfilterable `string_values` is 50KB.
4441 #
4442 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4443 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4444 "A String",
4445 ],
4446 },
4447 "longValue": "A String", # Optional but at least one of string_values or long_value must
4448 # be specified.
4449 #
4450 # This field is used to perform number range search.
4451 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
4452 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
4453 },
4454 },
4455 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
4456 # provided.
4457 #
4458 # A unique company identifier used by job distributors to identify an
4459 # employer's company entity. company_name takes precedence over
4460 # this field, and is the recommended field to use to identify companies.
4461 #
4462 # The maximum number of allowed characters is 255.
4463 },
4464 ],
4465 "metadata": { # Output only. # Additional information for the API invocation, such as the request
4466 # tracking id.
4467 #
4468 # Additional information returned to client, such as debugging
4469 # information.
4470 "requestId": "A String", # A unique id associated with this call.
4471 # This id is logged for tracking purposes.
4472 "experimentIdList": [ # Identifiers for the versions of the search algorithm used during
4473 # this API invocation if multiple algorithms are used.
4474 # The default value is empty.
4475 # For search response only.
4476 42,
4477 ],
4478 "mode": "A String", # For search response only. Indicates the mode of a performed search.
4479 },
4480 }</pre>
4481</div>
4482
4483<div class="method">
4484 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
4485 <pre>Retrieves the next page of results.
4486
4487Args:
4488 previous_request: The request for the previous page. (required)
4489 previous_response: The response from the request for the previous page. (required)
4490
4491Returns:
4492 A request object that you can call 'execute()' on to request the next
4493 page. Returns None if there are no more items in the collection.
4494 </pre>
4495</div>
4496
4497<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4498 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4499 <pre>Updates specified job.
4500
4501Typically, updated contents become visible in search results within 10
4502seconds, but it may take up to 5 minutes.
4503
4504Args:
4505 name: string, Required during job update.
4506
4507Resource name assigned to a job by the API, for example, "/jobs/foo". Use
4508of this field in job queries and API calls is preferred over the use of
4509requisition_id since this value is unique. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4510 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4511 The object takes the form of:
4512
4513{ # Input only.
4514 #
4515 # Update job request.
4516 "updateJobFields": "A String", # Optional but strongly recommended to be provided for the best service
4517 # experience.
4518 #
4519 # If update_job_fields is provided, only the specified fields in
4520 # job are updated. Otherwise all the fields are updated.
4521 #
4522 # A field mask to restrict the fields that are updated. Valid values are:
4523 #
4524 # * jobTitle
4525 # * employmentTypes
4526 # * description
4527 # * applicationUrls
4528 # * applicationEmailList
4529 # * applicationInstruction
4530 # * responsibilities
4531 # * qualifications
4532 # * educationLevels
4533 # * level
4534 # * department
4535 # * startDate
4536 # * endDate
4537 # * compensationInfo
4538 # * incentives
4539 # * languageCode
4540 # * benefits
4541 # * expireTime
4542 # * customAttributes
4543 # * visibility
4544 # * publishDate
4545 # * promotionValue
4546 # * locations
4547 # * region
4548 # * expiryDate (deprecated)
4549 # * filterableCustomFields (deprecated)
4550 # * unindexedCustomFields (deprecated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4551 "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4552 # or "job requisition"). A job belongs to a Company, which is the hiring
4553 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4554 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4555 # any requirements for fluency that are associated with the job.
4556 #
4557 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
4558 # For more information, see
4559 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
4560 # class="external" target="_blank" }.
4561 #
4562 # If this field is unspecified and Job.description is present, detected
4563 # language code based on Job.description is assigned, otherwise
4564 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4565 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4566 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
4567 #
4568 # Optional.
4569 #
4570 # A map of fields to hold non-filterable custom job attributes, similar to
4571 # filterable_custom_fields. These fields are distinct in that the data
4572 # in these fields are not indexed. Therefore, the client cannot search
4573 # against them, nor can the client use them to list jobs.
4574 #
4575 # The key of the map can be any valid string.
4576 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4577 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4578 "A String",
4579 ],
4580 },
4581 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4582 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4583 # is used for contracting engagements.
4584 # Dates prior to 1970/1/1 and invalid date formats are ignored.
4585 # and time zone are either specified elsewhere or are not significant. The date
4586 # is relative to the Proleptic Gregorian Calendar. This can represent:
4587 #
4588 # * A full date, with non-zero year, month and day values
4589 # * A month and day value, with a zero year, e.g. an anniversary
4590 # * A year on its own, with zero month and day values
4591 # * A year and month value, with a zero day, e.g. a credit card expiration date
4592 #
4593 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
4594 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4595 # month and day.
4596 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4597 # if specifying a year by itself or a year and month where the day is not
4598 # significant.
4599 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4600 # a year.
4601 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4602 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
4603 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4604 # is used for contracting engagements.
4605 # Dates prior to 1970/1/1 and invalid date formats are ignored.
4606 # and time zone are either specified elsewhere or are not significant. The date
4607 # is relative to the Proleptic Gregorian Calendar. This can represent:
4608 #
4609 # * A full date, with non-zero year, month and day values
4610 # * A month and day value, with a zero year, e.g. an anniversary
4611 # * A year on its own, with zero month and day values
4612 # * A year and month value, with a zero day, e.g. a credit card expiration date
4613 #
4614 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
4615 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4616 # month and day.
4617 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4618 # if specifying a year by itself or a year and month where the day is not
4619 # significant.
4620 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4621 # a year.
4622 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4623 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4624 { # Output only.
4625 #
4626 # A resource that represents a location with full geographic
4627 # information.
4628 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
4629 # location bounding box in which a circle with the specified radius
4630 # centered from LatLng coves the area associated with the job location.
4631 # For example, currently, "Mountain View, CA, USA" has a radius of
4632 # 7885.79 meters.
4633 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
4634 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
4635 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
4636 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4637 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
4638 # of doubles representing degrees latitude and degrees longitude. Unless
4639 # specified otherwise, this must conform to the
4640 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
4641 # standard&lt;/a&gt;. Values must be within normalized ranges.
4642 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
4643 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
4644 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4645 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
4646 # such as postal delivery and payments addresses. Given a postal address,
4647 # a postal service can deliver items to a premises, P.O. Box, or other
4648 # delivery location.
4649 # Given a postal address, a postal service can deliver items to a premise, P.O.
4650 # Box or similar.
4651 # It is not intended to model geographical locations (roads, towns,
4652 # mountains).
4653 #
4654 # In typical usage an address would be created via user input or from importing
4655 # existing data, depending on the type of process.
4656 #
4657 # Advice on address input / editing:
4658 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4659 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4660 # - Users should not be presented with UI elements for input or editing of
4661 # fields outside countries where that field is used.
4662 #
4663 # For more guidance on how to use this schema, please see:
4664 # https://support.google.com/business/answer/6397478
4665 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
4666 # known). This is often the UI language of the input form or is expected
4667 # to match one of the languages used in the address' country/region, or their
4668 # transliterated equivalents.
4669 # This can affect formatting in certain countries, but is not critical
4670 # to the correctness of the data and will never affect any validation or
4671 # other non-formatting related operations.
4672 #
4673 # If this value is not known, it should be omitted (rather than specifying a
4674 # possibly incorrect default).
4675 #
4676 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
4677 "recipients": [ # Optional. The recipient at the address.
4678 # This field may, under certain circumstances, contain multiline information.
4679 # For example, it might contain "care of" information.
4680 "A String",
4681 ],
4682 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
4683 # Examples: US city, IT comune, UK post town.
4684 # In regions of the world where localities are not well defined or do not fit
4685 # into this structure well, leave locality empty and use address_lines.
4686 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
4687 # in most regions. Where it is used, the value is either a string like
4688 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
4689 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
4690 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
4691 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
4692 # is never inferred and it is up to the user to ensure the value is
4693 # correct. See http://cldr.unicode.org/ and
4694 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
4695 # for details. Example: "CH" for Switzerland.
4696 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
4697 # addresses of a country or region.
4698 # For example, this can be a state, a province, an oblast, or a prefecture.
4699 # Specifically, for Spain this is the province and not the autonomous
4700 # community (e.g. "Barcelona" and not "Catalonia").
4701 # Many countries don't use an administrative area in postal addresses. E.g.
4702 # in Switzerland this should be left unpopulated.
4703 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
4704 #
4705 # Because values in address_lines do not have type information and may
4706 # sometimes contain multiple values in a single field (e.g.
4707 # "Austin, TX"), it is important that the line order is clear. The order of
4708 # address lines should be "envelope order" for the country/region of the
4709 # address. In places where this can vary (e.g. Japan), address_language is
4710 # used to make it explicit (e.g. "ja" for large-to-small ordering and
4711 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
4712 # an address can be selected based on the language.
4713 #
4714 # The minimum permitted structural representation of an address consists
4715 # of a region_code with all remaining information placed in the
4716 # address_lines. It would be possible to format such an address very
4717 # approximately without geocoding, but no semantic reasoning could be
4718 # made about any of the address components until it was at least
4719 # partially resolved.
4720 #
4721 # Creating an address only containing a region_code and address_lines, and
4722 # then geocoding is the recommended way to handle completely unstructured
4723 # addresses (as opposed to guessing which parts of the address should be
4724 # localities or administrative areas).
4725 "A String",
4726 ],
4727 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
4728 # postal codes to be present, but where they are used, they may trigger
4729 # additional validation with other parts of the address (e.g. state/zip
4730 # validation in the U.S.A.).
4731 "organization": "A String", # Optional. The name of the organization at the address.
4732 "sublocality": "A String", # Optional. Sublocality of the address.
4733 # For example, this can be neighborhoods, boroughs, districts.
4734 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
4735 # the latest revision.
4736 #
4737 # All new revisions **must** be backward compatible with old revisions.
4738 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4739 },
4740 ],
4741 "locations": [ # Optional but strongly recommended for the best service experience.
4742 #
4743 # Location(s) where the emploeyer is looking to hire for this job posting.
4744 #
4745 # Specifying the full street address(es) of the hiring location enables
4746 # better API results, especially job searches by commute time.
4747 #
4748 # At most 50 locations are allowed for best search performance. If a job has
4749 # more locations, it is suggested to split it into multiple jobs with unique
4750 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
4751 # multiple jobs with the same requisition_id, company_name and
4752 # language_code are not allowed. If the original requisition_id must
4753 # be preserved, a custom field should be used for storage. It is also
4754 # suggested to group the locations that close to each other in the same job
4755 # for better search experience.
4756 #
4757 # The maximum number of allowed characters is 500.
4758 "A String",
4759 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4760 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4761 # full time or
4762 # part time.
4763 "A String",
4764 ],
4765 "applicationUrls": [ # Optional but at least one of application_urls,
4766 # application_email_list or application_instruction must be
4767 # specified.
4768 #
4769 # Use this URL field to direct an applicant to a website, for example to
4770 # link to an online application form.
4771 #
4772 # The maximum number of allowed characters is 2,000.
4773 "A String",
4774 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4775 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4776 # "Bachelors", "Masters", "Doctorate".
4777 "A String",
4778 ],
4779 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
4780 #
4781 # Optional.
4782 #
4783 # Job compensation information.
4784 #
4785 # This field replaces compensation_info. Only
4786 # CompensationInfo.entries or extended_compensation_info can be set,
4787 # otherwise an exception is thrown.
4788 #
4789 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4790 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4791 # the job's all CompensationEntry cannot be annualized.
4792 # See CompensationEntry for explanation on annualization and base
4793 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4794 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4795 #
4796 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4797 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4798 #
4799 # Decimal number.
4800 "units": "A String", # Whole units.
4801 "micros": 42, # Micro (10^-6) units.
4802 # The value must be between -999,999 and +999,999 inclusive.
4803 # If `units` is positive, `micros` must be positive or zero.
4804 # If `units` is zero, `micros` can be positive, zero, or negative.
4805 # If `units` is negative, `micros` must be negative or zero.
4806 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4807 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4808 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4809 #
4810 # Decimal number.
4811 "units": "A String", # Whole units.
4812 "micros": 42, # Micro (10^-6) units.
4813 # The value must be between -999,999 and +999,999 inclusive.
4814 # If `units` is positive, `micros` must be positive or zero.
4815 # If `units` is zero, `micros` can be positive, zero, or negative.
4816 # If `units` is negative, `micros` must be negative or zero.
4817 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4818 },
4819 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4820 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4821 #
4822 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4823 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4824 #
4825 # Decimal number.
4826 "units": "A String", # Whole units.
4827 "micros": 42, # Micro (10^-6) units.
4828 # The value must be between -999,999 and +999,999 inclusive.
4829 # If `units` is positive, `micros` must be positive or zero.
4830 # If `units` is zero, `micros` can be positive, zero, or negative.
4831 # If `units` is negative, `micros` must be negative or zero.
4832 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4833 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4834 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4835 #
4836 # Decimal number.
4837 "units": "A String", # Whole units.
4838 "micros": 42, # Micro (10^-6) units.
4839 # The value must be between -999,999 and +999,999 inclusive.
4840 # If `units` is positive, `micros` must be positive or zero.
4841 # If `units` is zero, `micros` can be positive, zero, or negative.
4842 # If `units` is negative, `micros` must be negative or zero.
4843 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4844 },
4845 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4846 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4847 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4848 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4849 # the job's base compensation entry cannot be annualized.
4850 # See CompensationEntry for explanation on annualization and base
4851 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4852 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4853 #
4854 # At most one entry can be of type
4855 # ExtendedCompensationInfo.CompensationType.BASE, which is
4856 # referred as ** base compensation entry ** for the job.
4857 { # Deprecated. See CompensationInfo.
4858 #
4859 # A compensation entry that represents one component of compensation, such
4860 # as base pay, bonus, or other compensation type.
4861 #
4862 # Annualization: One compensation entry can be annualized if
4863 # - it contains valid amount or range.
4864 # - and its expected_units_per_year is set or can be derived.
4865 # Its annualized range is determined as (amount or range) times
4866 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4867 "description": "A String", # Optional. Compensation description.
4868 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4869 #
4870 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4871 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4872 #
4873 # Decimal number.
4874 "units": "A String", # Whole units.
4875 "micros": 42, # Micro (10^-6) units.
4876 # The value must be between -999,999 and +999,999 inclusive.
4877 # If `units` is positive, `micros` must be positive or zero.
4878 # If `units` is zero, `micros` can be positive, zero, or negative.
4879 # If `units` is negative, `micros` must be negative or zero.
4880 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4881 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4882 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4883 #
4884 # Decimal number.
4885 "units": "A String", # Whole units.
4886 "micros": 42, # Micro (10^-6) units.
4887 # The value must be between -999,999 and +999,999 inclusive.
4888 # If `units` is positive, `micros` must be positive or zero.
4889 # If `units` is zero, `micros` can be positive, zero, or negative.
4890 # If `units` is negative, `micros` must be negative or zero.
4891 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4892 },
4893 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4894 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
4895 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4896 # Job.employment_types is FULLTIME, a default value is inferred
4897 # based on unit. Default values:
4898 # - HOURLY: 2080
4899 # - DAILY: 260
4900 # - WEEKLY: 52
4901 # - MONTHLY: 12
4902 # - ANNUAL: 1
4903 #
4904 # Decimal number.
4905 "units": "A String", # Whole units.
4906 "micros": 42, # Micro (10^-6) units.
4907 # The value must be between -999,999 and +999,999 inclusive.
4908 # If `units` is positive, `micros` must be positive or zero.
4909 # If `units` is zero, `micros` can be positive, zero, or negative.
4910 # If `units` is negative, `micros` must be negative or zero.
4911 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4912 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4913 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4914 #
4915 # Decimal number.
4916 "units": "A String", # Whole units.
4917 "micros": 42, # Micro (10^-6) units.
4918 # The value must be between -999,999 and +999,999 inclusive.
4919 # If `units` is positive, `micros` must be positive or zero.
4920 # If `units` is zero, `micros` can be positive, zero, or negative.
4921 # If `units` is negative, `micros` must be negative or zero.
4922 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
4923 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4924 "type": "A String", # Required. Compensation type.
4925 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4926 #
4927 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
4928 },
4929 ],
4930 },
4931 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
4932 #
4933 # Optional.
4934 #
4935 # A map of fields to hold filterable custom job attributes not captured by
4936 # the standard fields such as job_title, company_name, or
4937 # level. These custom fields store arbitrary
4938 # string values, and can be used for purposes not covered by
4939 # the structured fields. For the best search experience, use of the
4940 # structured rather than custom fields is recommended.
4941 #
4942 # Data stored in these custom fields fields are indexed and
4943 # searched against by keyword searches (see
4944 # SearchJobsRequest.custom_field_filters][]).
4945 #
4946 # The map key must be a number between 1-20. If an invalid key is
4947 # provided on job create or update, an error is returned.
4948 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4949 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4950 "A String",
4951 ],
4952 },
4953 },
4954 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
4955 #
4956 # Optional but strongly recommended to be provided for the best service
4957 # experience.
4958 #
4959 # The expiration date of the job in UTC time. After 12 am on this date, the
4960 # job is marked as expired, and it no longer appears in search results.
4961 # The expired job can't be deleted or listed by the DeleteJob and
4962 # ListJobs APIs, but it can be retrieved with the GetJob API or
4963 # updated with the UpdateJob API. An expired job can be updated and
4964 # opened again by using a future expiration date. It can also remain expired.
4965 # Updating an expired job to be open fails if there is another existing open
4966 # job with same requisition_id, company_name and language_code.
4967 #
4968 # The expired jobs are retained in our system for 90 days. However, the
4969 # overall expired job count cannot exceed 3 times the maximum of open jobs
4970 # count over the past week, otherwise jobs with earlier expire time are
4971 # removed first. Expired jobs are no longer accessible after they are cleaned
4972 # out.
4973 #
4974 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
4975 # ignored and treated as expiry date not provided.
4976 #
4977 # If this value is not provided on job creation or is invalid, the job
4978 # posting expires after 30 days from the job's creation time. For example, if
4979 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
4980 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
4981 #
4982 # If this value is not provided on job update, it depends on the field masks
4983 # set by UpdateJobRequest.update_job_fields. If the field masks include
4984 # expiry_date, or the masks are empty meaning that every field is
4985 # updated, the job expires after 30 days from the job's last update time.
4986 # Otherwise the expiration date isn't updated.
4987 # and time zone are either specified elsewhere or are not significant. The date
4988 # is relative to the Proleptic Gregorian Calendar. This can represent:
4989 #
4990 # * A full date, with non-zero year, month and day values
4991 # * A month and day value, with a zero year, e.g. an anniversary
4992 # * A year on its own, with zero month and day values
4993 # * A year and month value, with a zero day, e.g. a credit card expiration date
4994 #
4995 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
4996 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4997 # month and day.
4998 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4999 # if specifying a year by itself or a year and month where the day is not
5000 # significant.
5001 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5002 # a year.
5003 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5004 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5005 # recommended as an alternative to using the more general description
5006 # field.
5007 #
5008 # This field accepts and sanitizes HTML input, and also accepts
5009 # bold, italic, ordered list, and unordered list markup tags.
5010 #
5011 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5012 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
5013 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5014 # base compensation entry's CompensationEntry.compensation times
5015 # CompensationEntry.expected_units_per_year.
5016 #
5017 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5018 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5019 # to a maximal compensation value and the currency code is set to
5020 # match the currency code of
5021 # min_compensation.
5022 "nanos": 42, # Number of nano (10^-9) units of the amount.
5023 # The value must be between -999,999,999 and +999,999,999 inclusive.
5024 # If `units` is positive, `nanos` must be positive or zero.
5025 # If `units` is zero, `nanos` can be positive, zero, or negative.
5026 # If `units` is negative, `nanos` must be negative or zero.
5027 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5028 "units": "A String", # The whole units of the amount.
5029 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5030 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5031 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5032 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5033 # to zero and the currency code is set to match the
5034 # currency code of max_compensation.
5035 "nanos": 42, # Number of nano (10^-9) units of the amount.
5036 # The value must be between -999,999,999 and +999,999,999 inclusive.
5037 # If `units` is positive, `nanos` must be positive or zero.
5038 # If `units` is zero, `nanos` can be positive, zero, or negative.
5039 # If `units` is negative, `nanos` must be negative or zero.
5040 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5041 "units": "A String", # The whole units of the amount.
5042 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5043 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5044 },
5045 },
5046 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
5047 #
5048 # Optional.
5049 #
5050 # A lower bound on a range for compensation or pay for the job.
5051 # The currency type is specified in compensation_amount.
5052 "nanos": 42, # Number of nano (10^-9) units of the amount.
5053 # The value must be between -999,999,999 and +999,999,999 inclusive.
5054 # If `units` is positive, `nanos` must be positive or zero.
5055 # If `units` is zero, `nanos` can be positive, zero, or negative.
5056 # If `units` is negative, `nanos` must be negative or zero.
5057 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5058 "units": "A String", # The whole units of the amount.
5059 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5060 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5061 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5062 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5063 # all compensation entries' CompensationEntry.compensation times
5064 # CompensationEntry.expected_units_per_year.
5065 #
5066 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5067 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5068 # to a maximal compensation value and the currency code is set to
5069 # match the currency code of
5070 # min_compensation.
5071 "nanos": 42, # Number of nano (10^-9) units of the amount.
5072 # The value must be between -999,999,999 and +999,999,999 inclusive.
5073 # If `units` is positive, `nanos` must be positive or zero.
5074 # If `units` is zero, `nanos` can be positive, zero, or negative.
5075 # If `units` is negative, `nanos` must be negative or zero.
5076 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5077 "units": "A String", # The whole units of the amount.
5078 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5079 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5080 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5081 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5082 # to zero and the currency code is set to match the
5083 # currency code of max_compensation.
5084 "nanos": 42, # Number of nano (10^-9) units of the amount.
5085 # The value must be between -999,999,999 and +999,999,999 inclusive.
5086 # If `units` is positive, `nanos` must be positive or zero.
5087 # If `units` is zero, `nanos` can be positive, zero, or negative.
5088 # If `units` is negative, `nanos` must be negative or zero.
5089 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5090 "units": "A String", # The whole units of the amount.
5091 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5092 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5093 },
5094 },
5095 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
5096 #
5097 # Optional.
5098 #
5099 # An upper bound on a range for compensation or pay for the job.
5100 # The currency type is specified in compensation_amount.
5101 "nanos": 42, # Number of nano (10^-9) units of the amount.
5102 # The value must be between -999,999,999 and +999,999,999 inclusive.
5103 # If `units` is positive, `nanos` must be positive or zero.
5104 # If `units` is zero, `nanos` can be positive, zero, or negative.
5105 # If `units` is negative, `nanos` must be negative or zero.
5106 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5107 "units": "A String", # The whole units of the amount.
5108 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5109 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5110 },
5111 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
5112 #
5113 # Optional.
5114 #
5115 # The amount of compensation or pay for the job.
5116 # As an alternative, compensation_amount_min and
5117 # compensation_amount_max may be used to define a range of
5118 # compensation.
5119 "nanos": 42, # Number of nano (10^-9) units of the amount.
5120 # The value must be between -999,999,999 and +999,999,999 inclusive.
5121 # If `units` is positive, `nanos` must be positive or zero.
5122 # If `units` is zero, `nanos` can be positive, zero, or negative.
5123 # If `units` is negative, `nanos` must be negative or zero.
5124 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5125 "units": "A String", # The whole units of the amount.
5126 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5127 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5128 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5129 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5130 #
5131 # At most one entry can be of type
5132 # CompensationInfo.CompensationType.BASE, which is
5133 # referred as ** base compensation entry ** for the job.
5134 { # A compensation entry that represents one component of compensation, such
5135 # as base pay, bonus, or other compensation type.
5136 #
5137 # Annualization: One compensation entry can be annualized if
5138 # - it contains valid amount or range.
5139 # - and its expected_units_per_year is set or can be derived.
5140 # Its annualized range is determined as (amount or range) times
5141 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5142 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5143 # indicate equity terms or provide additional context to an estimated
5144 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5145 "range": { # Compensation range. # Optional. Compensation range.
5146 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5147 # to a maximal compensation value and the currency code is set to
5148 # match the currency code of
5149 # min_compensation.
5150 "nanos": 42, # Number of nano (10^-9) units of the amount.
5151 # The value must be between -999,999,999 and +999,999,999 inclusive.
5152 # If `units` is positive, `nanos` must be positive or zero.
5153 # If `units` is zero, `nanos` can be positive, zero, or negative.
5154 # If `units` is negative, `nanos` must be negative or zero.
5155 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5156 "units": "A String", # The whole units of the amount.
5157 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5158 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5159 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5160 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5161 # to zero and the currency code is set to match the
5162 # currency code of max_compensation.
5163 "nanos": 42, # Number of nano (10^-9) units of the amount.
5164 # The value must be between -999,999,999 and +999,999,999 inclusive.
5165 # If `units` is positive, `nanos` must be positive or zero.
5166 # If `units` is zero, `nanos` can be positive, zero, or negative.
5167 # If `units` is negative, `nanos` must be negative or zero.
5168 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5169 "units": "A String", # The whole units of the amount.
5170 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5171 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5172 },
5173 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5174 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5175 # Job.employment_types is FULLTIME, a default value is inferred
5176 # based on unit. Default values:
5177 # - HOURLY: 2080
5178 # - DAILY: 260
5179 # - WEEKLY: 52
5180 # - MONTHLY: 12
5181 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5182 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5183 "nanos": 42, # Number of nano (10^-9) units of the amount.
5184 # The value must be between -999,999,999 and +999,999,999 inclusive.
5185 # If `units` is positive, `nanos` must be positive or zero.
5186 # If `units` is zero, `nanos` can be positive, zero, or negative.
5187 # If `units` is negative, `nanos` must be negative or zero.
5188 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5189 "units": "A String", # The whole units of the amount.
5190 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5191 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5192 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5193 "type": "A String", # Required. Compensation type.
5194 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5195 #
5196 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
5197 },
5198 ],
5199 "type": "A String", # Deprecated. Use entries instead.
5200 #
5201 # Optional.
5202 #
5203 # Type of job compensation.
5204 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5205 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5206 # position.
5207 #
5208 # The maximum number of allowed characters is 255.
5209 "applicationInstruction": "A String", # Optional but at least one of application_urls,
5210 # application_email_list or application_instruction must be
5211 # specified.
5212 #
5213 # Use this field to provide instructions, such as "Mail your application
5214 # to ...", that a candidate can follow to apply for the job.
5215 #
5216 # This field accepts and sanitizes HTML input, and also accepts
5217 # bold, italic, ordered list, and unordered list markup tags.
5218 #
5219 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5220 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
5221 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5222 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5223 # The maximum number of allowed characters is 10,000.
5224 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5225 # description of the company and related information. Separate fields are
5226 # provided on the job object for responsibilities,
5227 # qualifications, and other job characteristics. Use of
5228 # these separate job fields is recommended.
5229 #
5230 # This field accepts and sanitizes HTML input, and also accepts
5231 # bold, italic, ordered list, and unordered list markup tags.
5232 #
5233 # The maximum number of allowed characters is 100,000.
5234 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
5235 # provided.
5236 #
5237 # The resource name of the company listing the job, such as
5238 # /companies/foo. This field takes precedence over the
5239 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5240 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5241 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5242 # The maximum number of allowed characters is 500.
5243 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5244 # client to identify a job. This field is intended to be used by clients
5245 # for client identification and tracking of listings. A job is not allowed
5246 # to be created if there is another job with the same requisition_id,
5247 # company_name and language_code.
5248 #
5249 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5250 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5251 # job. The use of this field is recommended
5252 # as an alternative to using the more general description field.
5253 #
5254 # This field accepts and sanitizes HTML input, and also accepts
5255 # bold, italic, ordered list, and unordered list markup tags.
5256 #
5257 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5258 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5259 # Defaults to JobVisibility.PRIVATE if not specified.
5260 # Currently only JobVisibility.PRIVATE is supported.
5261 "expireTime": "A String", # Optional but strongly recommended for the best service
5262 # experience.
5263 #
5264 # The expiration timestamp of the job. After this timestamp, the
5265 # job is marked as expired, and it no longer appears in search results. The
5266 # expired job can't be deleted or listed by the DeleteJob and
5267 # ListJobs APIs, but it can be retrieved with the GetJob API or
5268 # updated with the UpdateJob API. An expired job can be updated and
5269 # opened again by using a future expiration timestamp. Updating an expired
5270 # job fails if there is another existing open job with same
5271 # requisition_id, company_name and language_code.
5272 #
5273 # The expired jobs are retained in our system for 90 days. However, the
5274 # overall expired job count cannot exceed 3 times the maximum of open jobs
5275 # count over the past week, otherwise jobs with earlier expire time are
5276 # cleaned first. Expired jobs are no longer accessible after they are cleaned
5277 # out.
5278 # The format of this field is RFC 3339 date strings. Example:
5279 # 2000-01-01T00:00:00.999999999Z
5280 # See
5281 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
5282 #
5283 # A valid date range is between 1970-01-01T00:00:00.0Z and
5284 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
5285 # time not provided.
5286 #
5287 # If this value is not provided at the time of job creation or is invalid,
5288 # the job posting expires after 30 days from the job's creation time. For
5289 # example, if the job was created on 2017/01/01 13:00AM UTC with an
5290 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
5291 #
5292 # If this value is not provided but expiry_date is, expiry_date is
5293 # used.
5294 #
5295 # If this value is not provided on job update, it depends on the field masks
5296 # set by UpdateJobRequest.update_job_fields. If the field masks include
5297 # expiry_time, or the masks are empty meaning that every field is
5298 # updated, the job posting expires after 30 days from the job's last
5299 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5300 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5301 # value is the time the request arrives at the server.
5302 # and time zone are either specified elsewhere or are not significant. The date
5303 # is relative to the Proleptic Gregorian Calendar. This can represent:
5304 #
5305 # * A full date, with non-zero year, month and day values
5306 # * A month and day value, with a zero year, e.g. an anniversary
5307 # * A year on its own, with zero month and day values
5308 # * A year and month value, with a zero day, e.g. a credit card expiration date
5309 #
5310 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
5311 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5312 # month and day.
5313 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5314 # if specifying a year by itself or a year and month where the day is not
5315 # significant.
5316 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5317 # a year.
5318 },
5319 "applicationEmailList": [ # Optional but at least one of application_urls,
5320 # application_email_list or application_instruction must be
5321 # specified.
5322 #
5323 # Use this field to specify email address(es) to which resumes or
5324 # applications can be sent.
5325 #
5326 # The maximum number of allowed characters is 255.
5327 "A String",
5328 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5329 "createTime": "A String", # Output only. The timestamp when this job was created.
5330 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5331 "A String",
5332 ],
5333 "name": "A String", # Required during job update.
5334 #
5335 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
5336 # of this field in job queries and API calls is preferred over the use of
5337 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5338 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5339 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
5340 #
5341 # Output only.
5342 #
5343 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5344 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5345 # is available. If this field is set, a
5346 # LocationFilter in a search query within the job region
5347 # finds this job if an exact location match is not specified.
5348 # If this field is set, setting job locations
5349 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5350 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5351 # The value determines the sort order of the jobs returned when searching for
5352 # jobs using the featured jobs search call, with higher promotional values
5353 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5354 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5355 #
5356 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5357 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
5358 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5359 # attributes that are not covered by the provided structured fields.
5360 #
5361 # This field is a more general combination of the deprecated id-based
5362 # filterable_custom_fields and string-based
5363 # non_filterable_custom_fields.
5364 #
5365 # The keys of the map are strings up to 64 bytes and must match the
5366 # pattern: a-zA-Z*.
5367 #
5368 # At most 100 filterable and at most 100 unfilterable keys are supported.
5369 # For filterable `string_values`, across all keys at most 200 values are
5370 # allowed, with each string no more than 255 characters. For unfilterable
5371 # `string_values`, the maximum total size of `string_values` across all keys
5372 # is 50KB.
5373 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5374 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5375 # If false, values are not searchable.
5376 #
5377 # Default is false.
5378 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
5379 # be specified.
5380 #
5381 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
5382 # `CASE_INSENSITIVE_MATCH`) search.
5383 # For filterable `string_values`, a maximum total number of 200 values
5384 # is allowed, with each `string_value` has a byte size of no more than
5385 # 255B. For unfilterable `string_values`, the maximum total byte size of
5386 # unfilterable `string_values` is 50KB.
5387 #
5388 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5389 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5390 "A String",
5391 ],
5392 },
5393 "longValue": "A String", # Optional but at least one of string_values or long_value must
5394 # be specified.
5395 #
5396 # This field is used to perform number range search.
5397 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
5398 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
5399 },
5400 },
5401 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
5402 # provided.
5403 #
5404 # A unique company identifier used by job distributors to identify an
5405 # employer's company entity. company_name takes precedence over
5406 # this field, and is the recommended field to use to identify companies.
5407 #
5408 # The maximum number of allowed characters is 255.
5409 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5410 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5411 #
5412 # UpdateJobRequest.disable_street_address_resolution is ignored if this
5413 # flag is set.
5414 #
5415 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5416 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5417 #
5418 # * description
5419 # * applicationInstruction
5420 # * incentives
5421 # * qualifications
5422 # * responsibilities
5423 #
5424 # HTML tags in these fields may be stripped if sanitiazation is not disabled.
5425 #
5426 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5427 "disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5428 # more precise address for the job.
5429 },
5430 "disableStreetAddressResolution": True or False, # Deprecated. Please use processing_options. This flag is ignored if
5431 # processing_options is set.
5432 #
5433 # Optional.
5434 #
5435 # If set to `true`, the service does not attempt resolve a more precise
5436 # address for the job.
5437 }
5438
5439 x__xgafv: string, V1 error format.
5440 Allowed values
5441 1 - v1 error format
5442 2 - v2 error format
5443
5444Returns:
5445 An object of the form:
5446
5447 { # A Job resource represents a job posting (also referred to as a "job listing"
5448 # or "job requisition"). A job belongs to a Company, which is the hiring
5449 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5450 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5451 # any requirements for fluency that are associated with the job.
5452 #
5453 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
5454 # For more information, see
5455 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
5456 # class="external" target="_blank" }.
5457 #
5458 # If this field is unspecified and Job.description is present, detected
5459 # language code based on Job.description is assigned, otherwise
5460 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5461 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5462 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
5463 #
5464 # Optional.
5465 #
5466 # A map of fields to hold non-filterable custom job attributes, similar to
5467 # filterable_custom_fields. These fields are distinct in that the data
5468 # in these fields are not indexed. Therefore, the client cannot search
5469 # against them, nor can the client use them to list jobs.
5470 #
5471 # The key of the map can be any valid string.
5472 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5473 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5474 "A String",
5475 ],
5476 },
5477 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5478 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5479 # is used for contracting engagements.
5480 # Dates prior to 1970/1/1 and invalid date formats are ignored.
5481 # and time zone are either specified elsewhere or are not significant. The date
5482 # is relative to the Proleptic Gregorian Calendar. This can represent:
5483 #
5484 # * A full date, with non-zero year, month and day values
5485 # * A month and day value, with a zero year, e.g. an anniversary
5486 # * A year on its own, with zero month and day values
5487 # * A year and month value, with a zero day, e.g. a credit card expiration date
5488 #
5489 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
5490 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5491 # month and day.
5492 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5493 # if specifying a year by itself or a year and month where the day is not
5494 # significant.
5495 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5496 # a year.
5497 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5498 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
5499 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5500 # is used for contracting engagements.
5501 # Dates prior to 1970/1/1 and invalid date formats are ignored.
5502 # and time zone are either specified elsewhere or are not significant. The date
5503 # is relative to the Proleptic Gregorian Calendar. This can represent:
5504 #
5505 # * A full date, with non-zero year, month and day values
5506 # * A month and day value, with a zero year, e.g. an anniversary
5507 # * A year on its own, with zero month and day values
5508 # * A year and month value, with a zero day, e.g. a credit card expiration date
5509 #
5510 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
5511 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5512 # month and day.
5513 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5514 # if specifying a year by itself or a year and month where the day is not
5515 # significant.
5516 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5517 # a year.
5518 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5519 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5520 { # Output only.
5521 #
5522 # A resource that represents a location with full geographic
5523 # information.
5524 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
5525 # location bounding box in which a circle with the specified radius
5526 # centered from LatLng coves the area associated with the job location.
5527 # For example, currently, "Mountain View, CA, USA" has a radius of
5528 # 7885.79 meters.
5529 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
5530 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
5531 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
5532 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5533 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
5534 # of doubles representing degrees latitude and degrees longitude. Unless
5535 # specified otherwise, this must conform to the
5536 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
5537 # standard&lt;/a&gt;. Values must be within normalized ranges.
5538 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
5539 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
5540 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5541 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
5542 # such as postal delivery and payments addresses. Given a postal address,
5543 # a postal service can deliver items to a premises, P.O. Box, or other
5544 # delivery location.
5545 # Given a postal address, a postal service can deliver items to a premise, P.O.
5546 # Box or similar.
5547 # It is not intended to model geographical locations (roads, towns,
5548 # mountains).
5549 #
5550 # In typical usage an address would be created via user input or from importing
5551 # existing data, depending on the type of process.
5552 #
5553 # Advice on address input / editing:
5554 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5555 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5556 # - Users should not be presented with UI elements for input or editing of
5557 # fields outside countries where that field is used.
5558 #
5559 # For more guidance on how to use this schema, please see:
5560 # https://support.google.com/business/answer/6397478
5561 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
5562 # known). This is often the UI language of the input form or is expected
5563 # to match one of the languages used in the address' country/region, or their
5564 # transliterated equivalents.
5565 # This can affect formatting in certain countries, but is not critical
5566 # to the correctness of the data and will never affect any validation or
5567 # other non-formatting related operations.
5568 #
5569 # If this value is not known, it should be omitted (rather than specifying a
5570 # possibly incorrect default).
5571 #
5572 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
5573 "recipients": [ # Optional. The recipient at the address.
5574 # This field may, under certain circumstances, contain multiline information.
5575 # For example, it might contain "care of" information.
5576 "A String",
5577 ],
5578 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
5579 # Examples: US city, IT comune, UK post town.
5580 # In regions of the world where localities are not well defined or do not fit
5581 # into this structure well, leave locality empty and use address_lines.
5582 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
5583 # in most regions. Where it is used, the value is either a string like
5584 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
5585 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
5586 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
5587 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
5588 # is never inferred and it is up to the user to ensure the value is
5589 # correct. See http://cldr.unicode.org/ and
5590 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
5591 # for details. Example: "CH" for Switzerland.
5592 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
5593 # addresses of a country or region.
5594 # For example, this can be a state, a province, an oblast, or a prefecture.
5595 # Specifically, for Spain this is the province and not the autonomous
5596 # community (e.g. "Barcelona" and not "Catalonia").
5597 # Many countries don't use an administrative area in postal addresses. E.g.
5598 # in Switzerland this should be left unpopulated.
5599 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
5600 #
5601 # Because values in address_lines do not have type information and may
5602 # sometimes contain multiple values in a single field (e.g.
5603 # "Austin, TX"), it is important that the line order is clear. The order of
5604 # address lines should be "envelope order" for the country/region of the
5605 # address. In places where this can vary (e.g. Japan), address_language is
5606 # used to make it explicit (e.g. "ja" for large-to-small ordering and
5607 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
5608 # an address can be selected based on the language.
5609 #
5610 # The minimum permitted structural representation of an address consists
5611 # of a region_code with all remaining information placed in the
5612 # address_lines. It would be possible to format such an address very
5613 # approximately without geocoding, but no semantic reasoning could be
5614 # made about any of the address components until it was at least
5615 # partially resolved.
5616 #
5617 # Creating an address only containing a region_code and address_lines, and
5618 # then geocoding is the recommended way to handle completely unstructured
5619 # addresses (as opposed to guessing which parts of the address should be
5620 # localities or administrative areas).
5621 "A String",
5622 ],
5623 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
5624 # postal codes to be present, but where they are used, they may trigger
5625 # additional validation with other parts of the address (e.g. state/zip
5626 # validation in the U.S.A.).
5627 "organization": "A String", # Optional. The name of the organization at the address.
5628 "sublocality": "A String", # Optional. Sublocality of the address.
5629 # For example, this can be neighborhoods, boroughs, districts.
5630 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
5631 # the latest revision.
5632 #
5633 # All new revisions **must** be backward compatible with old revisions.
5634 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5635 },
5636 ],
5637 "locations": [ # Optional but strongly recommended for the best service experience.
5638 #
5639 # Location(s) where the emploeyer is looking to hire for this job posting.
5640 #
5641 # Specifying the full street address(es) of the hiring location enables
5642 # better API results, especially job searches by commute time.
5643 #
5644 # At most 50 locations are allowed for best search performance. If a job has
5645 # more locations, it is suggested to split it into multiple jobs with unique
5646 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
5647 # multiple jobs with the same requisition_id, company_name and
5648 # language_code are not allowed. If the original requisition_id must
5649 # be preserved, a custom field should be used for storage. It is also
5650 # suggested to group the locations that close to each other in the same job
5651 # for better search experience.
5652 #
5653 # The maximum number of allowed characters is 500.
5654 "A String",
5655 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5656 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5657 # full time or
5658 # part time.
5659 "A String",
5660 ],
5661 "applicationUrls": [ # Optional but at least one of application_urls,
5662 # application_email_list or application_instruction must be
5663 # specified.
5664 #
5665 # Use this URL field to direct an applicant to a website, for example to
5666 # link to an online application form.
5667 #
5668 # The maximum number of allowed characters is 2,000.
5669 "A String",
5670 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5671 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5672 # "Bachelors", "Masters", "Doctorate".
5673 "A String",
5674 ],
5675 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
5676 #
5677 # Optional.
5678 #
5679 # Job compensation information.
5680 #
5681 # This field replaces compensation_info. Only
5682 # CompensationInfo.entries or extended_compensation_info can be set,
5683 # otherwise an exception is thrown.
5684 #
5685 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5686 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5687 # the job's all CompensationEntry cannot be annualized.
5688 # See CompensationEntry for explanation on annualization and base
5689 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5690 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5691 #
5692 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5693 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5694 #
5695 # Decimal number.
5696 "units": "A String", # Whole units.
5697 "micros": 42, # Micro (10^-6) units.
5698 # The value must be between -999,999 and +999,999 inclusive.
5699 # If `units` is positive, `micros` must be positive or zero.
5700 # If `units` is zero, `micros` can be positive, zero, or negative.
5701 # If `units` is negative, `micros` must be negative or zero.
5702 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5703 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5704 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5705 #
5706 # Decimal number.
5707 "units": "A String", # Whole units.
5708 "micros": 42, # Micro (10^-6) units.
5709 # The value must be between -999,999 and +999,999 inclusive.
5710 # If `units` is positive, `micros` must be positive or zero.
5711 # If `units` is zero, `micros` can be positive, zero, or negative.
5712 # If `units` is negative, `micros` must be negative or zero.
5713 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5714 },
5715 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5716 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5717 #
5718 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5719 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5720 #
5721 # Decimal number.
5722 "units": "A String", # Whole units.
5723 "micros": 42, # Micro (10^-6) units.
5724 # The value must be between -999,999 and +999,999 inclusive.
5725 # If `units` is positive, `micros` must be positive or zero.
5726 # If `units` is zero, `micros` can be positive, zero, or negative.
5727 # If `units` is negative, `micros` must be negative or zero.
5728 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5729 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5730 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5731 #
5732 # Decimal number.
5733 "units": "A String", # Whole units.
5734 "micros": 42, # Micro (10^-6) units.
5735 # The value must be between -999,999 and +999,999 inclusive.
5736 # If `units` is positive, `micros` must be positive or zero.
5737 # If `units` is zero, `micros` can be positive, zero, or negative.
5738 # If `units` is negative, `micros` must be negative or zero.
5739 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5740 },
5741 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5742 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5743 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5744 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5745 # the job's base compensation entry cannot be annualized.
5746 # See CompensationEntry for explanation on annualization and base
5747 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5748 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5749 #
5750 # At most one entry can be of type
5751 # ExtendedCompensationInfo.CompensationType.BASE, which is
5752 # referred as ** base compensation entry ** for the job.
5753 { # Deprecated. See CompensationInfo.
5754 #
5755 # A compensation entry that represents one component of compensation, such
5756 # as base pay, bonus, or other compensation type.
5757 #
5758 # Annualization: One compensation entry can be annualized if
5759 # - it contains valid amount or range.
5760 # - and its expected_units_per_year is set or can be derived.
5761 # Its annualized range is determined as (amount or range) times
5762 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5763 "description": "A String", # Optional. Compensation description.
5764 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5765 #
5766 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5767 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5768 #
5769 # Decimal number.
5770 "units": "A String", # Whole units.
5771 "micros": 42, # Micro (10^-6) units.
5772 # The value must be between -999,999 and +999,999 inclusive.
5773 # If `units` is positive, `micros` must be positive or zero.
5774 # If `units` is zero, `micros` can be positive, zero, or negative.
5775 # If `units` is negative, `micros` must be negative or zero.
5776 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5777 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5778 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5779 #
5780 # Decimal number.
5781 "units": "A String", # Whole units.
5782 "micros": 42, # Micro (10^-6) units.
5783 # The value must be between -999,999 and +999,999 inclusive.
5784 # If `units` is positive, `micros` must be positive or zero.
5785 # If `units` is zero, `micros` can be positive, zero, or negative.
5786 # If `units` is negative, `micros` must be negative or zero.
5787 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5788 },
5789 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5790 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
5791 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5792 # Job.employment_types is FULLTIME, a default value is inferred
5793 # based on unit. Default values:
5794 # - HOURLY: 2080
5795 # - DAILY: 260
5796 # - WEEKLY: 52
5797 # - MONTHLY: 12
5798 # - ANNUAL: 1
5799 #
5800 # Decimal number.
5801 "units": "A String", # Whole units.
5802 "micros": 42, # Micro (10^-6) units.
5803 # The value must be between -999,999 and +999,999 inclusive.
5804 # If `units` is positive, `micros` must be positive or zero.
5805 # If `units` is zero, `micros` can be positive, zero, or negative.
5806 # If `units` is negative, `micros` must be negative or zero.
5807 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5808 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5809 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5810 #
5811 # Decimal number.
5812 "units": "A String", # Whole units.
5813 "micros": 42, # Micro (10^-6) units.
5814 # The value must be between -999,999 and +999,999 inclusive.
5815 # If `units` is positive, `micros` must be positive or zero.
5816 # If `units` is zero, `micros` can be positive, zero, or negative.
5817 # If `units` is negative, `micros` must be negative or zero.
5818 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
5819 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5820 "type": "A String", # Required. Compensation type.
5821 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5822 #
5823 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
5824 },
5825 ],
5826 },
5827 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
5828 #
5829 # Optional.
5830 #
5831 # A map of fields to hold filterable custom job attributes not captured by
5832 # the standard fields such as job_title, company_name, or
5833 # level. These custom fields store arbitrary
5834 # string values, and can be used for purposes not covered by
5835 # the structured fields. For the best search experience, use of the
5836 # structured rather than custom fields is recommended.
5837 #
5838 # Data stored in these custom fields fields are indexed and
5839 # searched against by keyword searches (see
5840 # SearchJobsRequest.custom_field_filters][]).
5841 #
5842 # The map key must be a number between 1-20. If an invalid key is
5843 # provided on job create or update, an error is returned.
5844 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5845 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5846 "A String",
5847 ],
5848 },
5849 },
5850 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
5851 #
5852 # Optional but strongly recommended to be provided for the best service
5853 # experience.
5854 #
5855 # The expiration date of the job in UTC time. After 12 am on this date, the
5856 # job is marked as expired, and it no longer appears in search results.
5857 # The expired job can't be deleted or listed by the DeleteJob and
5858 # ListJobs APIs, but it can be retrieved with the GetJob API or
5859 # updated with the UpdateJob API. An expired job can be updated and
5860 # opened again by using a future expiration date. It can also remain expired.
5861 # Updating an expired job to be open fails if there is another existing open
5862 # job with same requisition_id, company_name and language_code.
5863 #
5864 # The expired jobs are retained in our system for 90 days. However, the
5865 # overall expired job count cannot exceed 3 times the maximum of open jobs
5866 # count over the past week, otherwise jobs with earlier expire time are
5867 # removed first. Expired jobs are no longer accessible after they are cleaned
5868 # out.
5869 #
5870 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
5871 # ignored and treated as expiry date not provided.
5872 #
5873 # If this value is not provided on job creation or is invalid, the job
5874 # posting expires after 30 days from the job's creation time. For example, if
5875 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
5876 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
5877 #
5878 # If this value is not provided on job update, it depends on the field masks
5879 # set by UpdateJobRequest.update_job_fields. If the field masks include
5880 # expiry_date, or the masks are empty meaning that every field is
5881 # updated, the job expires after 30 days from the job's last update time.
5882 # Otherwise the expiration date isn't updated.
5883 # and time zone are either specified elsewhere or are not significant. The date
5884 # is relative to the Proleptic Gregorian Calendar. This can represent:
5885 #
5886 # * A full date, with non-zero year, month and day values
5887 # * A month and day value, with a zero year, e.g. an anniversary
5888 # * A year on its own, with zero month and day values
5889 # * A year and month value, with a zero day, e.g. a credit card expiration date
5890 #
5891 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
5892 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5893 # month and day.
5894 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5895 # if specifying a year by itself or a year and month where the day is not
5896 # significant.
5897 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5898 # a year.
5899 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5900 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5901 # recommended as an alternative to using the more general description
5902 # field.
5903 #
5904 # This field accepts and sanitizes HTML input, and also accepts
5905 # bold, italic, ordered list, and unordered list markup tags.
5906 #
5907 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5908 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
5909 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5910 # base compensation entry's CompensationEntry.compensation times
5911 # CompensationEntry.expected_units_per_year.
5912 #
5913 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5914 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5915 # to a maximal compensation value and the currency code is set to
5916 # match the currency code of
5917 # min_compensation.
5918 "nanos": 42, # Number of nano (10^-9) units of the amount.
5919 # The value must be between -999,999,999 and +999,999,999 inclusive.
5920 # If `units` is positive, `nanos` must be positive or zero.
5921 # If `units` is zero, `nanos` can be positive, zero, or negative.
5922 # If `units` is negative, `nanos` must be negative or zero.
5923 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5924 "units": "A String", # The whole units of the amount.
5925 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5926 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5927 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5928 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5929 # to zero and the currency code is set to match the
5930 # currency code of max_compensation.
5931 "nanos": 42, # Number of nano (10^-9) units of the amount.
5932 # The value must be between -999,999,999 and +999,999,999 inclusive.
5933 # If `units` is positive, `nanos` must be positive or zero.
5934 # If `units` is zero, `nanos` can be positive, zero, or negative.
5935 # If `units` is negative, `nanos` must be negative or zero.
5936 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5937 "units": "A String", # The whole units of the amount.
5938 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5939 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5940 },
5941 },
5942 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
5943 #
5944 # Optional.
5945 #
5946 # A lower bound on a range for compensation or pay for the job.
5947 # The currency type is specified in compensation_amount.
5948 "nanos": 42, # Number of nano (10^-9) units of the amount.
5949 # The value must be between -999,999,999 and +999,999,999 inclusive.
5950 # If `units` is positive, `nanos` must be positive or zero.
5951 # If `units` is zero, `nanos` can be positive, zero, or negative.
5952 # If `units` is negative, `nanos` must be negative or zero.
5953 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5954 "units": "A String", # The whole units of the amount.
5955 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5956 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5957 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5958 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5959 # all compensation entries' CompensationEntry.compensation times
5960 # CompensationEntry.expected_units_per_year.
5961 #
5962 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5963 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5964 # to a maximal compensation value and the currency code is set to
5965 # match the currency code of
5966 # min_compensation.
5967 "nanos": 42, # Number of nano (10^-9) units of the amount.
5968 # The value must be between -999,999,999 and +999,999,999 inclusive.
5969 # If `units` is positive, `nanos` must be positive or zero.
5970 # If `units` is zero, `nanos` can be positive, zero, or negative.
5971 # If `units` is negative, `nanos` must be negative or zero.
5972 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5973 "units": "A String", # The whole units of the amount.
5974 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5975 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5976 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5977 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5978 # to zero and the currency code is set to match the
5979 # currency code of max_compensation.
5980 "nanos": 42, # Number of nano (10^-9) units of the amount.
5981 # The value must be between -999,999,999 and +999,999,999 inclusive.
5982 # If `units` is positive, `nanos` must be positive or zero.
5983 # If `units` is zero, `nanos` can be positive, zero, or negative.
5984 # If `units` is negative, `nanos` must be negative or zero.
5985 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5986 "units": "A String", # The whole units of the amount.
5987 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5988 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5989 },
5990 },
5991 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
5992 #
5993 # Optional.
5994 #
5995 # An upper bound on a range for compensation or pay for the job.
5996 # The currency type is specified in compensation_amount.
5997 "nanos": 42, # Number of nano (10^-9) units of the amount.
5998 # The value must be between -999,999,999 and +999,999,999 inclusive.
5999 # If `units` is positive, `nanos` must be positive or zero.
6000 # If `units` is zero, `nanos` can be positive, zero, or negative.
6001 # If `units` is negative, `nanos` must be negative or zero.
6002 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6003 "units": "A String", # The whole units of the amount.
6004 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6005 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6006 },
6007 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
6008 #
6009 # Optional.
6010 #
6011 # The amount of compensation or pay for the job.
6012 # As an alternative, compensation_amount_min and
6013 # compensation_amount_max may be used to define a range of
6014 # compensation.
6015 "nanos": 42, # Number of nano (10^-9) units of the amount.
6016 # The value must be between -999,999,999 and +999,999,999 inclusive.
6017 # If `units` is positive, `nanos` must be positive or zero.
6018 # If `units` is zero, `nanos` can be positive, zero, or negative.
6019 # If `units` is negative, `nanos` must be negative or zero.
6020 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6021 "units": "A String", # The whole units of the amount.
6022 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6023 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6024 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6025 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6026 #
6027 # At most one entry can be of type
6028 # CompensationInfo.CompensationType.BASE, which is
6029 # referred as ** base compensation entry ** for the job.
6030 { # A compensation entry that represents one component of compensation, such
6031 # as base pay, bonus, or other compensation type.
6032 #
6033 # Annualization: One compensation entry can be annualized if
6034 # - it contains valid amount or range.
6035 # - and its expected_units_per_year is set or can be derived.
6036 # Its annualized range is determined as (amount or range) times
6037 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6038 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6039 # indicate equity terms or provide additional context to an estimated
6040 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6041 "range": { # Compensation range. # Optional. Compensation range.
6042 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6043 # to a maximal compensation value and the currency code is set to
6044 # match the currency code of
6045 # min_compensation.
6046 "nanos": 42, # Number of nano (10^-9) units of the amount.
6047 # The value must be between -999,999,999 and +999,999,999 inclusive.
6048 # If `units` is positive, `nanos` must be positive or zero.
6049 # If `units` is zero, `nanos` can be positive, zero, or negative.
6050 # If `units` is negative, `nanos` must be negative or zero.
6051 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6052 "units": "A String", # The whole units of the amount.
6053 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6054 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6055 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6056 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6057 # to zero and the currency code is set to match the
6058 # currency code of max_compensation.
6059 "nanos": 42, # Number of nano (10^-9) units of the amount.
6060 # The value must be between -999,999,999 and +999,999,999 inclusive.
6061 # If `units` is positive, `nanos` must be positive or zero.
6062 # If `units` is zero, `nanos` can be positive, zero, or negative.
6063 # If `units` is negative, `nanos` must be negative or zero.
6064 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6065 "units": "A String", # The whole units of the amount.
6066 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6067 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6068 },
6069 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6070 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6071 # Job.employment_types is FULLTIME, a default value is inferred
6072 # based on unit. Default values:
6073 # - HOURLY: 2080
6074 # - DAILY: 260
6075 # - WEEKLY: 52
6076 # - MONTHLY: 12
6077 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6078 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6079 "nanos": 42, # Number of nano (10^-9) units of the amount.
6080 # The value must be between -999,999,999 and +999,999,999 inclusive.
6081 # If `units` is positive, `nanos` must be positive or zero.
6082 # If `units` is zero, `nanos` can be positive, zero, or negative.
6083 # If `units` is negative, `nanos` must be negative or zero.
6084 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6085 "units": "A String", # The whole units of the amount.
6086 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6087 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6088 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6089 "type": "A String", # Required. Compensation type.
6090 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6091 #
6092 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
6093 },
6094 ],
6095 "type": "A String", # Deprecated. Use entries instead.
6096 #
6097 # Optional.
6098 #
6099 # Type of job compensation.
6100 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6101 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6102 # position.
6103 #
6104 # The maximum number of allowed characters is 255.
6105 "applicationInstruction": "A String", # Optional but at least one of application_urls,
6106 # application_email_list or application_instruction must be
6107 # specified.
6108 #
6109 # Use this field to provide instructions, such as "Mail your application
6110 # to ...", that a candidate can follow to apply for the job.
6111 #
6112 # This field accepts and sanitizes HTML input, and also accepts
6113 # bold, italic, ordered list, and unordered list markup tags.
6114 #
6115 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6116 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
6117 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6118 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6119 # The maximum number of allowed characters is 10,000.
6120 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6121 # description of the company and related information. Separate fields are
6122 # provided on the job object for responsibilities,
6123 # qualifications, and other job characteristics. Use of
6124 # these separate job fields is recommended.
6125 #
6126 # This field accepts and sanitizes HTML input, and also accepts
6127 # bold, italic, ordered list, and unordered list markup tags.
6128 #
6129 # The maximum number of allowed characters is 100,000.
6130 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
6131 # provided.
6132 #
6133 # The resource name of the company listing the job, such as
6134 # /companies/foo. This field takes precedence over the
6135 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6136 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6137 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6138 # The maximum number of allowed characters is 500.
6139 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6140 # client to identify a job. This field is intended to be used by clients
6141 # for client identification and tracking of listings. A job is not allowed
6142 # to be created if there is another job with the same requisition_id,
6143 # company_name and language_code.
6144 #
6145 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6146 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6147 # job. The use of this field is recommended
6148 # as an alternative to using the more general description field.
6149 #
6150 # This field accepts and sanitizes HTML input, and also accepts
6151 # bold, italic, ordered list, and unordered list markup tags.
6152 #
6153 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6154 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6155 # Defaults to JobVisibility.PRIVATE if not specified.
6156 # Currently only JobVisibility.PRIVATE is supported.
6157 "expireTime": "A String", # Optional but strongly recommended for the best service
6158 # experience.
6159 #
6160 # The expiration timestamp of the job. After this timestamp, the
6161 # job is marked as expired, and it no longer appears in search results. The
6162 # expired job can't be deleted or listed by the DeleteJob and
6163 # ListJobs APIs, but it can be retrieved with the GetJob API or
6164 # updated with the UpdateJob API. An expired job can be updated and
6165 # opened again by using a future expiration timestamp. Updating an expired
6166 # job fails if there is another existing open job with same
6167 # requisition_id, company_name and language_code.
6168 #
6169 # The expired jobs are retained in our system for 90 days. However, the
6170 # overall expired job count cannot exceed 3 times the maximum of open jobs
6171 # count over the past week, otherwise jobs with earlier expire time are
6172 # cleaned first. Expired jobs are no longer accessible after they are cleaned
6173 # out.
6174 # The format of this field is RFC 3339 date strings. Example:
6175 # 2000-01-01T00:00:00.999999999Z
6176 # See
6177 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
6178 #
6179 # A valid date range is between 1970-01-01T00:00:00.0Z and
6180 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
6181 # time not provided.
6182 #
6183 # If this value is not provided at the time of job creation or is invalid,
6184 # the job posting expires after 30 days from the job's creation time. For
6185 # example, if the job was created on 2017/01/01 13:00AM UTC with an
6186 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
6187 #
6188 # If this value is not provided but expiry_date is, expiry_date is
6189 # used.
6190 #
6191 # If this value is not provided on job update, it depends on the field masks
6192 # set by UpdateJobRequest.update_job_fields. If the field masks include
6193 # expiry_time, or the masks are empty meaning that every field is
6194 # updated, the job posting expires after 30 days from the job's last
6195 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6196 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6197 # value is the time the request arrives at the server.
6198 # and time zone are either specified elsewhere or are not significant. The date
6199 # is relative to the Proleptic Gregorian Calendar. This can represent:
6200 #
6201 # * A full date, with non-zero year, month and day values
6202 # * A month and day value, with a zero year, e.g. an anniversary
6203 # * A year on its own, with zero month and day values
6204 # * A year and month value, with a zero day, e.g. a credit card expiration date
6205 #
6206 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
6207 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
6208 # month and day.
6209 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
6210 # if specifying a year by itself or a year and month where the day is not
6211 # significant.
6212 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
6213 # a year.
6214 },
6215 "applicationEmailList": [ # Optional but at least one of application_urls,
6216 # application_email_list or application_instruction must be
6217 # specified.
6218 #
6219 # Use this field to specify email address(es) to which resumes or
6220 # applications can be sent.
6221 #
6222 # The maximum number of allowed characters is 255.
6223 "A String",
6224 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6225 "createTime": "A String", # Output only. The timestamp when this job was created.
6226 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6227 "A String",
6228 ],
6229 "name": "A String", # Required during job update.
6230 #
6231 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
6232 # of this field in job queries and API calls is preferred over the use of
6233 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6234 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6235 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
6236 #
6237 # Output only.
6238 #
6239 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6240 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6241 # is available. If this field is set, a
6242 # LocationFilter in a search query within the job region
6243 # finds this job if an exact location match is not specified.
6244 # If this field is set, setting job locations
6245 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6246 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6247 # The value determines the sort order of the jobs returned when searching for
6248 # jobs using the featured jobs search call, with higher promotional values
6249 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6250 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6251 #
6252 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6253 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
6254 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6255 # attributes that are not covered by the provided structured fields.
6256 #
6257 # This field is a more general combination of the deprecated id-based
6258 # filterable_custom_fields and string-based
6259 # non_filterable_custom_fields.
6260 #
6261 # The keys of the map are strings up to 64 bytes and must match the
6262 # pattern: a-zA-Z*.
6263 #
6264 # At most 100 filterable and at most 100 unfilterable keys are supported.
6265 # For filterable `string_values`, across all keys at most 200 values are
6266 # allowed, with each string no more than 255 characters. For unfilterable
6267 # `string_values`, the maximum total size of `string_values` across all keys
6268 # is 50KB.
6269 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6270 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6271 # If false, values are not searchable.
6272 #
6273 # Default is false.
6274 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
6275 # be specified.
6276 #
6277 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
6278 # `CASE_INSENSITIVE_MATCH`) search.
6279 # For filterable `string_values`, a maximum total number of 200 values
6280 # is allowed, with each `string_value` has a byte size of no more than
6281 # 255B. For unfilterable `string_values`, the maximum total byte size of
6282 # unfilterable `string_values` is 50KB.
6283 #
6284 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6285 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6286 "A String",
6287 ],
6288 },
6289 "longValue": "A String", # Optional but at least one of string_values or long_value must
6290 # be specified.
6291 #
6292 # This field is used to perform number range search.
6293 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
6294 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
6295 },
6296 },
6297 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
6298 # provided.
6299 #
6300 # A unique company identifier used by job distributors to identify an
6301 # employer's company entity. company_name takes precedence over
6302 # this field, and is the recommended field to use to identify companies.
6303 #
6304 # The maximum number of allowed characters is 255.
6305 }</pre>
6306</div>
6307
6308<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6309 <code class="details" id="search">search(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6310 <pre>Searches for jobs using the provided SearchJobsRequest.
6311
6312This call constrains the visibility of jobs
6313present in the database, and only returns jobs that the caller has
6314permission to search against.
6315
6316Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6317 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6318 The object takes the form of:
6319
6320{ # Input only.
6321 #
6322 # The Request body of the `SearchJobs` call.
6323 "orderBy": "A String", # Deprecated. Use sort_by instead.
6324 #
6325 # Optional.
6326 #
6327 # The criteria determining how search results are sorted.
6328 # Defaults to SortBy.RELEVANCE_DESC if no value is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6329 "histogramFacets": { # Input only. # Optional. Restrictions on what fields to perform histogram on, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6330 # `COMPANY_SIZE` etc.
6331 #
6332 # Histogram facets to be specified in SearchJobsRequest.
6333 "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,
6334 # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to
6335 # GetHistogramRequest.
6336 "A String",
6337 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6338 "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6339 # Duplicate values of CustomAttributeHistogramRequest.key are not
6340 # allowed.
6341 { # Custom attributes histogram request. An error will be thrown if neither
6342 # string_value_histogram or long_value_histogram_bucketing_option has
6343 # been defined.
6344 "stringValueHistogram": True or False, # Optional. If set to true, the response will include the histogram value for
6345 # each key as a string.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6346 "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6347 # filterable long custom field values, or min/max value requirements.
6348 #
6349 # Use this field to specify bucketing option for the histogram search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6350 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6351 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
6352 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
6353 # [buckets_bound is supported.
6354 3.14,
6355 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6356 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6357 # value of the numeric field.
6358 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6359 "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6360 # without `long_value_histogram_bucketing_option`, histogram on string values
6361 # of the given `key` is triggered, otherwise histogram is performed on long
6362 # values.
6363 },
6364 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6365 "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6366 # Duplicate values of CompensationHistogramRequest.type are not allowed.
6367 { # Input only.
6368 #
6369 # Compensation based histogram request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6370 "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6371 #
6372 # Use this field to specify bucketing option for the histogram search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6373 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6374 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
6375 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
6376 # [buckets_bound is supported.
6377 3.14,
6378 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6379 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6380 # value of the numeric field.
6381 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6382 "type": "A String", # Required. Type of the request, representing which field the histogramming should be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6383 # performed over. A single request can only specify one histogram of each
6384 # `CompensationHistogramRequestType`.
6385 },
6386 ],
6387 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6388 "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6389 # Broadened queries append results to the end of the matching results
6390 # list.
6391 #
6392 # Defaults to false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6393 "enablePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6394 # count of the first 300 results. Setting this to `true` ensures
6395 # consistency in the number of results per page. Best practice is to set this
6396 # value to true if a client allows users to jump directly to a
6397 # non-sequential search results page.
6398 #
6399 # Enabling this flag may adversely impact performance.
6400 #
6401 # Defaults to false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6402 "filters": { # Input only. # Deprecated. Use query instead.
6403 #
6404 # Optional.
6405 #
6406 # Restrictions on the scope of the search request, such as filtering
6407 # by location.
6408 #
6409 # Deprecated. Use JobQuery instead.
6410 #
6411 # The filters required to perform a search query or histogram.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6412 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6413 # service attempts to correct a misspelled query,
6414 # for example, "enginee" is corrected to "engineer".
6415 #
6416 # Defaults to false: a spell check is performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6417 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6418 # Job.custom_attributes that are marked as `filterable`.
6419 #
6420 # The syntax for this expression is a subset of Google SQL syntax.
6421 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6422 # Supported operators are: =, !=, &lt;, &lt;=, &gt;, &gt;= where the left of the operator
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6423 # is a custom field key and the right of the operator is a number or string
6424 # (surrounded by quotes) value.
6425 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6426 # Supported functions are LOWER(&lt;field_name&gt;) to
6427 # perform case insensitive match and EMPTY(&lt;field_name&gt;) to filter on the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6428 # existence of a key.
6429 #
6430 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
6431 # nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can
6432 # be a maximum of 100 comparisons/functions in the expression. The expression
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6433 # must be &lt; 3000 bytes in length.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6434 #
6435 # Sample Query:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6436 # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 &gt; 100
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6437 "customFieldFilters": { # Deprecated. Use custom_attribute_filter instead.
6438 #
6439 # Optional.
6440 #
6441 # This filter specifies searching against
6442 # custom field values. See Job.filterable_custom_fields for information.
6443 # The key value specifies a number between 1-20 (the service
6444 # supports 20 custom fields) corresponding to the desired custom field map
6445 # value. If an invalid key is provided or specified together with
6446 # custom_attribute_filter, an error is thrown.
6447 "a_key": { # Input only.
6448 #
6449 # Custom field filter of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6450 "type": "A String", # Optional. The type of filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6451 # Defaults to FilterType.OR.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6452 "queries": [ # Required. The query strings for the filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6453 "A String",
6454 ],
6455 },
6456 },
6457 "tenantJobOnly": True or False, # Deprecated. Do not use this field.
6458 #
6459 # This flag controls whether the job search should be restricted to jobs
6460 # owned by the current user.
6461 #
6462 # Defaults to false where all jobs accessible to the
6463 # user are searched against.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6464 "categories": [ # Optional. The category filter specifies the categories of jobs to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6465 # See Category for more information.
6466 #
6467 # If a value is not specified, jobs from any category are searched against.
6468 #
6469 # If multiple values are specified, jobs from any of the specified
6470 # categories are searched against.
6471 "A String",
6472 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6473 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6474 # search against, such as EmploymentType.FULL_TIME.
6475 #
6476 # If a value is not specified, jobs in the search results include any
6477 # employment type.
6478 #
6479 # If multiple values are specified, jobs in the search results include any
6480 # of the specified employment types.
6481 "A String",
6482 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6483 "companyTitles": [ # Optional. This filter specifies the exact company titles
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6484 # of jobs to search against.
6485 #
6486 # If a value is not specified, jobs within the search results can be
6487 # associated with any company.
6488 #
6489 # If multiple values are specified, jobs within the search results may be
6490 # associated with any of the specified companies.
6491 #
6492 # At most 20 company title filters are allowed.
6493 "A String",
6494 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6495 "query": "A String", # Optional. The query filter contains the keywords that match against the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6496 # title, description, and location fields.
6497 #
6498 # The maximum query size is 255 bytes/characters.
6499 "extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter.
6500 #
6501 # Optional.
6502 #
6503 # This search filter is applied only to
6504 # Job.extended_compensation_info. For example, if the filter is specified
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6505 # as "Hourly job with per-hour compensation &gt; $15", only jobs that meet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6506 # these criteria are searched. If a filter is not defined, all open jobs
6507 # are searched.
6508 #
6509 # Input only.
6510 #
6511 # Filter on job compensation type and amount.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6512 "includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
6513 "type": "A String", # Required. Type of filter.
6514 "compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6515 #
6516 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6517 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6518 #
6519 # Decimal number.
6520 "units": "A String", # Whole units.
6521 "micros": 42, # Micro (10^-6) units.
6522 # The value must be between -999,999 and +999,999 inclusive.
6523 # If `units` is positive, `micros` must be positive or zero.
6524 # If `units` is zero, `micros` can be positive, zero, or negative.
6525 # If `units` is negative, `micros` must be negative or zero.
6526 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
6527 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6528 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6529 #
6530 # Decimal number.
6531 "units": "A String", # Whole units.
6532 "micros": 42, # Micro (10^-6) units.
6533 # The value must be between -999,999 and +999,999 inclusive.
6534 # If `units` is positive, `micros` must be positive or zero.
6535 # If `units` is zero, `micros` can be positive, zero, or negative.
6536 # If `units` is negative, `micros` must be negative or zero.
6537 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
6538 },
6539 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6540 "compensationUnits": [ # Required. Specify desired `base compensation entry's`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6541 # ExtendedCompensationInfo.CompensationUnit.
6542 "A String",
6543 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6544 "currency": "A String", # Optional. Specify currency in 3-letter
6545 # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If
6546 # unspecified, jobs are returned regardless of currency.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6547 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6548 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6549 # driving or public transit). Note: this only works with COMMUTE
6550 # MODE. When specified, [JobFilters.location_filters] will be
6551 # ignored.
6552 #
6553 # Currently we do not support sorting by commute time.
6554 #
6555 # Parameters needed for commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6556 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6557 # integer between 0 and 23, representing the hour in the time zone of the
6558 # start_location. Must not be present if road_traffic is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6559 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6560 # Must not be present if departure_hour_local is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6561 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6562 # For city level addresses, the city center is used. For state and coarser
6563 # level addresses, text matching is used.
6564 # If this field is set to `false` or is not specified, only jobs that include
6565 # street level addresses will be returned by commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6566 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
6567 "startLocation": { # 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6568 # commute time.
6569 # of doubles representing degrees latitude and degrees longitude. Unless
6570 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6571 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
6572 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6573 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
6574 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
6575 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6576 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
6577 # (one hour). Format is `123s`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6578 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6579 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6580 # for example, "en-US".
6581 #
6582 # If a value is not specified, the search results may contain jobs in any
6583 # locale.
6584 #
6585 #
6586 # Language codes should be in BCP-47 format, for example, "en-US" or
6587 # "sr-Latn". For more information, see [Tags for Identifying
6588 # Languages](https://tools.ietf.org/html/bcp47).
6589 #
6590 # At most 10 language code filters are allowed.
6591 "A String",
6592 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6593 "companyNames": [ # Optional. The company names filter specifies the company entities to search
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6594 # against.
6595 #
6596 # If a value is not specified, jobs are searched for against all companies.
6597 #
6598 # If multiple values are specified, jobs are searched against the
6599 # specified companies.
6600 #
6601 # At most 20 company filters are allowed.
6602 "A String",
6603 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6604 "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6605 # against, for example, DateRange.PAST_MONTH. If a value is not
6606 # specified, all open jobs are searched against regardless of the
6607 # date they were published.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6608 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6609 # search against. See LocationFilter for more information.
6610 #
6611 # If a location value is not specified, jobs are retrieved
6612 # from all locations.
6613 #
6614 # If multiple values are specified, jobs are retrieved from any of the
6615 # specified locations. If different values are specified for the
6616 # LocationFilter.distance_in_miles parameter, the maximum provided
6617 # distance is used for all locations.
6618 #
6619 # At most 5 location filters are allowed.
6620 { # Input only.
6621 #
6622 # Geographic region of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6623 "isTelecommute": True or False, # Optional. Allows the client to return jobs without a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6624 # set location, specifically, telecommuting jobs (telecomuting is considered
6625 # by the service as a special location.
6626 # Job.allow_telecommute indicates if a job permits telecommuting.
6627 # If this field is true, telecommuting jobs are searched, and
6628 # name and lat_lng are
6629 # ignored.
6630 # This filter can be used by itself to search exclusively for telecommuting
6631 # jobs, or it can be combined with another location
6632 # filter to search for a combination of job locations,
6633 # such as "Mountain View" or "telecommuting" jobs. However, when used in
6634 # combination with other location filters, telecommuting jobs can be
6635 # treated as less relevant than other jobs in the search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6636 "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
6637 # search. This field is ignored if `location_name` is provided.
6638 # of doubles representing degrees latitude and degrees longitude. Unless
6639 # specified otherwise, this must conform to the
6640 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
6641 # standard&lt;/a&gt;. Values must be within normalized ranges.
6642 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
6643 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
6644 },
6645 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6646 # identified as a city or smaller. When the location being searched for is a
6647 # state or larger, this field is ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6648 "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
6649 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used
6650 # to address ambiguity of the user-input location, e.g. "Liverpool"
6651 # against "Liverpool, NY, US" or "Liverpool, UK".
6652 #
6653 # Set this field if all the jobs to search against are from a same region,
6654 # or jobs are world-wide but the job seeker is from a specific region.
6655 #
6656 # See http://cldr.unicode.org/ and
6657 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
6658 # for details. Example: "CH" for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6659 },
6660 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6661 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6662 # Job.compensation_info. For example, if the filter is specified
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6663 # as "Hourly job with per-hour compensation &gt; $15", only jobs that meet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6664 # this criteria are searched. If a filter is not defined, all open jobs
6665 # are searched.
6666 #
6667 # Filter on job compensation type and amount.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6668 "units": [ # Required. Specify desired `base compensation entry's`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6669 # CompensationInfo.CompensationUnit.
6670 "A String",
6671 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6672 "range": { # Compensation range. # Optional. Compensation range.
6673 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6674 # to a maximal compensation value and the currency code is set to
6675 # match the currency code of
6676 # min_compensation.
6677 "nanos": 42, # Number of nano (10^-9) units of the amount.
6678 # The value must be between -999,999,999 and +999,999,999 inclusive.
6679 # If `units` is positive, `nanos` must be positive or zero.
6680 # If `units` is zero, `nanos` can be positive, zero, or negative.
6681 # If `units` is negative, `nanos` must be negative or zero.
6682 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6683 "units": "A String", # The whole units of the amount.
6684 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6685 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6686 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6687 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6688 # to zero and the currency code is set to match the
6689 # currency code of max_compensation.
6690 "nanos": 42, # Number of nano (10^-9) units of the amount.
6691 # The value must be between -999,999,999 and +999,999,999 inclusive.
6692 # If `units` is positive, `nanos` must be positive or zero.
6693 # If `units` is zero, `nanos` can be positive, zero, or negative.
6694 # If `units` is negative, `nanos` must be negative or zero.
6695 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6696 "units": "A String", # The whole units of the amount.
6697 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6698 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6699 },
6700 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6701 "type": "A String", # Required. Type of filter.
6702 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6703 },
6704 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6705 "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.
6706 # Increasing this value above the default value of 10 can increase search
6707 # response time. The value can be between 1 and 100.
6708 "mode": "A String", # Required. Mode of a search.
6709 "pageToken": "A String", # Optional. The token specifying the current offset within
6710 # search results. See SearchJobsResponse.next_page_token for
6711 # an explanation of how to obtain the next set of query results.
6712 "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the
6713 # search quality of the service. The identifiers, (such as `user_id`) are
6714 # provided by users, and must be unique and consistent.
6715 #
6716 # Meta information related to the job searcher or entity
6717 # conducting the job search. This information is used to improve the
6718 # performance of the service.
6719 "deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the
6720 # service.
6721 #
6722 # Device information collected from the job seeker, candidate, or
6723 # other entity conducting the job search. Providing this information improves
6724 # the quality of the search results across devices.
6725 "deviceType": "A String", # Optional. Type of the device.
6726 "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes
6727 # the device from other devices.
6728 },
6729 "sessionId": "A String", # Required. A unique session identification string. A session is defined as the
6730 # duration of an end user's interaction with the service over a period.
6731 # Obfuscate this field for privacy concerns before
6732 # providing it to the API.
6733 #
6734 # If this field is not available for some reason, please send "UNKNOWN". Note
6735 # that any improvements to the service model for a particular tenant site,
6736 # rely on this field being set correctly to some unique session_id.
6737 "userId": "A String", # Required. A unique user identification string, as determined by the client. The
6738 # client is responsible for ensuring client-level uniqueness of this value
6739 # in order to have the strongest positive impact on search quality.
6740 # Obfuscate this field for privacy concerns before
6741 # providing it to the service.
6742 #
6743 # If this field is not available for some reason, please send "UNKNOWN". Note
6744 # that any improvements to the service model for a particular tenant site,
6745 # rely on this field being set correctly to some unique user_id.
6746 "domain": "A String", # Required. The client-defined scope or source of the service call, which typically
6747 # is the domain on
6748 # which the service has been implemented and is currently being run.
6749 #
6750 # For example, if the service is being run by client &lt;em&gt;Foo, Inc.&lt;/em&gt;, on
6751 # job board www.foo.com and career site www.bar.com, then this field is
6752 # set to "foo.com" for use on the job board, and "bar.com" for use on the
6753 # career site.
6754 #
6755 # If this field is not available for some reason, send "UNKNOWN". Note that
6756 # any improvements to the service model for a particular tenant site rely on
6757 # this field being set correctly to some domain.
6758 },
6759 "jobView": "A String", # Optional. The number of job attributes returned for jobs in the
6760 # search response. Defaults to JobView.SMALL if no value is specified.
6761 "disableRelevanceThresholding": True or False, # Optional. Controls whether to disable relevance thresholding. Relevance
6762 # thresholding removes jobs that have low relevance in search results,
6763 # for example, removing "Assistant to the CEO" positions from the search
6764 # results of a search for "CEO".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6765 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6766 # Disabling relevance thresholding improves the accuracy of subsequent
6767 # search requests.
6768 #
6769 # Defaults to false.
6770 "offset": 42, # Optional. An integer that specifies the current offset (that is, starting result
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6771 # location, amongst the jobs deemed by the API as relevant) in search
6772 # results. This field is only considered if page_token is unset.
6773 #
6774 # For example, 0 means to return results starting from the first matching
6775 # job, and 10 means to return from the 11th job. This can be used for
6776 # pagination, (for example, pageSize = 10 and offset = 10 means to return
6777 # from the second page).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6778 "query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6779 #
6780 # The query required to perform a search query or histogram.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6781 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6782 # service attempts to correct a misspelled query,
6783 # for example, "enginee" is corrected to "engineer".
6784 #
6785 # Defaults to false: a spell check is performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6786 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6787 # Job.custom_attributes marked as `filterable`.
6788 #
6789 # The syntax for this expression is a subset of Google SQL syntax.
6790 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6791 # Supported operators are: =, !=, &lt;, &lt;=, &gt;, &gt;= where the left of the operator
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6792 # is a custom field key and the right of the operator is a number or string
6793 # (surrounded by quotes) value.
6794 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6795 # Supported functions are LOWER(&lt;field_name&gt;) to
6796 # perform case insensitive match and EMPTY(&lt;field_name&gt;) to filter on the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6797 # existence of a key.
6798 #
6799 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
6800 # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50
6801 # comparisons/functions are allowed in the expression. The expression
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6802 # must be &lt; 2000 characters in length.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6803 #
6804 # Sample Query:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6805 # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 &gt; 100
6806 "companyDisplayNames": [ # Optional. This filter specifies the exact company display
6807 # name of the jobs to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6808 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6809 # If a value isn't specified, jobs within the search results are
6810 # associated with any company.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6811 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6812 # If multiple values are specified, jobs within the search results may be
6813 # associated with any of the specified companies.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6814 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6815 # At most 20 company display name filters are allowed.
6816 "A String",
6817 ],
6818 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6819 # search against, such as EmploymentType.FULL_TIME.
6820 #
6821 # If a value is not specified, jobs in the search results include any
6822 # employment type.
6823 #
6824 # If multiple values are specified, jobs in the search results include
6825 # any of the specified employment types.
6826 "A String",
6827 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6828 "query": "A String", # Optional. The query string that matches against the job title, description, and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6829 # location fields.
6830 #
6831 # The maximum query size is 255 bytes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6832 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
6833 # Job.compensation_info. For example, if the filter is specified
6834 # as "Hourly job with per-hour compensation &gt; $15", only jobs meeting
6835 # these criteria are searched. If a filter isn't defined, all open jobs
6836 # are searched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6837 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6838 # Filter on job compensation type and amount.
6839 "units": [ # Required. Specify desired `base compensation entry's`
6840 # CompensationInfo.CompensationUnit.
6841 "A String",
6842 ],
6843 "range": { # Compensation range. # Optional. Compensation range.
6844 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
6845 # to a maximal compensation value and the currency code is set to
6846 # match the currency code of
6847 # min_compensation.
6848 "nanos": 42, # Number of nano (10^-9) units of the amount.
6849 # The value must be between -999,999,999 and +999,999,999 inclusive.
6850 # If `units` is positive, `nanos` must be positive or zero.
6851 # If `units` is zero, `nanos` can be positive, zero, or negative.
6852 # If `units` is negative, `nanos` must be negative or zero.
6853 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6854 "units": "A String", # The whole units of the amount.
6855 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6856 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6857 },
6858 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
6859 # to zero and the currency code is set to match the
6860 # currency code of max_compensation.
6861 "nanos": 42, # Number of nano (10^-9) units of the amount.
6862 # The value must be between -999,999,999 and +999,999,999 inclusive.
6863 # If `units` is positive, `nanos` must be positive or zero.
6864 # If `units` is zero, `nanos` can be positive, zero, or negative.
6865 # If `units` is negative, `nanos` must be negative or zero.
6866 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6867 "units": "A String", # The whole units of the amount.
6868 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6869 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6870 },
6871 },
6872 "type": "A String", # Required. Type of filter.
6873 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
6874 },
6875 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for
6876 # example, driving or public transit). Note: This only works with COMMUTE
6877 # MODE. When specified, [JobQuery.location_filters] is
6878 # ignored.
6879 #
6880 # Currently we don't support sorting by commute time.
6881 #
6882 # Parameters needed for commute search.
6883 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
6884 # integer between 0 and 23, representing the hour in the time zone of the
6885 # start_location. Must not be present if road_traffic is specified.
6886 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
6887 # Must not be present if departure_hour_local is specified.
6888 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
6889 # For city level addresses, the city center is used. For state and coarser
6890 # level addresses, text matching is used.
6891 # If this field is set to `false` or is not specified, only jobs that include
6892 # street level addresses will be returned by commute search.
6893 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
6894 "startLocation": { # 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
6895 # commute time.
6896 # of doubles representing degrees latitude and degrees longitude. Unless
6897 # specified otherwise, this must conform to the
6898 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
6899 # standard&lt;/a&gt;. Values must be within normalized ranges.
6900 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
6901 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
6902 },
6903 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
6904 # (one hour). Format is `123s`.
6905 },
6906 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6907 # for example, "en-US".
6908 #
6909 # If a value isn't specified, the search results can contain jobs in any
6910 # locale.
6911 #
6912 #
6913 # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".
6914 # For more information, see
6915 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
6916 #
6917 # At most 10 language code filters are allowed.
6918 "A String",
6919 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6920 "companyNames": [ # Optional. This filter specifies the company entities to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6921 #
6922 # If a value isn't specified, jobs are searched for against all
6923 # companies.
6924 #
6925 # If multiple values are specified, jobs are searched against the
6926 # companies specified.
6927 #
6928 # At most 20 company filters are allowed.
6929 "A String",
6930 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6931 "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched
6932 # against, for example, DateRange.PAST_MONTH. If a value isn't
6933 # specified, all open jobs are searched against regardless of their
6934 # published date.
6935 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6936 # search against. See LocationFilter for more information.
6937 #
6938 # If a location value isn't specified, jobs fitting the other search
6939 # criteria are retrieved regardless of where they're located.
6940 #
6941 # If multiple values are specified, jobs are retrieved from any of the
6942 # specified locations. If different values are specified for the
6943 # LocationFilter.distance_in_miles parameter, the maximum provided
6944 # distance is used for all locations.
6945 #
6946 # At most 5 location filters are allowed.
6947 { # Input only.
6948 #
6949 # Geographic region of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6950 "isTelecommute": True or False, # Optional. Allows the client to return jobs without a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6951 # set location, specifically, telecommuting jobs (telecomuting is considered
6952 # by the service as a special location.
6953 # Job.allow_telecommute indicates if a job permits telecommuting.
6954 # If this field is true, telecommuting jobs are searched, and
6955 # name and lat_lng are
6956 # ignored.
6957 # This filter can be used by itself to search exclusively for telecommuting
6958 # jobs, or it can be combined with another location
6959 # filter to search for a combination of job locations,
6960 # such as "Mountain View" or "telecommuting" jobs. However, when used in
6961 # combination with other location filters, telecommuting jobs can be
6962 # treated as less relevant than other jobs in the search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6963 "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
6964 # search. This field is ignored if `location_name` is provided.
6965 # of doubles representing degrees latitude and degrees longitude. Unless
6966 # specified otherwise, this must conform to the
6967 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
6968 # standard&lt;/a&gt;. Values must be within normalized ranges.
6969 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
6970 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
6971 },
6972 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6973 # identified as a city or smaller. When the location being searched for is a
6974 # state or larger, this field is ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6975 "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
6976 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used
6977 # to address ambiguity of the user-input location, e.g. "Liverpool"
6978 # against "Liverpool, NY, US" or "Liverpool, UK".
6979 #
6980 # Set this field if all the jobs to search against are from a same region,
6981 # or jobs are world-wide but the job seeker is from a specific region.
6982 #
6983 # See http://cldr.unicode.org/ and
6984 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
6985 # for details. Example: "CH" for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6986 },
6987 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6988 "categories": [ # Optional. The category filter specifies the categories of jobs to search against.
6989 # See Category for more information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6990 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6991 # If a value is not specified, jobs from any category are searched against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6992 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6993 # If multiple values are specified, jobs from any of the specified
6994 # categories are searched against.
6995 "A String",
6996 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6997 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6998 "sortBy": "A String", # Optional. The criteria determining how search results are sorted.
6999 # Defaults to SortBy.RELEVANCE_DESC if no value is specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7000 }
7001
7002 x__xgafv: string, V1 error format.
7003 Allowed values
7004 1 - v1 error format
7005 2 - v2 error format
7006
7007Returns:
7008 An object of the form:
7009
7010 { # Output only.
7011 #
7012 # Response for SearchJob method.
7013 "nextPageToken": "A String", # The token that specifies the starting position of the next page of results.
7014 # This field is empty if there are no more results.
7015 "estimatedTotalSize": "A String", # An estimation of the number of jobs that match the specified query.
7016 #
7017 # This number is not guaranteed to be accurate. For accurate results,
7018 # seenenable_precise_result_size.
7019 "totalSize": "A String", # The precise result count, which is available only if the client set
7020 # enable_precise_result_size to `true` or if the response
7021 # is the last page of results. Otherwise, the value will be `-1`.
7022 "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.
7023 { # Output only.
7024 #
7025 # Job entry with metadata inside SearchJobsResponse.
7026 "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar
7027 # fields that most closely match a search query's keywords, if available.
7028 # All HTML tags in the original fields are stripped when returned in this
7029 # field, and matching query keywords are enclosed in HTML bold tags.
7030 "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.
7031 # or "job requisition"). A job belongs to a Company, which is the hiring
7032 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7033 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7034 # any requirements for fluency that are associated with the job.
7035 #
7036 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
7037 # For more information, see
7038 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
7039 # class="external" target="_blank" }.
7040 #
7041 # If this field is unspecified and Job.description is present, detected
7042 # language code based on Job.description is assigned, otherwise
7043 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7044 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7045 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
7046 #
7047 # Optional.
7048 #
7049 # A map of fields to hold non-filterable custom job attributes, similar to
7050 # filterable_custom_fields. These fields are distinct in that the data
7051 # in these fields are not indexed. Therefore, the client cannot search
7052 # against them, nor can the client use them to list jobs.
7053 #
7054 # The key of the map can be any valid string.
7055 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7056 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7057 "A String",
7058 ],
7059 },
7060 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7061 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7062 # is used for contracting engagements.
7063 # Dates prior to 1970/1/1 and invalid date formats are ignored.
7064 # and time zone are either specified elsewhere or are not significant. The date
7065 # is relative to the Proleptic Gregorian Calendar. This can represent:
7066 #
7067 # * A full date, with non-zero year, month and day values
7068 # * A month and day value, with a zero year, e.g. an anniversary
7069 # * A year on its own, with zero month and day values
7070 # * A year and month value, with a zero day, e.g. a credit card expiration date
7071 #
7072 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
7073 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7074 # month and day.
7075 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7076 # if specifying a year by itself or a year and month where the day is not
7077 # significant.
7078 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7079 # a year.
7080 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7081 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
7082 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7083 # is used for contracting engagements.
7084 # Dates prior to 1970/1/1 and invalid date formats are ignored.
7085 # and time zone are either specified elsewhere or are not significant. The date
7086 # is relative to the Proleptic Gregorian Calendar. This can represent:
7087 #
7088 # * A full date, with non-zero year, month and day values
7089 # * A month and day value, with a zero year, e.g. an anniversary
7090 # * A year on its own, with zero month and day values
7091 # * A year and month value, with a zero day, e.g. a credit card expiration date
7092 #
7093 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
7094 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7095 # month and day.
7096 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7097 # if specifying a year by itself or a year and month where the day is not
7098 # significant.
7099 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7100 # a year.
7101 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7102 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7103 { # Output only.
7104 #
7105 # A resource that represents a location with full geographic
7106 # information.
7107 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
7108 # location bounding box in which a circle with the specified radius
7109 # centered from LatLng coves the area associated with the job location.
7110 # For example, currently, "Mountain View, CA, USA" has a radius of
7111 # 7885.79 meters.
7112 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
7113 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
7114 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
7115 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7116 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
7117 # of doubles representing degrees latitude and degrees longitude. Unless
7118 # specified otherwise, this must conform to the
7119 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
7120 # standard&lt;/a&gt;. Values must be within normalized ranges.
7121 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
7122 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
7123 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7124 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
7125 # such as postal delivery and payments addresses. Given a postal address,
7126 # a postal service can deliver items to a premises, P.O. Box, or other
7127 # delivery location.
7128 # Given a postal address, a postal service can deliver items to a premise, P.O.
7129 # Box or similar.
7130 # It is not intended to model geographical locations (roads, towns,
7131 # mountains).
7132 #
7133 # In typical usage an address would be created via user input or from importing
7134 # existing data, depending on the type of process.
7135 #
7136 # Advice on address input / editing:
7137 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7138 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7139 # - Users should not be presented with UI elements for input or editing of
7140 # fields outside countries where that field is used.
7141 #
7142 # For more guidance on how to use this schema, please see:
7143 # https://support.google.com/business/answer/6397478
7144 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
7145 # known). This is often the UI language of the input form or is expected
7146 # to match one of the languages used in the address' country/region, or their
7147 # transliterated equivalents.
7148 # This can affect formatting in certain countries, but is not critical
7149 # to the correctness of the data and will never affect any validation or
7150 # other non-formatting related operations.
7151 #
7152 # If this value is not known, it should be omitted (rather than specifying a
7153 # possibly incorrect default).
7154 #
7155 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
7156 "recipients": [ # Optional. The recipient at the address.
7157 # This field may, under certain circumstances, contain multiline information.
7158 # For example, it might contain "care of" information.
7159 "A String",
7160 ],
7161 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
7162 # Examples: US city, IT comune, UK post town.
7163 # In regions of the world where localities are not well defined or do not fit
7164 # into this structure well, leave locality empty and use address_lines.
7165 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
7166 # in most regions. Where it is used, the value is either a string like
7167 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
7168 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
7169 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
7170 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
7171 # is never inferred and it is up to the user to ensure the value is
7172 # correct. See http://cldr.unicode.org/ and
7173 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
7174 # for details. Example: "CH" for Switzerland.
7175 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
7176 # addresses of a country or region.
7177 # For example, this can be a state, a province, an oblast, or a prefecture.
7178 # Specifically, for Spain this is the province and not the autonomous
7179 # community (e.g. "Barcelona" and not "Catalonia").
7180 # Many countries don't use an administrative area in postal addresses. E.g.
7181 # in Switzerland this should be left unpopulated.
7182 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
7183 #
7184 # Because values in address_lines do not have type information and may
7185 # sometimes contain multiple values in a single field (e.g.
7186 # "Austin, TX"), it is important that the line order is clear. The order of
7187 # address lines should be "envelope order" for the country/region of the
7188 # address. In places where this can vary (e.g. Japan), address_language is
7189 # used to make it explicit (e.g. "ja" for large-to-small ordering and
7190 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
7191 # an address can be selected based on the language.
7192 #
7193 # The minimum permitted structural representation of an address consists
7194 # of a region_code with all remaining information placed in the
7195 # address_lines. It would be possible to format such an address very
7196 # approximately without geocoding, but no semantic reasoning could be
7197 # made about any of the address components until it was at least
7198 # partially resolved.
7199 #
7200 # Creating an address only containing a region_code and address_lines, and
7201 # then geocoding is the recommended way to handle completely unstructured
7202 # addresses (as opposed to guessing which parts of the address should be
7203 # localities or administrative areas).
7204 "A String",
7205 ],
7206 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
7207 # postal codes to be present, but where they are used, they may trigger
7208 # additional validation with other parts of the address (e.g. state/zip
7209 # validation in the U.S.A.).
7210 "organization": "A String", # Optional. The name of the organization at the address.
7211 "sublocality": "A String", # Optional. Sublocality of the address.
7212 # For example, this can be neighborhoods, boroughs, districts.
7213 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
7214 # the latest revision.
7215 #
7216 # All new revisions **must** be backward compatible with old revisions.
7217 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7218 },
7219 ],
7220 "locations": [ # Optional but strongly recommended for the best service experience.
7221 #
7222 # Location(s) where the emploeyer is looking to hire for this job posting.
7223 #
7224 # Specifying the full street address(es) of the hiring location enables
7225 # better API results, especially job searches by commute time.
7226 #
7227 # At most 50 locations are allowed for best search performance. If a job has
7228 # more locations, it is suggested to split it into multiple jobs with unique
7229 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
7230 # multiple jobs with the same requisition_id, company_name and
7231 # language_code are not allowed. If the original requisition_id must
7232 # be preserved, a custom field should be used for storage. It is also
7233 # suggested to group the locations that close to each other in the same job
7234 # for better search experience.
7235 #
7236 # The maximum number of allowed characters is 500.
7237 "A String",
7238 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7239 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7240 # full time or
7241 # part time.
7242 "A String",
7243 ],
7244 "applicationUrls": [ # Optional but at least one of application_urls,
7245 # application_email_list or application_instruction must be
7246 # specified.
7247 #
7248 # Use this URL field to direct an applicant to a website, for example to
7249 # link to an online application form.
7250 #
7251 # The maximum number of allowed characters is 2,000.
7252 "A String",
7253 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7254 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7255 # "Bachelors", "Masters", "Doctorate".
7256 "A String",
7257 ],
7258 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
7259 #
7260 # Optional.
7261 #
7262 # Job compensation information.
7263 #
7264 # This field replaces compensation_info. Only
7265 # CompensationInfo.entries or extended_compensation_info can be set,
7266 # otherwise an exception is thrown.
7267 #
7268 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7269 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7270 # the job's all CompensationEntry cannot be annualized.
7271 # See CompensationEntry for explanation on annualization and base
7272 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7273 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7274 #
7275 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7276 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7277 #
7278 # Decimal number.
7279 "units": "A String", # Whole units.
7280 "micros": 42, # Micro (10^-6) units.
7281 # The value must be between -999,999 and +999,999 inclusive.
7282 # If `units` is positive, `micros` must be positive or zero.
7283 # If `units` is zero, `micros` can be positive, zero, or negative.
7284 # If `units` is negative, `micros` must be negative or zero.
7285 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7286 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7287 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7288 #
7289 # Decimal number.
7290 "units": "A String", # Whole units.
7291 "micros": 42, # Micro (10^-6) units.
7292 # The value must be between -999,999 and +999,999 inclusive.
7293 # If `units` is positive, `micros` must be positive or zero.
7294 # If `units` is zero, `micros` can be positive, zero, or negative.
7295 # If `units` is negative, `micros` must be negative or zero.
7296 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7297 },
7298 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7299 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7300 #
7301 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7302 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7303 #
7304 # Decimal number.
7305 "units": "A String", # Whole units.
7306 "micros": 42, # Micro (10^-6) units.
7307 # The value must be between -999,999 and +999,999 inclusive.
7308 # If `units` is positive, `micros` must be positive or zero.
7309 # If `units` is zero, `micros` can be positive, zero, or negative.
7310 # If `units` is negative, `micros` must be negative or zero.
7311 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7312 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7313 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7314 #
7315 # Decimal number.
7316 "units": "A String", # Whole units.
7317 "micros": 42, # Micro (10^-6) units.
7318 # The value must be between -999,999 and +999,999 inclusive.
7319 # If `units` is positive, `micros` must be positive or zero.
7320 # If `units` is zero, `micros` can be positive, zero, or negative.
7321 # If `units` is negative, `micros` must be negative or zero.
7322 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7323 },
7324 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7325 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7326 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7327 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7328 # the job's base compensation entry cannot be annualized.
7329 # See CompensationEntry for explanation on annualization and base
7330 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7331 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7332 #
7333 # At most one entry can be of type
7334 # ExtendedCompensationInfo.CompensationType.BASE, which is
7335 # referred as ** base compensation entry ** for the job.
7336 { # Deprecated. See CompensationInfo.
7337 #
7338 # A compensation entry that represents one component of compensation, such
7339 # as base pay, bonus, or other compensation type.
7340 #
7341 # Annualization: One compensation entry can be annualized if
7342 # - it contains valid amount or range.
7343 # - and its expected_units_per_year is set or can be derived.
7344 # Its annualized range is determined as (amount or range) times
7345 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7346 "description": "A String", # Optional. Compensation description.
7347 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7348 #
7349 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7350 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7351 #
7352 # Decimal number.
7353 "units": "A String", # Whole units.
7354 "micros": 42, # Micro (10^-6) units.
7355 # The value must be between -999,999 and +999,999 inclusive.
7356 # If `units` is positive, `micros` must be positive or zero.
7357 # If `units` is zero, `micros` can be positive, zero, or negative.
7358 # If `units` is negative, `micros` must be negative or zero.
7359 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7360 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7361 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7362 #
7363 # Decimal number.
7364 "units": "A String", # Whole units.
7365 "micros": 42, # Micro (10^-6) units.
7366 # The value must be between -999,999 and +999,999 inclusive.
7367 # If `units` is positive, `micros` must be positive or zero.
7368 # If `units` is zero, `micros` can be positive, zero, or negative.
7369 # If `units` is negative, `micros` must be negative or zero.
7370 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7371 },
7372 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7373 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
7374 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7375 # Job.employment_types is FULLTIME, a default value is inferred
7376 # based on unit. Default values:
7377 # - HOURLY: 2080
7378 # - DAILY: 260
7379 # - WEEKLY: 52
7380 # - MONTHLY: 12
7381 # - ANNUAL: 1
7382 #
7383 # Decimal number.
7384 "units": "A String", # Whole units.
7385 "micros": 42, # Micro (10^-6) units.
7386 # The value must be between -999,999 and +999,999 inclusive.
7387 # If `units` is positive, `micros` must be positive or zero.
7388 # If `units` is zero, `micros` can be positive, zero, or negative.
7389 # If `units` is negative, `micros` must be negative or zero.
7390 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7391 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7392 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7393 #
7394 # Decimal number.
7395 "units": "A String", # Whole units.
7396 "micros": 42, # Micro (10^-6) units.
7397 # The value must be between -999,999 and +999,999 inclusive.
7398 # If `units` is positive, `micros` must be positive or zero.
7399 # If `units` is zero, `micros` can be positive, zero, or negative.
7400 # If `units` is negative, `micros` must be negative or zero.
7401 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
7402 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7403 "type": "A String", # Required. Compensation type.
7404 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7405 #
7406 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
7407 },
7408 ],
7409 },
7410 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
7411 #
7412 # Optional.
7413 #
7414 # A map of fields to hold filterable custom job attributes not captured by
7415 # the standard fields such as job_title, company_name, or
7416 # level. These custom fields store arbitrary
7417 # string values, and can be used for purposes not covered by
7418 # the structured fields. For the best search experience, use of the
7419 # structured rather than custom fields is recommended.
7420 #
7421 # Data stored in these custom fields fields are indexed and
7422 # searched against by keyword searches (see
7423 # SearchJobsRequest.custom_field_filters][]).
7424 #
7425 # The map key must be a number between 1-20. If an invalid key is
7426 # provided on job create or update, an error is returned.
7427 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7428 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7429 "A String",
7430 ],
7431 },
7432 },
7433 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
7434 #
7435 # Optional but strongly recommended to be provided for the best service
7436 # experience.
7437 #
7438 # The expiration date of the job in UTC time. After 12 am on this date, the
7439 # job is marked as expired, and it no longer appears in search results.
7440 # The expired job can't be deleted or listed by the DeleteJob and
7441 # ListJobs APIs, but it can be retrieved with the GetJob API or
7442 # updated with the UpdateJob API. An expired job can be updated and
7443 # opened again by using a future expiration date. It can also remain expired.
7444 # Updating an expired job to be open fails if there is another existing open
7445 # job with same requisition_id, company_name and language_code.
7446 #
7447 # The expired jobs are retained in our system for 90 days. However, the
7448 # overall expired job count cannot exceed 3 times the maximum of open jobs
7449 # count over the past week, otherwise jobs with earlier expire time are
7450 # removed first. Expired jobs are no longer accessible after they are cleaned
7451 # out.
7452 #
7453 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
7454 # ignored and treated as expiry date not provided.
7455 #
7456 # If this value is not provided on job creation or is invalid, the job
7457 # posting expires after 30 days from the job's creation time. For example, if
7458 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
7459 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
7460 #
7461 # If this value is not provided on job update, it depends on the field masks
7462 # set by UpdateJobRequest.update_job_fields. If the field masks include
7463 # expiry_date, or the masks are empty meaning that every field is
7464 # updated, the job expires after 30 days from the job's last update time.
7465 # Otherwise the expiration date isn't updated.
7466 # and time zone are either specified elsewhere or are not significant. The date
7467 # is relative to the Proleptic Gregorian Calendar. This can represent:
7468 #
7469 # * A full date, with non-zero year, month and day values
7470 # * A month and day value, with a zero year, e.g. an anniversary
7471 # * A year on its own, with zero month and day values
7472 # * A year and month value, with a zero day, e.g. a credit card expiration date
7473 #
7474 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
7475 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7476 # month and day.
7477 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7478 # if specifying a year by itself or a year and month where the day is not
7479 # significant.
7480 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7481 # a year.
7482 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7483 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7484 # recommended as an alternative to using the more general description
7485 # field.
7486 #
7487 # This field accepts and sanitizes HTML input, and also accepts
7488 # bold, italic, ordered list, and unordered list markup tags.
7489 #
7490 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7491 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
7492 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7493 # base compensation entry's CompensationEntry.compensation times
7494 # CompensationEntry.expected_units_per_year.
7495 #
7496 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7497 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7498 # to a maximal compensation value and the currency code is set to
7499 # match the currency code of
7500 # min_compensation.
7501 "nanos": 42, # Number of nano (10^-9) units of the amount.
7502 # The value must be between -999,999,999 and +999,999,999 inclusive.
7503 # If `units` is positive, `nanos` must be positive or zero.
7504 # If `units` is zero, `nanos` can be positive, zero, or negative.
7505 # If `units` is negative, `nanos` must be negative or zero.
7506 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7507 "units": "A String", # The whole units of the amount.
7508 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7509 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7510 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7511 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7512 # to zero and the currency code is set to match the
7513 # currency code of max_compensation.
7514 "nanos": 42, # Number of nano (10^-9) units of the amount.
7515 # The value must be between -999,999,999 and +999,999,999 inclusive.
7516 # If `units` is positive, `nanos` must be positive or zero.
7517 # If `units` is zero, `nanos` can be positive, zero, or negative.
7518 # If `units` is negative, `nanos` must be negative or zero.
7519 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7520 "units": "A String", # The whole units of the amount.
7521 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7522 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7523 },
7524 },
7525 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
7526 #
7527 # Optional.
7528 #
7529 # A lower bound on a range for compensation or pay for the job.
7530 # The currency type is specified in compensation_amount.
7531 "nanos": 42, # Number of nano (10^-9) units of the amount.
7532 # The value must be between -999,999,999 and +999,999,999 inclusive.
7533 # If `units` is positive, `nanos` must be positive or zero.
7534 # If `units` is zero, `nanos` can be positive, zero, or negative.
7535 # If `units` is negative, `nanos` must be negative or zero.
7536 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7537 "units": "A String", # The whole units of the amount.
7538 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7539 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7540 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7541 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7542 # all compensation entries' CompensationEntry.compensation times
7543 # CompensationEntry.expected_units_per_year.
7544 #
7545 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7546 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7547 # to a maximal compensation value and the currency code is set to
7548 # match the currency code of
7549 # min_compensation.
7550 "nanos": 42, # Number of nano (10^-9) units of the amount.
7551 # The value must be between -999,999,999 and +999,999,999 inclusive.
7552 # If `units` is positive, `nanos` must be positive or zero.
7553 # If `units` is zero, `nanos` can be positive, zero, or negative.
7554 # If `units` is negative, `nanos` must be negative or zero.
7555 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7556 "units": "A String", # The whole units of the amount.
7557 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7558 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7559 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7560 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7561 # to zero and the currency code is set to match the
7562 # currency code of max_compensation.
7563 "nanos": 42, # Number of nano (10^-9) units of the amount.
7564 # The value must be between -999,999,999 and +999,999,999 inclusive.
7565 # If `units` is positive, `nanos` must be positive or zero.
7566 # If `units` is zero, `nanos` can be positive, zero, or negative.
7567 # If `units` is negative, `nanos` must be negative or zero.
7568 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7569 "units": "A String", # The whole units of the amount.
7570 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7571 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7572 },
7573 },
7574 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
7575 #
7576 # Optional.
7577 #
7578 # An upper bound on a range for compensation or pay for the job.
7579 # The currency type is specified in compensation_amount.
7580 "nanos": 42, # Number of nano (10^-9) units of the amount.
7581 # The value must be between -999,999,999 and +999,999,999 inclusive.
7582 # If `units` is positive, `nanos` must be positive or zero.
7583 # If `units` is zero, `nanos` can be positive, zero, or negative.
7584 # If `units` is negative, `nanos` must be negative or zero.
7585 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7586 "units": "A String", # The whole units of the amount.
7587 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7588 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7589 },
7590 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
7591 #
7592 # Optional.
7593 #
7594 # The amount of compensation or pay for the job.
7595 # As an alternative, compensation_amount_min and
7596 # compensation_amount_max may be used to define a range of
7597 # compensation.
7598 "nanos": 42, # Number of nano (10^-9) units of the amount.
7599 # The value must be between -999,999,999 and +999,999,999 inclusive.
7600 # If `units` is positive, `nanos` must be positive or zero.
7601 # If `units` is zero, `nanos` can be positive, zero, or negative.
7602 # If `units` is negative, `nanos` must be negative or zero.
7603 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7604 "units": "A String", # The whole units of the amount.
7605 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7606 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7607 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7608 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7609 #
7610 # At most one entry can be of type
7611 # CompensationInfo.CompensationType.BASE, which is
7612 # referred as ** base compensation entry ** for the job.
7613 { # A compensation entry that represents one component of compensation, such
7614 # as base pay, bonus, or other compensation type.
7615 #
7616 # Annualization: One compensation entry can be annualized if
7617 # - it contains valid amount or range.
7618 # - and its expected_units_per_year is set or can be derived.
7619 # Its annualized range is determined as (amount or range) times
7620 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7621 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7622 # indicate equity terms or provide additional context to an estimated
7623 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7624 "range": { # Compensation range. # Optional. Compensation range.
7625 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7626 # to a maximal compensation value and the currency code is set to
7627 # match the currency code of
7628 # min_compensation.
7629 "nanos": 42, # Number of nano (10^-9) units of the amount.
7630 # The value must be between -999,999,999 and +999,999,999 inclusive.
7631 # If `units` is positive, `nanos` must be positive or zero.
7632 # If `units` is zero, `nanos` can be positive, zero, or negative.
7633 # If `units` is negative, `nanos` must be negative or zero.
7634 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7635 "units": "A String", # The whole units of the amount.
7636 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7637 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7638 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7639 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7640 # to zero and the currency code is set to match the
7641 # currency code of max_compensation.
7642 "nanos": 42, # Number of nano (10^-9) units of the amount.
7643 # The value must be between -999,999,999 and +999,999,999 inclusive.
7644 # If `units` is positive, `nanos` must be positive or zero.
7645 # If `units` is zero, `nanos` can be positive, zero, or negative.
7646 # If `units` is negative, `nanos` must be negative or zero.
7647 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7648 "units": "A String", # The whole units of the amount.
7649 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7650 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7651 },
7652 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7653 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7654 # Job.employment_types is FULLTIME, a default value is inferred
7655 # based on unit. Default values:
7656 # - HOURLY: 2080
7657 # - DAILY: 260
7658 # - WEEKLY: 52
7659 # - MONTHLY: 12
7660 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7661 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7662 "nanos": 42, # Number of nano (10^-9) units of the amount.
7663 # The value must be between -999,999,999 and +999,999,999 inclusive.
7664 # If `units` is positive, `nanos` must be positive or zero.
7665 # If `units` is zero, `nanos` can be positive, zero, or negative.
7666 # If `units` is negative, `nanos` must be negative or zero.
7667 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
7668 "units": "A String", # The whole units of the amount.
7669 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
7670 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
7671 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7672 "type": "A String", # Required. Compensation type.
7673 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7674 #
7675 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
7676 },
7677 ],
7678 "type": "A String", # Deprecated. Use entries instead.
7679 #
7680 # Optional.
7681 #
7682 # Type of job compensation.
7683 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7684 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7685 # position.
7686 #
7687 # The maximum number of allowed characters is 255.
7688 "applicationInstruction": "A String", # Optional but at least one of application_urls,
7689 # application_email_list or application_instruction must be
7690 # specified.
7691 #
7692 # Use this field to provide instructions, such as "Mail your application
7693 # to ...", that a candidate can follow to apply for the job.
7694 #
7695 # This field accepts and sanitizes HTML input, and also accepts
7696 # bold, italic, ordered list, and unordered list markup tags.
7697 #
7698 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7699 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
7700 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7701 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7702 # The maximum number of allowed characters is 10,000.
7703 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7704 # description of the company and related information. Separate fields are
7705 # provided on the job object for responsibilities,
7706 # qualifications, and other job characteristics. Use of
7707 # these separate job fields is recommended.
7708 #
7709 # This field accepts and sanitizes HTML input, and also accepts
7710 # bold, italic, ordered list, and unordered list markup tags.
7711 #
7712 # The maximum number of allowed characters is 100,000.
7713 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
7714 # provided.
7715 #
7716 # The resource name of the company listing the job, such as
7717 # /companies/foo. This field takes precedence over the
7718 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7719 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7720 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7721 # The maximum number of allowed characters is 500.
7722 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7723 # client to identify a job. This field is intended to be used by clients
7724 # for client identification and tracking of listings. A job is not allowed
7725 # to be created if there is another job with the same requisition_id,
7726 # company_name and language_code.
7727 #
7728 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7729 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7730 # job. The use of this field is recommended
7731 # as an alternative to using the more general description field.
7732 #
7733 # This field accepts and sanitizes HTML input, and also accepts
7734 # bold, italic, ordered list, and unordered list markup tags.
7735 #
7736 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7737 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7738 # Defaults to JobVisibility.PRIVATE if not specified.
7739 # Currently only JobVisibility.PRIVATE is supported.
7740 "expireTime": "A String", # Optional but strongly recommended for the best service
7741 # experience.
7742 #
7743 # The expiration timestamp of the job. After this timestamp, the
7744 # job is marked as expired, and it no longer appears in search results. The
7745 # expired job can't be deleted or listed by the DeleteJob and
7746 # ListJobs APIs, but it can be retrieved with the GetJob API or
7747 # updated with the UpdateJob API. An expired job can be updated and
7748 # opened again by using a future expiration timestamp. Updating an expired
7749 # job fails if there is another existing open job with same
7750 # requisition_id, company_name and language_code.
7751 #
7752 # The expired jobs are retained in our system for 90 days. However, the
7753 # overall expired job count cannot exceed 3 times the maximum of open jobs
7754 # count over the past week, otherwise jobs with earlier expire time are
7755 # cleaned first. Expired jobs are no longer accessible after they are cleaned
7756 # out.
7757 # The format of this field is RFC 3339 date strings. Example:
7758 # 2000-01-01T00:00:00.999999999Z
7759 # See
7760 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
7761 #
7762 # A valid date range is between 1970-01-01T00:00:00.0Z and
7763 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
7764 # time not provided.
7765 #
7766 # If this value is not provided at the time of job creation or is invalid,
7767 # the job posting expires after 30 days from the job's creation time. For
7768 # example, if the job was created on 2017/01/01 13:00AM UTC with an
7769 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
7770 #
7771 # If this value is not provided but expiry_date is, expiry_date is
7772 # used.
7773 #
7774 # If this value is not provided on job update, it depends on the field masks
7775 # set by UpdateJobRequest.update_job_fields. If the field masks include
7776 # expiry_time, or the masks are empty meaning that every field is
7777 # updated, the job posting expires after 30 days from the job's last
7778 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7779 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7780 # value is the time the request arrives at the server.
7781 # and time zone are either specified elsewhere or are not significant. The date
7782 # is relative to the Proleptic Gregorian Calendar. This can represent:
7783 #
7784 # * A full date, with non-zero year, month and day values
7785 # * A month and day value, with a zero year, e.g. an anniversary
7786 # * A year on its own, with zero month and day values
7787 # * A year and month value, with a zero day, e.g. a credit card expiration date
7788 #
7789 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
7790 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7791 # month and day.
7792 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7793 # if specifying a year by itself or a year and month where the day is not
7794 # significant.
7795 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7796 # a year.
7797 },
7798 "applicationEmailList": [ # Optional but at least one of application_urls,
7799 # application_email_list or application_instruction must be
7800 # specified.
7801 #
7802 # Use this field to specify email address(es) to which resumes or
7803 # applications can be sent.
7804 #
7805 # The maximum number of allowed characters is 255.
7806 "A String",
7807 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7808 "createTime": "A String", # Output only. The timestamp when this job was created.
7809 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7810 "A String",
7811 ],
7812 "name": "A String", # Required during job update.
7813 #
7814 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
7815 # of this field in job queries and API calls is preferred over the use of
7816 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7817 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7818 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
7819 #
7820 # Output only.
7821 #
7822 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7823 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7824 # is available. If this field is set, a
7825 # LocationFilter in a search query within the job region
7826 # finds this job if an exact location match is not specified.
7827 # If this field is set, setting job locations
7828 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7829 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7830 # The value determines the sort order of the jobs returned when searching for
7831 # jobs using the featured jobs search call, with higher promotional values
7832 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7833 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7834 #
7835 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7836 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
7837 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7838 # attributes that are not covered by the provided structured fields.
7839 #
7840 # This field is a more general combination of the deprecated id-based
7841 # filterable_custom_fields and string-based
7842 # non_filterable_custom_fields.
7843 #
7844 # The keys of the map are strings up to 64 bytes and must match the
7845 # pattern: a-zA-Z*.
7846 #
7847 # At most 100 filterable and at most 100 unfilterable keys are supported.
7848 # For filterable `string_values`, across all keys at most 200 values are
7849 # allowed, with each string no more than 255 characters. For unfilterable
7850 # `string_values`, the maximum total size of `string_values` across all keys
7851 # is 50KB.
7852 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7853 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7854 # If false, values are not searchable.
7855 #
7856 # Default is false.
7857 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
7858 # be specified.
7859 #
7860 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
7861 # `CASE_INSENSITIVE_MATCH`) search.
7862 # For filterable `string_values`, a maximum total number of 200 values
7863 # is allowed, with each `string_value` has a byte size of no more than
7864 # 255B. For unfilterable `string_values`, the maximum total byte size of
7865 # unfilterable `string_values` is 50KB.
7866 #
7867 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7868 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7869 "A String",
7870 ],
7871 },
7872 "longValue": "A String", # Optional but at least one of string_values or long_value must
7873 # be specified.
7874 #
7875 # This field is used to perform number range search.
7876 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
7877 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
7878 },
7879 },
7880 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
7881 # provided.
7882 #
7883 # A unique company identifier used by job distributors to identify an
7884 # employer's company entity. company_name takes precedence over
7885 # this field, and is the recommended field to use to identify companies.
7886 #
7887 # The maximum number of allowed characters is 255.
7888 },
7889 "commuteInfo": { # Output only. # Commute information which is generated based on specified
7890 # CommutePreference.
7891 #
7892 # Commute details related to this job.
7893 "travelDuration": "A String", # The number of seconds required to travel to the job location from the query
7894 # location. A duration of 0 seconds indicates that the job is not
7895 # reachable within the requested duration, but was returned as part of an
7896 # expanded query.
7897 "jobLocation": { # Output only. # Location used as the destination in the commute calculation.
7898 #
7899 # A resource that represents a location with full geographic
7900 # information.
7901 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
7902 # location bounding box in which a circle with the specified radius
7903 # centered from LatLng coves the area associated with the job location.
7904 # For example, currently, "Mountain View, CA, USA" has a radius of
7905 # 7885.79 meters.
7906 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
7907 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
7908 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
7909 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7910 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
7911 # of doubles representing degrees latitude and degrees longitude. Unless
7912 # specified otherwise, this must conform to the
7913 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
7914 # standard&lt;/a&gt;. Values must be within normalized ranges.
7915 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
7916 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
7917 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7918 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
7919 # such as postal delivery and payments addresses. Given a postal address,
7920 # a postal service can deliver items to a premises, P.O. Box, or other
7921 # delivery location.
7922 # Given a postal address, a postal service can deliver items to a premise, P.O.
7923 # Box or similar.
7924 # It is not intended to model geographical locations (roads, towns,
7925 # mountains).
7926 #
7927 # In typical usage an address would be created via user input or from importing
7928 # existing data, depending on the type of process.
7929 #
7930 # Advice on address input / editing:
7931 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7932 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7933 # - Users should not be presented with UI elements for input or editing of
7934 # fields outside countries where that field is used.
7935 #
7936 # For more guidance on how to use this schema, please see:
7937 # https://support.google.com/business/answer/6397478
7938 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
7939 # known). This is often the UI language of the input form or is expected
7940 # to match one of the languages used in the address' country/region, or their
7941 # transliterated equivalents.
7942 # This can affect formatting in certain countries, but is not critical
7943 # to the correctness of the data and will never affect any validation or
7944 # other non-formatting related operations.
7945 #
7946 # If this value is not known, it should be omitted (rather than specifying a
7947 # possibly incorrect default).
7948 #
7949 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
7950 "recipients": [ # Optional. The recipient at the address.
7951 # This field may, under certain circumstances, contain multiline information.
7952 # For example, it might contain "care of" information.
7953 "A String",
7954 ],
7955 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
7956 # Examples: US city, IT comune, UK post town.
7957 # In regions of the world where localities are not well defined or do not fit
7958 # into this structure well, leave locality empty and use address_lines.
7959 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
7960 # in most regions. Where it is used, the value is either a string like
7961 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
7962 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
7963 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
7964 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
7965 # is never inferred and it is up to the user to ensure the value is
7966 # correct. See http://cldr.unicode.org/ and
7967 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
7968 # for details. Example: "CH" for Switzerland.
7969 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
7970 # addresses of a country or region.
7971 # For example, this can be a state, a province, an oblast, or a prefecture.
7972 # Specifically, for Spain this is the province and not the autonomous
7973 # community (e.g. "Barcelona" and not "Catalonia").
7974 # Many countries don't use an administrative area in postal addresses. E.g.
7975 # in Switzerland this should be left unpopulated.
7976 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
7977 #
7978 # Because values in address_lines do not have type information and may
7979 # sometimes contain multiple values in a single field (e.g.
7980 # "Austin, TX"), it is important that the line order is clear. The order of
7981 # address lines should be "envelope order" for the country/region of the
7982 # address. In places where this can vary (e.g. Japan), address_language is
7983 # used to make it explicit (e.g. "ja" for large-to-small ordering and
7984 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
7985 # an address can be selected based on the language.
7986 #
7987 # The minimum permitted structural representation of an address consists
7988 # of a region_code with all remaining information placed in the
7989 # address_lines. It would be possible to format such an address very
7990 # approximately without geocoding, but no semantic reasoning could be
7991 # made about any of the address components until it was at least
7992 # partially resolved.
7993 #
7994 # Creating an address only containing a region_code and address_lines, and
7995 # then geocoding is the recommended way to handle completely unstructured
7996 # addresses (as opposed to guessing which parts of the address should be
7997 # localities or administrative areas).
7998 "A String",
7999 ],
8000 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
8001 # postal codes to be present, but where they are used, they may trigger
8002 # additional validation with other parts of the address (e.g. state/zip
8003 # validation in the U.S.A.).
8004 "organization": "A String", # Optional. The name of the organization at the address.
8005 "sublocality": "A String", # Optional. Sublocality of the address.
8006 # For example, this can be neighborhoods, boroughs, districts.
8007 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
8008 # the latest revision.
8009 #
8010 # All new revisions **must** be backward compatible with old revisions.
8011 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8012 },
8013 },
8014 "jobSummary": "A String", # A summary of the job with core information that's displayed on the search
8015 # results listing page.
8016 "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most
8017 # closely matching a search query's keywords, if available. The matching
8018 # query keywords are enclosed in HTML bold tags.
8019 },
8020 ],
8021 "numJobsFromBroadenedQuery": 42, # If query broadening is enabled, we may append additional results from the
8022 # broadened query. This number indicates how many of the jobs returned in the
8023 # jobs field are from the broadened query. These results are always at the
8024 # end of the jobs list. In particular, a value of 0 means all the jobs in the
8025 # jobs list are from the original (without broadening) query. If this
8026 # field is non-zero, subsequent requests with offset after this result set
8027 # should contain all broadened results.
8028 "appliedJobLocationFilters": [ # The location filters that the service applied to the specified query. If
8029 # any filters are lat-lng based, the JobLocation.location_type is
8030 # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.
8031 { # Output only.
8032 #
8033 # A resource that represents a location with full geographic
8034 # information.
8035 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
8036 # location bounding box in which a circle with the specified radius
8037 # centered from LatLng coves the area associated with the job location.
8038 # For example, currently, "Mountain View, CA, USA" has a radius of
8039 # 7885.79 meters.
8040 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
8041 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
8042 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
8043 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8044 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
8045 # of doubles representing degrees latitude and degrees longitude. Unless
8046 # specified otherwise, this must conform to the
8047 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
8048 # standard&lt;/a&gt;. Values must be within normalized ranges.
8049 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
8050 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
8051 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8052 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
8053 # such as postal delivery and payments addresses. Given a postal address,
8054 # a postal service can deliver items to a premises, P.O. Box, or other
8055 # delivery location.
8056 # Given a postal address, a postal service can deliver items to a premise, P.O.
8057 # Box or similar.
8058 # It is not intended to model geographical locations (roads, towns,
8059 # mountains).
8060 #
8061 # In typical usage an address would be created via user input or from importing
8062 # existing data, depending on the type of process.
8063 #
8064 # Advice on address input / editing:
8065 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8066 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8067 # - Users should not be presented with UI elements for input or editing of
8068 # fields outside countries where that field is used.
8069 #
8070 # For more guidance on how to use this schema, please see:
8071 # https://support.google.com/business/answer/6397478
8072 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
8073 # known). This is often the UI language of the input form or is expected
8074 # to match one of the languages used in the address' country/region, or their
8075 # transliterated equivalents.
8076 # This can affect formatting in certain countries, but is not critical
8077 # to the correctness of the data and will never affect any validation or
8078 # other non-formatting related operations.
8079 #
8080 # If this value is not known, it should be omitted (rather than specifying a
8081 # possibly incorrect default).
8082 #
8083 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
8084 "recipients": [ # Optional. The recipient at the address.
8085 # This field may, under certain circumstances, contain multiline information.
8086 # For example, it might contain "care of" information.
8087 "A String",
8088 ],
8089 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
8090 # Examples: US city, IT comune, UK post town.
8091 # In regions of the world where localities are not well defined or do not fit
8092 # into this structure well, leave locality empty and use address_lines.
8093 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
8094 # in most regions. Where it is used, the value is either a string like
8095 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
8096 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
8097 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
8098 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
8099 # is never inferred and it is up to the user to ensure the value is
8100 # correct. See http://cldr.unicode.org/ and
8101 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
8102 # for details. Example: "CH" for Switzerland.
8103 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
8104 # addresses of a country or region.
8105 # For example, this can be a state, a province, an oblast, or a prefecture.
8106 # Specifically, for Spain this is the province and not the autonomous
8107 # community (e.g. "Barcelona" and not "Catalonia").
8108 # Many countries don't use an administrative area in postal addresses. E.g.
8109 # in Switzerland this should be left unpopulated.
8110 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
8111 #
8112 # Because values in address_lines do not have type information and may
8113 # sometimes contain multiple values in a single field (e.g.
8114 # "Austin, TX"), it is important that the line order is clear. The order of
8115 # address lines should be "envelope order" for the country/region of the
8116 # address. In places where this can vary (e.g. Japan), address_language is
8117 # used to make it explicit (e.g. "ja" for large-to-small ordering and
8118 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
8119 # an address can be selected based on the language.
8120 #
8121 # The minimum permitted structural representation of an address consists
8122 # of a region_code with all remaining information placed in the
8123 # address_lines. It would be possible to format such an address very
8124 # approximately without geocoding, but no semantic reasoning could be
8125 # made about any of the address components until it was at least
8126 # partially resolved.
8127 #
8128 # Creating an address only containing a region_code and address_lines, and
8129 # then geocoding is the recommended way to handle completely unstructured
8130 # addresses (as opposed to guessing which parts of the address should be
8131 # localities or administrative areas).
8132 "A String",
8133 ],
8134 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
8135 # postal codes to be present, but where they are used, they may trigger
8136 # additional validation with other parts of the address (e.g. state/zip
8137 # validation in the U.S.A.).
8138 "organization": "A String", # Optional. The name of the organization at the address.
8139 "sublocality": "A String", # Optional. Sublocality of the address.
8140 # For example, this can be neighborhoods, boroughs, districts.
8141 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
8142 # the latest revision.
8143 #
8144 # All new revisions **must** be backward compatible with old revisions.
8145 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8146 },
8147 ],
8148 "histogramResults": { # Output only. # The histogram results that match specified
8149 # SearchJobsRequest.HistogramFacets.
8150 #
8151 # Histogram results that matches HistogramFacets specified in
8152 # SearchJobsRequest.
8153 "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that
8154 # matches HistogramFacets.custom_attribute_histogram_facets.
8155 { # Output only.
8156 #
8157 # Custom attribute histogram result.
8158 "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for
8159 # custom attribute long values associated with `key`.
8160 #
8161 # Custom numeric bucketing result.
8162 "counts": [ # Count within each bucket. Its size is the length of
8163 # NumericBucketingOption.bucket_bounds plus 1.
8164 { # Represents count of jobs within one bucket.
8165 "count": 42, # Number of jobs whose numeric field value fall into `range`.
8166 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
8167 # that is, the count represents number of jobs in this range.
8168 "to": 3.14, # Ending value of the bucket range.
8169 "from": 3.14, # Starting value of the bucket range.
8170 },
8171 },
8172 ],
8173 "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if
8174 # [NumericBucketingOption.requires_min_max] is set to true.
8175 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
8176 # [NumericBucketingOption.requires_min_max] is set to true.
8177 },
8178 "stringValueHistogramResult": { # Stores a map from the values of string custom field associated
8179 # with `key` to the number of jobs with that value in this histogram result.
8180 "a_key": 42,
8181 },
8182 "key": "A String", # Stores the key of custom attribute the histogram is performed on.
8183 },
8184 ],
8185 "simpleHistogramResults": [ # Specifies histogram results that matches
8186 # HistogramFacets.simple_histogram_facets.
8187 { # Output only.
8188 #
8189 # Result of a histogram call. The response contains the histogram map for the
8190 # search type specified by HistogramResult.field.
8191 # The response is a map of each filter value to the corresponding count of
8192 # jobs for that filter.
8193 "values": { # A map from the values of field to the number of jobs with that value
8194 # in this search result.
8195 #
8196 # Key: search type (filter names, such as the companyName).
8197 #
8198 # Values: the count of jobs that match the filter for this search.
8199 "a_key": 42,
8200 },
8201 "searchType": "A String", # The Histogram search filters.
8202 },
8203 ],
8204 "compensationHistogramResults": [ # Specifies compensation field-based histogram results that matches
8205 # HistogramFacets.compensation_histogram_requests.
8206 { # Output only.
8207 #
8208 # Compensation based histogram result.
8209 "type": "A String", # Type of the request, corresponding to
8210 # CompensationHistogramRequest.type.
8211 "result": { # Output only. # Histogram result.
8212 #
8213 # Custom numeric bucketing result.
8214 "counts": [ # Count within each bucket. Its size is the length of
8215 # NumericBucketingOption.bucket_bounds plus 1.
8216 { # Represents count of jobs within one bucket.
8217 "count": 42, # Number of jobs whose numeric field value fall into `range`.
8218 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
8219 # that is, the count represents number of jobs in this range.
8220 "to": 3.14, # Ending value of the bucket range.
8221 "from": 3.14, # Starting value of the bucket range.
8222 },
8223 },
8224 ],
8225 "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if
8226 # [NumericBucketingOption.requires_min_max] is set to true.
8227 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
8228 # [NumericBucketingOption.requires_min_max] is set to true.
8229 },
8230 },
8231 ],
8232 },
8233 "jobView": "A String", # Corresponds to SearchJobsRequest.job_view.
8234 "appliedCommuteFilter": { # Input only. # The commute filter the service applied to the specified query. This
8235 # information is only available when query has a valid CommutePreference.
8236 #
8237 # Parameters needed for commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8238 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8239 # integer between 0 and 23, representing the hour in the time zone of the
8240 # start_location. Must not be present if road_traffic is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8241 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8242 # Must not be present if departure_hour_local is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8243 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8244 # For city level addresses, the city center is used. For state and coarser
8245 # level addresses, text matching is used.
8246 # If this field is set to `false` or is not specified, only jobs that include
8247 # street level addresses will be returned by commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8248 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
8249 "startLocation": { # 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8250 # commute time.
8251 # of doubles representing degrees latitude and degrees longitude. Unless
8252 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8253 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
8254 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8255 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
8256 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
8257 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8258 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
8259 # (one hour). Format is `123s`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8260 },
8261 "spellResult": { # Output only. # The spell checking result, and correction.
8262 #
8263 # Spell check result.
8264 "corrected": True or False, # Indicates if the query was corrected by the spell checker.
8265 "correctedText": "A String", # Correction output consisting of the corrected keyword string.
8266 },
8267 "metadata": { # Output only. # Additional information for the API invocation, such as the request
8268 # tracking id.
8269 #
8270 # Additional information returned to client, such as debugging
8271 # information.
8272 "requestId": "A String", # A unique id associated with this call.
8273 # This id is logged for tracking purposes.
8274 "experimentIdList": [ # Identifiers for the versions of the search algorithm used during
8275 # this API invocation if multiple algorithms are used.
8276 # The default value is empty.
8277 # For search response only.
8278 42,
8279 ],
8280 "mode": "A String", # For search response only. Indicates the mode of a performed search.
8281 },
8282 }</pre>
8283</div>
8284
8285<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8286 <code class="details" id="searchForAlert">searchForAlert(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8287 <pre>Searches for jobs using the provided SearchJobsRequest.
8288
8289This API call is intended for the use case of targeting passive job
8290seekers (for example, job seekers who have signed up to receive email
8291alerts about potential job opportunities), and has different algorithmic
8292adjustments that are targeted to passive job seekers.
8293
8294This call constrains the visibility of jobs
8295present in the database, and only returns jobs the caller has
8296permission to search against.
8297
8298Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8299 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8300 The object takes the form of:
8301
8302{ # Input only.
8303 #
8304 # The Request body of the `SearchJobs` call.
8305 "orderBy": "A String", # Deprecated. Use sort_by instead.
8306 #
8307 # Optional.
8308 #
8309 # The criteria determining how search results are sorted.
8310 # Defaults to SortBy.RELEVANCE_DESC if no value is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8311 "histogramFacets": { # Input only. # Optional. Restrictions on what fields to perform histogram on, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8312 # `COMPANY_SIZE` etc.
8313 #
8314 # Histogram facets to be specified in SearchJobsRequest.
8315 "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,
8316 # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to
8317 # GetHistogramRequest.
8318 "A String",
8319 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8320 "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8321 # Duplicate values of CustomAttributeHistogramRequest.key are not
8322 # allowed.
8323 { # Custom attributes histogram request. An error will be thrown if neither
8324 # string_value_histogram or long_value_histogram_bucketing_option has
8325 # been defined.
8326 "stringValueHistogram": True or False, # Optional. If set to true, the response will include the histogram value for
8327 # each key as a string.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8328 "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8329 # filterable long custom field values, or min/max value requirements.
8330 #
8331 # Use this field to specify bucketing option for the histogram search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8332 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8333 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
8334 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
8335 # [buckets_bound is supported.
8336 3.14,
8337 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8338 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8339 # value of the numeric field.
8340 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8341 "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8342 # without `long_value_histogram_bucketing_option`, histogram on string values
8343 # of the given `key` is triggered, otherwise histogram is performed on long
8344 # values.
8345 },
8346 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8347 "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8348 # Duplicate values of CompensationHistogramRequest.type are not allowed.
8349 { # Input only.
8350 #
8351 # Compensation based histogram request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8352 "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8353 #
8354 # Use this field to specify bucketing option for the histogram search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8355 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8356 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
8357 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
8358 # [buckets_bound is supported.
8359 3.14,
8360 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8361 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8362 # value of the numeric field.
8363 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8364 "type": "A String", # Required. Type of the request, representing which field the histogramming should be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8365 # performed over. A single request can only specify one histogram of each
8366 # `CompensationHistogramRequestType`.
8367 },
8368 ],
8369 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8370 "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8371 # Broadened queries append results to the end of the matching results
8372 # list.
8373 #
8374 # Defaults to false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8375 "enablePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8376 # count of the first 300 results. Setting this to `true` ensures
8377 # consistency in the number of results per page. Best practice is to set this
8378 # value to true if a client allows users to jump directly to a
8379 # non-sequential search results page.
8380 #
8381 # Enabling this flag may adversely impact performance.
8382 #
8383 # Defaults to false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8384 "filters": { # Input only. # Deprecated. Use query instead.
8385 #
8386 # Optional.
8387 #
8388 # Restrictions on the scope of the search request, such as filtering
8389 # by location.
8390 #
8391 # Deprecated. Use JobQuery instead.
8392 #
8393 # The filters required to perform a search query or histogram.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8394 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8395 # service attempts to correct a misspelled query,
8396 # for example, "enginee" is corrected to "engineer".
8397 #
8398 # Defaults to false: a spell check is performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8399 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8400 # Job.custom_attributes that are marked as `filterable`.
8401 #
8402 # The syntax for this expression is a subset of Google SQL syntax.
8403 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8404 # Supported operators are: =, !=, &lt;, &lt;=, &gt;, &gt;= where the left of the operator
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8405 # is a custom field key and the right of the operator is a number or string
8406 # (surrounded by quotes) value.
8407 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8408 # Supported functions are LOWER(&lt;field_name&gt;) to
8409 # perform case insensitive match and EMPTY(&lt;field_name&gt;) to filter on the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8410 # existence of a key.
8411 #
8412 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
8413 # nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can
8414 # be a maximum of 100 comparisons/functions in the expression. The expression
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8415 # must be &lt; 3000 bytes in length.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8416 #
8417 # Sample Query:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8418 # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 &gt; 100
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8419 "customFieldFilters": { # Deprecated. Use custom_attribute_filter instead.
8420 #
8421 # Optional.
8422 #
8423 # This filter specifies searching against
8424 # custom field values. See Job.filterable_custom_fields for information.
8425 # The key value specifies a number between 1-20 (the service
8426 # supports 20 custom fields) corresponding to the desired custom field map
8427 # value. If an invalid key is provided or specified together with
8428 # custom_attribute_filter, an error is thrown.
8429 "a_key": { # Input only.
8430 #
8431 # Custom field filter of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8432 "type": "A String", # Optional. The type of filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8433 # Defaults to FilterType.OR.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8434 "queries": [ # Required. The query strings for the filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8435 "A String",
8436 ],
8437 },
8438 },
8439 "tenantJobOnly": True or False, # Deprecated. Do not use this field.
8440 #
8441 # This flag controls whether the job search should be restricted to jobs
8442 # owned by the current user.
8443 #
8444 # Defaults to false where all jobs accessible to the
8445 # user are searched against.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8446 "categories": [ # Optional. The category filter specifies the categories of jobs to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8447 # See Category for more information.
8448 #
8449 # If a value is not specified, jobs from any category are searched against.
8450 #
8451 # If multiple values are specified, jobs from any of the specified
8452 # categories are searched against.
8453 "A String",
8454 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8455 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8456 # search against, such as EmploymentType.FULL_TIME.
8457 #
8458 # If a value is not specified, jobs in the search results include any
8459 # employment type.
8460 #
8461 # If multiple values are specified, jobs in the search results include any
8462 # of the specified employment types.
8463 "A String",
8464 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8465 "companyTitles": [ # Optional. This filter specifies the exact company titles
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8466 # of jobs to search against.
8467 #
8468 # If a value is not specified, jobs within the search results can be
8469 # associated with any company.
8470 #
8471 # If multiple values are specified, jobs within the search results may be
8472 # associated with any of the specified companies.
8473 #
8474 # At most 20 company title filters are allowed.
8475 "A String",
8476 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8477 "query": "A String", # Optional. The query filter contains the keywords that match against the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8478 # title, description, and location fields.
8479 #
8480 # The maximum query size is 255 bytes/characters.
8481 "extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter.
8482 #
8483 # Optional.
8484 #
8485 # This search filter is applied only to
8486 # Job.extended_compensation_info. For example, if the filter is specified
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8487 # as "Hourly job with per-hour compensation &gt; $15", only jobs that meet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8488 # these criteria are searched. If a filter is not defined, all open jobs
8489 # are searched.
8490 #
8491 # Input only.
8492 #
8493 # Filter on job compensation type and amount.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8494 "includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
8495 "type": "A String", # Required. Type of filter.
8496 "compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8497 #
8498 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8499 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8500 #
8501 # Decimal number.
8502 "units": "A String", # Whole units.
8503 "micros": 42, # Micro (10^-6) units.
8504 # The value must be between -999,999 and +999,999 inclusive.
8505 # If `units` is positive, `micros` must be positive or zero.
8506 # If `units` is zero, `micros` can be positive, zero, or negative.
8507 # If `units` is negative, `micros` must be negative or zero.
8508 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
8509 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8510 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8511 #
8512 # Decimal number.
8513 "units": "A String", # Whole units.
8514 "micros": 42, # Micro (10^-6) units.
8515 # The value must be between -999,999 and +999,999 inclusive.
8516 # If `units` is positive, `micros` must be positive or zero.
8517 # If `units` is zero, `micros` can be positive, zero, or negative.
8518 # If `units` is negative, `micros` must be negative or zero.
8519 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
8520 },
8521 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8522 "compensationUnits": [ # Required. Specify desired `base compensation entry's`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8523 # ExtendedCompensationInfo.CompensationUnit.
8524 "A String",
8525 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8526 "currency": "A String", # Optional. Specify currency in 3-letter
8527 # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If
8528 # unspecified, jobs are returned regardless of currency.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8529 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8530 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8531 # driving or public transit). Note: this only works with COMMUTE
8532 # MODE. When specified, [JobFilters.location_filters] will be
8533 # ignored.
8534 #
8535 # Currently we do not support sorting by commute time.
8536 #
8537 # Parameters needed for commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8538 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8539 # integer between 0 and 23, representing the hour in the time zone of the
8540 # start_location. Must not be present if road_traffic is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8541 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8542 # Must not be present if departure_hour_local is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8543 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8544 # For city level addresses, the city center is used. For state and coarser
8545 # level addresses, text matching is used.
8546 # If this field is set to `false` or is not specified, only jobs that include
8547 # street level addresses will be returned by commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8548 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
8549 "startLocation": { # 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8550 # commute time.
8551 # of doubles representing degrees latitude and degrees longitude. Unless
8552 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8553 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
8554 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8555 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
8556 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
8557 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8558 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
8559 # (one hour). Format is `123s`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8560 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8561 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8562 # for example, "en-US".
8563 #
8564 # If a value is not specified, the search results may contain jobs in any
8565 # locale.
8566 #
8567 #
8568 # Language codes should be in BCP-47 format, for example, "en-US" or
8569 # "sr-Latn". For more information, see [Tags for Identifying
8570 # Languages](https://tools.ietf.org/html/bcp47).
8571 #
8572 # At most 10 language code filters are allowed.
8573 "A String",
8574 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8575 "companyNames": [ # Optional. The company names filter specifies the company entities to search
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8576 # against.
8577 #
8578 # If a value is not specified, jobs are searched for against all companies.
8579 #
8580 # If multiple values are specified, jobs are searched against the
8581 # specified companies.
8582 #
8583 # At most 20 company filters are allowed.
8584 "A String",
8585 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8586 "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8587 # against, for example, DateRange.PAST_MONTH. If a value is not
8588 # specified, all open jobs are searched against regardless of the
8589 # date they were published.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8590 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8591 # search against. See LocationFilter for more information.
8592 #
8593 # If a location value is not specified, jobs are retrieved
8594 # from all locations.
8595 #
8596 # If multiple values are specified, jobs are retrieved from any of the
8597 # specified locations. If different values are specified for the
8598 # LocationFilter.distance_in_miles parameter, the maximum provided
8599 # distance is used for all locations.
8600 #
8601 # At most 5 location filters are allowed.
8602 { # Input only.
8603 #
8604 # Geographic region of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8605 "isTelecommute": True or False, # Optional. Allows the client to return jobs without a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8606 # set location, specifically, telecommuting jobs (telecomuting is considered
8607 # by the service as a special location.
8608 # Job.allow_telecommute indicates if a job permits telecommuting.
8609 # If this field is true, telecommuting jobs are searched, and
8610 # name and lat_lng are
8611 # ignored.
8612 # This filter can be used by itself to search exclusively for telecommuting
8613 # jobs, or it can be combined with another location
8614 # filter to search for a combination of job locations,
8615 # such as "Mountain View" or "telecommuting" jobs. However, when used in
8616 # combination with other location filters, telecommuting jobs can be
8617 # treated as less relevant than other jobs in the search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8618 "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
8619 # search. This field is ignored if `location_name` is provided.
8620 # of doubles representing degrees latitude and degrees longitude. Unless
8621 # specified otherwise, this must conform to the
8622 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
8623 # standard&lt;/a&gt;. Values must be within normalized ranges.
8624 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
8625 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
8626 },
8627 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8628 # identified as a city or smaller. When the location being searched for is a
8629 # state or larger, this field is ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8630 "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
8631 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used
8632 # to address ambiguity of the user-input location, e.g. "Liverpool"
8633 # against "Liverpool, NY, US" or "Liverpool, UK".
8634 #
8635 # Set this field if all the jobs to search against are from a same region,
8636 # or jobs are world-wide but the job seeker is from a specific region.
8637 #
8638 # See http://cldr.unicode.org/ and
8639 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
8640 # for details. Example: "CH" for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8641 },
8642 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8643 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8644 # Job.compensation_info. For example, if the filter is specified
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8645 # as "Hourly job with per-hour compensation &gt; $15", only jobs that meet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8646 # this criteria are searched. If a filter is not defined, all open jobs
8647 # are searched.
8648 #
8649 # Filter on job compensation type and amount.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8650 "units": [ # Required. Specify desired `base compensation entry's`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8651 # CompensationInfo.CompensationUnit.
8652 "A String",
8653 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8654 "range": { # Compensation range. # Optional. Compensation range.
8655 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8656 # to a maximal compensation value and the currency code is set to
8657 # match the currency code of
8658 # min_compensation.
8659 "nanos": 42, # Number of nano (10^-9) units of the amount.
8660 # The value must be between -999,999,999 and +999,999,999 inclusive.
8661 # If `units` is positive, `nanos` must be positive or zero.
8662 # If `units` is zero, `nanos` can be positive, zero, or negative.
8663 # If `units` is negative, `nanos` must be negative or zero.
8664 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
8665 "units": "A String", # The whole units of the amount.
8666 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
8667 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
8668 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8669 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8670 # to zero and the currency code is set to match the
8671 # currency code of max_compensation.
8672 "nanos": 42, # Number of nano (10^-9) units of the amount.
8673 # The value must be between -999,999,999 and +999,999,999 inclusive.
8674 # If `units` is positive, `nanos` must be positive or zero.
8675 # If `units` is zero, `nanos` can be positive, zero, or negative.
8676 # If `units` is negative, `nanos` must be negative or zero.
8677 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
8678 "units": "A String", # The whole units of the amount.
8679 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
8680 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
8681 },
8682 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8683 "type": "A String", # Required. Type of filter.
8684 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8685 },
8686 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8687 "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.
8688 # Increasing this value above the default value of 10 can increase search
8689 # response time. The value can be between 1 and 100.
8690 "mode": "A String", # Required. Mode of a search.
8691 "pageToken": "A String", # Optional. The token specifying the current offset within
8692 # search results. See SearchJobsResponse.next_page_token for
8693 # an explanation of how to obtain the next set of query results.
8694 "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the
8695 # search quality of the service. The identifiers, (such as `user_id`) are
8696 # provided by users, and must be unique and consistent.
8697 #
8698 # Meta information related to the job searcher or entity
8699 # conducting the job search. This information is used to improve the
8700 # performance of the service.
8701 "deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the
8702 # service.
8703 #
8704 # Device information collected from the job seeker, candidate, or
8705 # other entity conducting the job search. Providing this information improves
8706 # the quality of the search results across devices.
8707 "deviceType": "A String", # Optional. Type of the device.
8708 "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes
8709 # the device from other devices.
8710 },
8711 "sessionId": "A String", # Required. A unique session identification string. A session is defined as the
8712 # duration of an end user's interaction with the service over a period.
8713 # Obfuscate this field for privacy concerns before
8714 # providing it to the API.
8715 #
8716 # If this field is not available for some reason, please send "UNKNOWN". Note
8717 # that any improvements to the service model for a particular tenant site,
8718 # rely on this field being set correctly to some unique session_id.
8719 "userId": "A String", # Required. A unique user identification string, as determined by the client. The
8720 # client is responsible for ensuring client-level uniqueness of this value
8721 # in order to have the strongest positive impact on search quality.
8722 # Obfuscate this field for privacy concerns before
8723 # providing it to the service.
8724 #
8725 # If this field is not available for some reason, please send "UNKNOWN". Note
8726 # that any improvements to the service model for a particular tenant site,
8727 # rely on this field being set correctly to some unique user_id.
8728 "domain": "A String", # Required. The client-defined scope or source of the service call, which typically
8729 # is the domain on
8730 # which the service has been implemented and is currently being run.
8731 #
8732 # For example, if the service is being run by client &lt;em&gt;Foo, Inc.&lt;/em&gt;, on
8733 # job board www.foo.com and career site www.bar.com, then this field is
8734 # set to "foo.com" for use on the job board, and "bar.com" for use on the
8735 # career site.
8736 #
8737 # If this field is not available for some reason, send "UNKNOWN". Note that
8738 # any improvements to the service model for a particular tenant site rely on
8739 # this field being set correctly to some domain.
8740 },
8741 "jobView": "A String", # Optional. The number of job attributes returned for jobs in the
8742 # search response. Defaults to JobView.SMALL if no value is specified.
8743 "disableRelevanceThresholding": True or False, # Optional. Controls whether to disable relevance thresholding. Relevance
8744 # thresholding removes jobs that have low relevance in search results,
8745 # for example, removing "Assistant to the CEO" positions from the search
8746 # results of a search for "CEO".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8747 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8748 # Disabling relevance thresholding improves the accuracy of subsequent
8749 # search requests.
8750 #
8751 # Defaults to false.
8752 "offset": 42, # Optional. An integer that specifies the current offset (that is, starting result
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8753 # location, amongst the jobs deemed by the API as relevant) in search
8754 # results. This field is only considered if page_token is unset.
8755 #
8756 # For example, 0 means to return results starting from the first matching
8757 # job, and 10 means to return from the 11th job. This can be used for
8758 # pagination, (for example, pageSize = 10 and offset = 10 means to return
8759 # from the second page).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8760 "query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8761 #
8762 # The query required to perform a search query or histogram.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8763 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8764 # service attempts to correct a misspelled query,
8765 # for example, "enginee" is corrected to "engineer".
8766 #
8767 # Defaults to false: a spell check is performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8768 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8769 # Job.custom_attributes marked as `filterable`.
8770 #
8771 # The syntax for this expression is a subset of Google SQL syntax.
8772 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8773 # Supported operators are: =, !=, &lt;, &lt;=, &gt;, &gt;= where the left of the operator
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8774 # is a custom field key and the right of the operator is a number or string
8775 # (surrounded by quotes) value.
8776 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8777 # Supported functions are LOWER(&lt;field_name&gt;) to
8778 # perform case insensitive match and EMPTY(&lt;field_name&gt;) to filter on the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8779 # existence of a key.
8780 #
8781 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
8782 # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50
8783 # comparisons/functions are allowed in the expression. The expression
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8784 # must be &lt; 2000 characters in length.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8785 #
8786 # Sample Query:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8787 # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 &gt; 100
8788 "companyDisplayNames": [ # Optional. This filter specifies the exact company display
8789 # name of the jobs to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8790 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8791 # If a value isn't specified, jobs within the search results are
8792 # associated with any company.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8793 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8794 # If multiple values are specified, jobs within the search results may be
8795 # associated with any of the specified companies.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8796 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8797 # At most 20 company display name filters are allowed.
8798 "A String",
8799 ],
8800 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8801 # search against, such as EmploymentType.FULL_TIME.
8802 #
8803 # If a value is not specified, jobs in the search results include any
8804 # employment type.
8805 #
8806 # If multiple values are specified, jobs in the search results include
8807 # any of the specified employment types.
8808 "A String",
8809 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8810 "query": "A String", # Optional. The query string that matches against the job title, description, and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8811 # location fields.
8812 #
8813 # The maximum query size is 255 bytes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8814 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
8815 # Job.compensation_info. For example, if the filter is specified
8816 # as "Hourly job with per-hour compensation &gt; $15", only jobs meeting
8817 # these criteria are searched. If a filter isn't defined, all open jobs
8818 # are searched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8819 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8820 # Filter on job compensation type and amount.
8821 "units": [ # Required. Specify desired `base compensation entry's`
8822 # CompensationInfo.CompensationUnit.
8823 "A String",
8824 ],
8825 "range": { # Compensation range. # Optional. Compensation range.
8826 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
8827 # to a maximal compensation value and the currency code is set to
8828 # match the currency code of
8829 # min_compensation.
8830 "nanos": 42, # Number of nano (10^-9) units of the amount.
8831 # The value must be between -999,999,999 and +999,999,999 inclusive.
8832 # If `units` is positive, `nanos` must be positive or zero.
8833 # If `units` is zero, `nanos` can be positive, zero, or negative.
8834 # If `units` is negative, `nanos` must be negative or zero.
8835 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
8836 "units": "A String", # The whole units of the amount.
8837 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
8838 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
8839 },
8840 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
8841 # to zero and the currency code is set to match the
8842 # currency code of max_compensation.
8843 "nanos": 42, # Number of nano (10^-9) units of the amount.
8844 # The value must be between -999,999,999 and +999,999,999 inclusive.
8845 # If `units` is positive, `nanos` must be positive or zero.
8846 # If `units` is zero, `nanos` can be positive, zero, or negative.
8847 # If `units` is negative, `nanos` must be negative or zero.
8848 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
8849 "units": "A String", # The whole units of the amount.
8850 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
8851 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
8852 },
8853 },
8854 "type": "A String", # Required. Type of filter.
8855 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.
8856 },
8857 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for
8858 # example, driving or public transit). Note: This only works with COMMUTE
8859 # MODE. When specified, [JobQuery.location_filters] is
8860 # ignored.
8861 #
8862 # Currently we don't support sorting by commute time.
8863 #
8864 # Parameters needed for commute search.
8865 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
8866 # integer between 0 and 23, representing the hour in the time zone of the
8867 # start_location. Must not be present if road_traffic is specified.
8868 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
8869 # Must not be present if departure_hour_local is specified.
8870 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
8871 # For city level addresses, the city center is used. For state and coarser
8872 # level addresses, text matching is used.
8873 # If this field is set to `false` or is not specified, only jobs that include
8874 # street level addresses will be returned by commute search.
8875 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
8876 "startLocation": { # 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
8877 # commute time.
8878 # of doubles representing degrees latitude and degrees longitude. Unless
8879 # specified otherwise, this must conform to the
8880 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
8881 # standard&lt;/a&gt;. Values must be within normalized ranges.
8882 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
8883 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
8884 },
8885 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
8886 # (one hour). Format is `123s`.
8887 },
8888 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8889 # for example, "en-US".
8890 #
8891 # If a value isn't specified, the search results can contain jobs in any
8892 # locale.
8893 #
8894 #
8895 # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".
8896 # For more information, see
8897 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
8898 #
8899 # At most 10 language code filters are allowed.
8900 "A String",
8901 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8902 "companyNames": [ # Optional. This filter specifies the company entities to search against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8903 #
8904 # If a value isn't specified, jobs are searched for against all
8905 # companies.
8906 #
8907 # If multiple values are specified, jobs are searched against the
8908 # companies specified.
8909 #
8910 # At most 20 company filters are allowed.
8911 "A String",
8912 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8913 "publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched
8914 # against, for example, DateRange.PAST_MONTH. If a value isn't
8915 # specified, all open jobs are searched against regardless of their
8916 # published date.
8917 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8918 # search against. See LocationFilter for more information.
8919 #
8920 # If a location value isn't specified, jobs fitting the other search
8921 # criteria are retrieved regardless of where they're located.
8922 #
8923 # If multiple values are specified, jobs are retrieved from any of the
8924 # specified locations. If different values are specified for the
8925 # LocationFilter.distance_in_miles parameter, the maximum provided
8926 # distance is used for all locations.
8927 #
8928 # At most 5 location filters are allowed.
8929 { # Input only.
8930 #
8931 # Geographic region of the search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8932 "isTelecommute": True or False, # Optional. Allows the client to return jobs without a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8933 # set location, specifically, telecommuting jobs (telecomuting is considered
8934 # by the service as a special location.
8935 # Job.allow_telecommute indicates if a job permits telecommuting.
8936 # If this field is true, telecommuting jobs are searched, and
8937 # name and lat_lng are
8938 # ignored.
8939 # This filter can be used by itself to search exclusively for telecommuting
8940 # jobs, or it can be combined with another location
8941 # filter to search for a combination of job locations,
8942 # such as "Mountain View" or "telecommuting" jobs. However, when used in
8943 # combination with other location filters, telecommuting jobs can be
8944 # treated as less relevant than other jobs in the search response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8945 "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
8946 # search. This field is ignored if `location_name` is provided.
8947 # of doubles representing degrees latitude and degrees longitude. Unless
8948 # specified otherwise, this must conform to the
8949 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
8950 # standard&lt;/a&gt;. Values must be within normalized ranges.
8951 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
8952 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
8953 },
8954 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8955 # identified as a city or smaller. When the location being searched for is a
8956 # state or larger, this field is ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8957 "name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
8958 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used
8959 # to address ambiguity of the user-input location, e.g. "Liverpool"
8960 # against "Liverpool, NY, US" or "Liverpool, UK".
8961 #
8962 # Set this field if all the jobs to search against are from a same region,
8963 # or jobs are world-wide but the job seeker is from a specific region.
8964 #
8965 # See http://cldr.unicode.org/ and
8966 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
8967 # for details. Example: "CH" for Switzerland.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8968 },
8969 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8970 "categories": [ # Optional. The category filter specifies the categories of jobs to search against.
8971 # See Category for more information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8972 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8973 # If a value is not specified, jobs from any category are searched against.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8974 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8975 # If multiple values are specified, jobs from any of the specified
8976 # categories are searched against.
8977 "A String",
8978 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8979 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]8980 "sortBy": "A String", # Optional. The criteria determining how search results are sorted.
8981 # Defaults to SortBy.RELEVANCE_DESC if no value is specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]8982 }
8983
8984 x__xgafv: string, V1 error format.
8985 Allowed values
8986 1 - v1 error format
8987 2 - v2 error format
8988
8989Returns:
8990 An object of the form:
8991
8992 { # Output only.
8993 #
8994 # Response for SearchJob method.
8995 "nextPageToken": "A String", # The token that specifies the starting position of the next page of results.
8996 # This field is empty if there are no more results.
8997 "estimatedTotalSize": "A String", # An estimation of the number of jobs that match the specified query.
8998 #
8999 # This number is not guaranteed to be accurate. For accurate results,
9000 # seenenable_precise_result_size.
9001 "totalSize": "A String", # The precise result count, which is available only if the client set
9002 # enable_precise_result_size to `true` or if the response
9003 # is the last page of results. Otherwise, the value will be `-1`.
9004 "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.
9005 { # Output only.
9006 #
9007 # Job entry with metadata inside SearchJobsResponse.
9008 "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar
9009 # fields that most closely match a search query's keywords, if available.
9010 # All HTML tags in the original fields are stripped when returned in this
9011 # field, and matching query keywords are enclosed in HTML bold tags.
9012 "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.
9013 # or "job requisition"). A job belongs to a Company, which is the hiring
9014 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9015 "languageCode": "A String", # Optional. The language of the posting. This field is distinct from
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9016 # any requirements for fluency that are associated with the job.
9017 #
9018 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
9019 # For more information, see
9020 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
9021 # class="external" target="_blank" }.
9022 #
9023 # If this field is unspecified and Job.description is present, detected
9024 # language code based on Job.description is assigned, otherwise
9025 # defaults to 'en_US'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9026 "updateTime": "A String", # Output only. The timestamp when this job was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9027 "unindexedCustomFields": { # Deprecated. Use custom_attributes instead.
9028 #
9029 # Optional.
9030 #
9031 # A map of fields to hold non-filterable custom job attributes, similar to
9032 # filterable_custom_fields. These fields are distinct in that the data
9033 # in these fields are not indexed. Therefore, the client cannot search
9034 # against them, nor can the client use them to list jobs.
9035 #
9036 # The key of the map can be any valid string.
9037 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9038 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9039 "A String",
9040 ],
9041 },
9042 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9043 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9044 # is used for contracting engagements.
9045 # Dates prior to 1970/1/1 and invalid date formats are ignored.
9046 # and time zone are either specified elsewhere or are not significant. The date
9047 # is relative to the Proleptic Gregorian Calendar. This can represent:
9048 #
9049 # * A full date, with non-zero year, month and day values
9050 # * A month and day value, with a zero year, e.g. an anniversary
9051 # * A year on its own, with zero month and day values
9052 # * A year and month value, with a zero day, e.g. a credit card expiration date
9053 #
9054 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
9055 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9056 # month and day.
9057 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9058 # if specifying a year by itself or a year and month where the day is not
9059 # significant.
9060 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9061 # a year.
9062 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9063 "companyDisplayName": "A String", # Output only. The name of the company listing the job.
9064 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9065 # is used for contracting engagements.
9066 # Dates prior to 1970/1/1 and invalid date formats are ignored.
9067 # and time zone are either specified elsewhere or are not significant. The date
9068 # is relative to the Proleptic Gregorian Calendar. This can represent:
9069 #
9070 # * A full date, with non-zero year, month and day values
9071 # * A month and day value, with a zero year, e.g. an anniversary
9072 # * A year on its own, with zero month and day values
9073 # * A year and month value, with a zero day, e.g. a credit card expiration date
9074 #
9075 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
9076 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9077 # month and day.
9078 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9079 # if specifying a year by itself or a year and month where the day is not
9080 # significant.
9081 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9082 # a year.
9083 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9084 "jobLocations": [ # Output only. Structured locations of the job, resolved from locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9085 { # Output only.
9086 #
9087 # A resource that represents a location with full geographic
9088 # information.
9089 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
9090 # location bounding box in which a circle with the specified radius
9091 # centered from LatLng coves the area associated with the job location.
9092 # For example, currently, "Mountain View, CA, USA" has a radius of
9093 # 7885.79 meters.
9094 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
9095 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
9096 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
9097 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9098 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
9099 # of doubles representing degrees latitude and degrees longitude. Unless
9100 # specified otherwise, this must conform to the
9101 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
9102 # standard&lt;/a&gt;. Values must be within normalized ranges.
9103 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
9104 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
9105 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9106 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
9107 # such as postal delivery and payments addresses. Given a postal address,
9108 # a postal service can deliver items to a premises, P.O. Box, or other
9109 # delivery location.
9110 # Given a postal address, a postal service can deliver items to a premise, P.O.
9111 # Box or similar.
9112 # It is not intended to model geographical locations (roads, towns,
9113 # mountains).
9114 #
9115 # In typical usage an address would be created via user input or from importing
9116 # existing data, depending on the type of process.
9117 #
9118 # Advice on address input / editing:
9119 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9120 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9121 # - Users should not be presented with UI elements for input or editing of
9122 # fields outside countries where that field is used.
9123 #
9124 # For more guidance on how to use this schema, please see:
9125 # https://support.google.com/business/answer/6397478
9126 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
9127 # known). This is often the UI language of the input form or is expected
9128 # to match one of the languages used in the address' country/region, or their
9129 # transliterated equivalents.
9130 # This can affect formatting in certain countries, but is not critical
9131 # to the correctness of the data and will never affect any validation or
9132 # other non-formatting related operations.
9133 #
9134 # If this value is not known, it should be omitted (rather than specifying a
9135 # possibly incorrect default).
9136 #
9137 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
9138 "recipients": [ # Optional. The recipient at the address.
9139 # This field may, under certain circumstances, contain multiline information.
9140 # For example, it might contain "care of" information.
9141 "A String",
9142 ],
9143 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
9144 # Examples: US city, IT comune, UK post town.
9145 # In regions of the world where localities are not well defined or do not fit
9146 # into this structure well, leave locality empty and use address_lines.
9147 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
9148 # in most regions. Where it is used, the value is either a string like
9149 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
9150 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
9151 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
9152 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
9153 # is never inferred and it is up to the user to ensure the value is
9154 # correct. See http://cldr.unicode.org/ and
9155 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
9156 # for details. Example: "CH" for Switzerland.
9157 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
9158 # addresses of a country or region.
9159 # For example, this can be a state, a province, an oblast, or a prefecture.
9160 # Specifically, for Spain this is the province and not the autonomous
9161 # community (e.g. "Barcelona" and not "Catalonia").
9162 # Many countries don't use an administrative area in postal addresses. E.g.
9163 # in Switzerland this should be left unpopulated.
9164 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
9165 #
9166 # Because values in address_lines do not have type information and may
9167 # sometimes contain multiple values in a single field (e.g.
9168 # "Austin, TX"), it is important that the line order is clear. The order of
9169 # address lines should be "envelope order" for the country/region of the
9170 # address. In places where this can vary (e.g. Japan), address_language is
9171 # used to make it explicit (e.g. "ja" for large-to-small ordering and
9172 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
9173 # an address can be selected based on the language.
9174 #
9175 # The minimum permitted structural representation of an address consists
9176 # of a region_code with all remaining information placed in the
9177 # address_lines. It would be possible to format such an address very
9178 # approximately without geocoding, but no semantic reasoning could be
9179 # made about any of the address components until it was at least
9180 # partially resolved.
9181 #
9182 # Creating an address only containing a region_code and address_lines, and
9183 # then geocoding is the recommended way to handle completely unstructured
9184 # addresses (as opposed to guessing which parts of the address should be
9185 # localities or administrative areas).
9186 "A String",
9187 ],
9188 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
9189 # postal codes to be present, but where they are used, they may trigger
9190 # additional validation with other parts of the address (e.g. state/zip
9191 # validation in the U.S.A.).
9192 "organization": "A String", # Optional. The name of the organization at the address.
9193 "sublocality": "A String", # Optional. Sublocality of the address.
9194 # For example, this can be neighborhoods, boroughs, districts.
9195 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
9196 # the latest revision.
9197 #
9198 # All new revisions **must** be backward compatible with old revisions.
9199 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9200 },
9201 ],
9202 "locations": [ # Optional but strongly recommended for the best service experience.
9203 #
9204 # Location(s) where the emploeyer is looking to hire for this job posting.
9205 #
9206 # Specifying the full street address(es) of the hiring location enables
9207 # better API results, especially job searches by commute time.
9208 #
9209 # At most 50 locations are allowed for best search performance. If a job has
9210 # more locations, it is suggested to split it into multiple jobs with unique
9211 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
9212 # multiple jobs with the same requisition_id, company_name and
9213 # language_code are not allowed. If the original requisition_id must
9214 # be preserved, a custom field should be used for storage. It is also
9215 # suggested to group the locations that close to each other in the same job
9216 # for better search experience.
9217 #
9218 # The maximum number of allowed characters is 500.
9219 "A String",
9220 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9221 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9222 # full time or
9223 # part time.
9224 "A String",
9225 ],
9226 "applicationUrls": [ # Optional but at least one of application_urls,
9227 # application_email_list or application_instruction must be
9228 # specified.
9229 #
9230 # Use this URL field to direct an applicant to a website, for example to
9231 # link to an online application form.
9232 #
9233 # The maximum number of allowed characters is 2,000.
9234 "A String",
9235 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9236 "educationLevels": [ # Optional. The desired education level for the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9237 # "Bachelors", "Masters", "Doctorate".
9238 "A String",
9239 ],
9240 "extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.
9241 #
9242 # Optional.
9243 #
9244 # Job compensation information.
9245 #
9246 # This field replaces compensation_info. Only
9247 # CompensationInfo.entries or extended_compensation_info can be set,
9248 # otherwise an exception is thrown.
9249 #
9250 # Describes job compensation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9251 "annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9252 # the job's all CompensationEntry cannot be annualized.
9253 # See CompensationEntry for explanation on annualization and base
9254 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9255 "annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9256 #
9257 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9258 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9259 #
9260 # Decimal number.
9261 "units": "A String", # Whole units.
9262 "micros": 42, # Micro (10^-6) units.
9263 # The value must be between -999,999 and +999,999 inclusive.
9264 # If `units` is positive, `micros` must be positive or zero.
9265 # If `units` is zero, `micros` can be positive, zero, or negative.
9266 # If `units` is negative, `micros` must be negative or zero.
9267 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9268 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9269 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9270 #
9271 # Decimal number.
9272 "units": "A String", # Whole units.
9273 "micros": 42, # Micro (10^-6) units.
9274 # The value must be between -999,999 and +999,999 inclusive.
9275 # If `units` is positive, `micros` must be positive or zero.
9276 # If `units` is zero, `micros` can be positive, zero, or negative.
9277 # If `units` is negative, `micros` must be negative or zero.
9278 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9279 },
9280 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9281 "annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9282 #
9283 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9284 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9285 #
9286 # Decimal number.
9287 "units": "A String", # Whole units.
9288 "micros": 42, # Micro (10^-6) units.
9289 # The value must be between -999,999 and +999,999 inclusive.
9290 # If `units` is positive, `micros` must be positive or zero.
9291 # If `units` is zero, `micros` can be positive, zero, or negative.
9292 # If `units` is negative, `micros` must be negative or zero.
9293 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9294 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9295 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9296 #
9297 # Decimal number.
9298 "units": "A String", # Whole units.
9299 "micros": 42, # Micro (10^-6) units.
9300 # The value must be between -999,999 and +999,999 inclusive.
9301 # If `units` is positive, `micros` must be positive or zero.
9302 # If `units` is zero, `micros` can be positive, zero, or negative.
9303 # If `units` is negative, `micros` must be negative or zero.
9304 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9305 },
9306 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9307 "currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9308 # currency code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9309 "annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9310 # the job's base compensation entry cannot be annualized.
9311 # See CompensationEntry for explanation on annualization and base
9312 # compensation entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9313 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9314 #
9315 # At most one entry can be of type
9316 # ExtendedCompensationInfo.CompensationType.BASE, which is
9317 # referred as ** base compensation entry ** for the job.
9318 { # Deprecated. See CompensationInfo.
9319 #
9320 # A compensation entry that represents one component of compensation, such
9321 # as base pay, bonus, or other compensation type.
9322 #
9323 # Annualization: One compensation entry can be annualized if
9324 # - it contains valid amount or range.
9325 # - and its expected_units_per_year is set or can be derived.
9326 # Its annualized range is determined as (amount or range) times
9327 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9328 "description": "A String", # Optional. Compensation description.
9329 "range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9330 #
9331 # Compensation range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9332 "max": { # Deprecated. See CompensationInfo. # Required. Maximum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9333 #
9334 # Decimal number.
9335 "units": "A String", # Whole units.
9336 "micros": 42, # Micro (10^-6) units.
9337 # The value must be between -999,999 and +999,999 inclusive.
9338 # If `units` is positive, `micros` must be positive or zero.
9339 # If `units` is zero, `micros` can be positive, zero, or negative.
9340 # If `units` is negative, `micros` must be negative or zero.
9341 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9342 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9343 "min": { # Deprecated. See CompensationInfo. # Required. Minimum value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9344 #
9345 # Decimal number.
9346 "units": "A String", # Whole units.
9347 "micros": 42, # Micro (10^-6) units.
9348 # The value must be between -999,999 and +999,999 inclusive.
9349 # If `units` is positive, `micros` must be positive or zero.
9350 # If `units` is zero, `micros` can be positive, zero, or negative.
9351 # If `units` is negative, `micros` must be negative or zero.
9352 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9353 },
9354 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9355 "unspecified": True or False, # Optional. Indicates compensation amount and range are unset.
9356 "expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9357 # Job.employment_types is FULLTIME, a default value is inferred
9358 # based on unit. Default values:
9359 # - HOURLY: 2080
9360 # - DAILY: 260
9361 # - WEEKLY: 52
9362 # - MONTHLY: 12
9363 # - ANNUAL: 1
9364 #
9365 # Decimal number.
9366 "units": "A String", # Whole units.
9367 "micros": 42, # Micro (10^-6) units.
9368 # The value must be between -999,999 and +999,999 inclusive.
9369 # If `units` is positive, `micros` must be positive or zero.
9370 # If `units` is zero, `micros` can be positive, zero, or negative.
9371 # If `units` is negative, `micros` must be negative or zero.
9372 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9373 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9374 "amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9375 #
9376 # Decimal number.
9377 "units": "A String", # Whole units.
9378 "micros": 42, # Micro (10^-6) units.
9379 # The value must be between -999,999 and +999,999 inclusive.
9380 # If `units` is positive, `micros` must be positive or zero.
9381 # If `units` is zero, `micros` can be positive, zero, or negative.
9382 # If `units` is negative, `micros` must be negative or zero.
9383 # For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
9384 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9385 "type": "A String", # Required. Compensation type.
9386 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9387 #
9388 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
9389 },
9390 ],
9391 },
9392 "filterableCustomFields": { # Deprecated. Use custom_attributes instead.
9393 #
9394 # Optional.
9395 #
9396 # A map of fields to hold filterable custom job attributes not captured by
9397 # the standard fields such as job_title, company_name, or
9398 # level. These custom fields store arbitrary
9399 # string values, and can be used for purposes not covered by
9400 # the structured fields. For the best search experience, use of the
9401 # structured rather than custom fields is recommended.
9402 #
9403 # Data stored in these custom fields fields are indexed and
9404 # searched against by keyword searches (see
9405 # SearchJobsRequest.custom_field_filters][]).
9406 #
9407 # The map key must be a number between 1-20. If an invalid key is
9408 # provided on job create or update, an error is returned.
9409 "a_key": { # Resource that represents the custom data not captured by the standard fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9410 "values": [ # Optional. The values of the custom data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9411 "A String",
9412 ],
9413 },
9414 },
9415 "expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.
9416 #
9417 # Optional but strongly recommended to be provided for the best service
9418 # experience.
9419 #
9420 # The expiration date of the job in UTC time. After 12 am on this date, the
9421 # job is marked as expired, and it no longer appears in search results.
9422 # The expired job can't be deleted or listed by the DeleteJob and
9423 # ListJobs APIs, but it can be retrieved with the GetJob API or
9424 # updated with the UpdateJob API. An expired job can be updated and
9425 # opened again by using a future expiration date. It can also remain expired.
9426 # Updating an expired job to be open fails if there is another existing open
9427 # job with same requisition_id, company_name and language_code.
9428 #
9429 # The expired jobs are retained in our system for 90 days. However, the
9430 # overall expired job count cannot exceed 3 times the maximum of open jobs
9431 # count over the past week, otherwise jobs with earlier expire time are
9432 # removed first. Expired jobs are no longer accessible after they are cleaned
9433 # out.
9434 #
9435 # A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are
9436 # ignored and treated as expiry date not provided.
9437 #
9438 # If this value is not provided on job creation or is invalid, the job
9439 # posting expires after 30 days from the job's creation time. For example, if
9440 # the job was created on 2017/01/01 13:00AM UTC with an unspecified
9441 # expiration date, the job expires after 2017/01/31 13:00AM UTC.
9442 #
9443 # If this value is not provided on job update, it depends on the field masks
9444 # set by UpdateJobRequest.update_job_fields. If the field masks include
9445 # expiry_date, or the masks are empty meaning that every field is
9446 # updated, the job expires after 30 days from the job's last update time.
9447 # Otherwise the expiration date isn't updated.
9448 # and time zone are either specified elsewhere or are not significant. The date
9449 # is relative to the Proleptic Gregorian Calendar. This can represent:
9450 #
9451 # * A full date, with non-zero year, month and day values
9452 # * A month and day value, with a zero year, e.g. an anniversary
9453 # * A year on its own, with zero month and day values
9454 # * A year and month value, with a zero day, e.g. a credit card expiration date
9455 #
9456 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
9457 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9458 # month and day.
9459 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9460 # if specifying a year by itself or a year and month where the day is not
9461 # significant.
9462 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9463 # a year.
9464 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9465 "responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9466 # recommended as an alternative to using the more general description
9467 # field.
9468 #
9469 # This field accepts and sanitizes HTML input, and also accepts
9470 # bold, italic, ordered list, and unordered list markup tags.
9471 #
9472 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9473 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
9474 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9475 # base compensation entry's CompensationEntry.compensation times
9476 # CompensationEntry.expected_units_per_year.
9477 #
9478 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9479 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9480 # to a maximal compensation value and the currency code is set to
9481 # match the currency code of
9482 # min_compensation.
9483 "nanos": 42, # Number of nano (10^-9) units of the amount.
9484 # The value must be between -999,999,999 and +999,999,999 inclusive.
9485 # If `units` is positive, `nanos` must be positive or zero.
9486 # If `units` is zero, `nanos` can be positive, zero, or negative.
9487 # If `units` is negative, `nanos` must be negative or zero.
9488 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9489 "units": "A String", # The whole units of the amount.
9490 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9491 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9492 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9493 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9494 # to zero and the currency code is set to match the
9495 # currency code of max_compensation.
9496 "nanos": 42, # Number of nano (10^-9) units of the amount.
9497 # The value must be between -999,999,999 and +999,999,999 inclusive.
9498 # If `units` is positive, `nanos` must be positive or zero.
9499 # If `units` is zero, `nanos` can be positive, zero, or negative.
9500 # If `units` is negative, `nanos` must be negative or zero.
9501 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9502 "units": "A String", # The whole units of the amount.
9503 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9504 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9505 },
9506 },
9507 "min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
9508 #
9509 # Optional.
9510 #
9511 # A lower bound on a range for compensation or pay for the job.
9512 # The currency type is specified in compensation_amount.
9513 "nanos": 42, # Number of nano (10^-9) units of the amount.
9514 # The value must be between -999,999,999 and +999,999,999 inclusive.
9515 # If `units` is positive, `nanos` must be positive or zero.
9516 # If `units` is zero, `nanos` can be positive, zero, or negative.
9517 # If `units` is negative, `nanos` must be negative or zero.
9518 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9519 "units": "A String", # The whole units of the amount.
9520 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9521 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9522 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9523 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9524 # all compensation entries' CompensationEntry.compensation times
9525 # CompensationEntry.expected_units_per_year.
9526 #
9527 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9528 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9529 # to a maximal compensation value and the currency code is set to
9530 # match the currency code of
9531 # min_compensation.
9532 "nanos": 42, # Number of nano (10^-9) units of the amount.
9533 # The value must be between -999,999,999 and +999,999,999 inclusive.
9534 # If `units` is positive, `nanos` must be positive or zero.
9535 # If `units` is zero, `nanos` can be positive, zero, or negative.
9536 # If `units` is negative, `nanos` must be negative or zero.
9537 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9538 "units": "A String", # The whole units of the amount.
9539 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9540 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9541 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9542 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9543 # to zero and the currency code is set to match the
9544 # currency code of max_compensation.
9545 "nanos": 42, # Number of nano (10^-9) units of the amount.
9546 # The value must be between -999,999,999 and +999,999,999 inclusive.
9547 # If `units` is positive, `nanos` must be positive or zero.
9548 # If `units` is zero, `nanos` can be positive, zero, or negative.
9549 # If `units` is negative, `nanos` must be negative or zero.
9550 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9551 "units": "A String", # The whole units of the amount.
9552 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9553 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9554 },
9555 },
9556 "max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
9557 #
9558 # Optional.
9559 #
9560 # An upper bound on a range for compensation or pay for the job.
9561 # The currency type is specified in compensation_amount.
9562 "nanos": 42, # Number of nano (10^-9) units of the amount.
9563 # The value must be between -999,999,999 and +999,999,999 inclusive.
9564 # If `units` is positive, `nanos` must be positive or zero.
9565 # If `units` is zero, `nanos` can be positive, zero, or negative.
9566 # If `units` is negative, `nanos` must be negative or zero.
9567 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9568 "units": "A String", # The whole units of the amount.
9569 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9570 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9571 },
9572 "amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.
9573 #
9574 # Optional.
9575 #
9576 # The amount of compensation or pay for the job.
9577 # As an alternative, compensation_amount_min and
9578 # compensation_amount_max may be used to define a range of
9579 # compensation.
9580 "nanos": 42, # Number of nano (10^-9) units of the amount.
9581 # The value must be between -999,999,999 and +999,999,999 inclusive.
9582 # If `units` is positive, `nanos` must be positive or zero.
9583 # If `units` is zero, `nanos` can be positive, zero, or negative.
9584 # If `units` is negative, `nanos` must be negative or zero.
9585 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9586 "units": "A String", # The whole units of the amount.
9587 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9588 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9589 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9590 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9591 #
9592 # At most one entry can be of type
9593 # CompensationInfo.CompensationType.BASE, which is
9594 # referred as ** base compensation entry ** for the job.
9595 { # A compensation entry that represents one component of compensation, such
9596 # as base pay, bonus, or other compensation type.
9597 #
9598 # Annualization: One compensation entry can be annualized if
9599 # - it contains valid amount or range.
9600 # - and its expected_units_per_year is set or can be derived.
9601 # Its annualized range is determined as (amount or range) times
9602 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9603 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9604 # indicate equity terms or provide additional context to an estimated
9605 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9606 "range": { # Compensation range. # Optional. Compensation range.
9607 "max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9608 # to a maximal compensation value and the currency code is set to
9609 # match the currency code of
9610 # min_compensation.
9611 "nanos": 42, # Number of nano (10^-9) units of the amount.
9612 # The value must be between -999,999,999 and +999,999,999 inclusive.
9613 # If `units` is positive, `nanos` must be positive or zero.
9614 # If `units` is zero, `nanos` can be positive, zero, or negative.
9615 # If `units` is negative, `nanos` must be negative or zero.
9616 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9617 "units": "A String", # The whole units of the amount.
9618 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9619 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9620 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9621 "min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9622 # to zero and the currency code is set to match the
9623 # currency code of max_compensation.
9624 "nanos": 42, # Number of nano (10^-9) units of the amount.
9625 # The value must be between -999,999,999 and +999,999,999 inclusive.
9626 # If `units` is positive, `nanos` must be positive or zero.
9627 # If `units` is zero, `nanos` can be positive, zero, or negative.
9628 # If `units` is negative, `nanos` must be negative or zero.
9629 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9630 "units": "A String", # The whole units of the amount.
9631 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9632 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9633 },
9634 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9635 "expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9636 # Job.employment_types is FULLTIME, a default value is inferred
9637 # based on unit. Default values:
9638 # - HOURLY: 2080
9639 # - DAILY: 260
9640 # - WEEKLY: 52
9641 # - MONTHLY: 12
9642 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9643 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9644 "nanos": 42, # Number of nano (10^-9) units of the amount.
9645 # The value must be between -999,999,999 and +999,999,999 inclusive.
9646 # If `units` is positive, `nanos` must be positive or zero.
9647 # If `units` is zero, `nanos` can be positive, zero, or negative.
9648 # If `units` is negative, `nanos` must be negative or zero.
9649 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
9650 "units": "A String", # The whole units of the amount.
9651 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
9652 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
9653 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9654 "type": "A String", # Required. Compensation type.
9655 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9656 #
9657 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
9658 },
9659 ],
9660 "type": "A String", # Deprecated. Use entries instead.
9661 #
9662 # Optional.
9663 #
9664 # Type of job compensation.
9665 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9666 "department": "A String", # Optional. The department or functional area within the company with the open
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9667 # position.
9668 #
9669 # The maximum number of allowed characters is 255.
9670 "applicationInstruction": "A String", # Optional but at least one of application_urls,
9671 # application_email_list or application_instruction must be
9672 # specified.
9673 #
9674 # Use this field to provide instructions, such as "Mail your application
9675 # to ...", that a candidate can follow to apply for the job.
9676 #
9677 # This field accepts and sanitizes HTML input, and also accepts
9678 # bold, italic, ordered list, and unordered list markup tags.
9679 #
9680 # The maximum number of allowed characters is 3,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9681 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
9682 # incentives associated with the job not including salary or pay.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9683 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9684 # The maximum number of allowed characters is 10,000.
9685 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9686 # description of the company and related information. Separate fields are
9687 # provided on the job object for responsibilities,
9688 # qualifications, and other job characteristics. Use of
9689 # these separate job fields is recommended.
9690 #
9691 # This field accepts and sanitizes HTML input, and also accepts
9692 # bold, italic, ordered list, and unordered list markup tags.
9693 #
9694 # The maximum number of allowed characters is 100,000.
9695 "companyName": "A String", # Optional but one of company_name or distributor_company_id must be
9696 # provided.
9697 #
9698 # The resource name of the company listing the job, such as
9699 # /companies/foo. This field takes precedence over the
9700 # distributor-assigned company identifier, distributor_company_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9701 "jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9702 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9703 # The maximum number of allowed characters is 500.
9704 "requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9705 # client to identify a job. This field is intended to be used by clients
9706 # for client identification and tracking of listings. A job is not allowed
9707 # to be created if there is another job with the same requisition_id,
9708 # company_name and language_code.
9709 #
9710 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9711 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9712 # job. The use of this field is recommended
9713 # as an alternative to using the more general description field.
9714 #
9715 # This field accepts and sanitizes HTML input, and also accepts
9716 # bold, italic, ordered list, and unordered list markup tags.
9717 #
9718 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9719 "visibility": "A String", # Optional. The visibility of the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9720 # Defaults to JobVisibility.PRIVATE if not specified.
9721 # Currently only JobVisibility.PRIVATE is supported.
9722 "expireTime": "A String", # Optional but strongly recommended for the best service
9723 # experience.
9724 #
9725 # The expiration timestamp of the job. After this timestamp, the
9726 # job is marked as expired, and it no longer appears in search results. The
9727 # expired job can't be deleted or listed by the DeleteJob and
9728 # ListJobs APIs, but it can be retrieved with the GetJob API or
9729 # updated with the UpdateJob API. An expired job can be updated and
9730 # opened again by using a future expiration timestamp. Updating an expired
9731 # job fails if there is another existing open job with same
9732 # requisition_id, company_name and language_code.
9733 #
9734 # The expired jobs are retained in our system for 90 days. However, the
9735 # overall expired job count cannot exceed 3 times the maximum of open jobs
9736 # count over the past week, otherwise jobs with earlier expire time are
9737 # cleaned first. Expired jobs are no longer accessible after they are cleaned
9738 # out.
9739 # The format of this field is RFC 3339 date strings. Example:
9740 # 2000-01-01T00:00:00.999999999Z
9741 # See
9742 # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
9743 #
9744 # A valid date range is between 1970-01-01T00:00:00.0Z and
9745 # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
9746 # time not provided.
9747 #
9748 # If this value is not provided at the time of job creation or is invalid,
9749 # the job posting expires after 30 days from the job's creation time. For
9750 # example, if the job was created on 2017/01/01 13:00AM UTC with an
9751 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
9752 #
9753 # If this value is not provided but expiry_date is, expiry_date is
9754 # used.
9755 #
9756 # If this value is not provided on job update, it depends on the field masks
9757 # set by UpdateJobRequest.update_job_fields. If the field masks include
9758 # expiry_time, or the masks are empty meaning that every field is
9759 # updated, the job posting expires after 30 days from the job's last
9760 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9761 "publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9762 # value is the time the request arrives at the server.
9763 # and time zone are either specified elsewhere or are not significant. The date
9764 # is relative to the Proleptic Gregorian Calendar. This can represent:
9765 #
9766 # * A full date, with non-zero year, month and day values
9767 # * A month and day value, with a zero year, e.g. an anniversary
9768 # * A year on its own, with zero month and day values
9769 # * A year and month value, with a zero day, e.g. a credit card expiration date
9770 #
9771 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
9772 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9773 # month and day.
9774 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9775 # if specifying a year by itself or a year and month where the day is not
9776 # significant.
9777 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9778 # a year.
9779 },
9780 "applicationEmailList": [ # Optional but at least one of application_urls,
9781 # application_email_list or application_instruction must be
9782 # specified.
9783 #
9784 # Use this field to specify email address(es) to which resumes or
9785 # applications can be sent.
9786 #
9787 # The maximum number of allowed characters is 255.
9788 "A String",
9789 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9790 "createTime": "A String", # Output only. The timestamp when this job was created.
9791 "benefits": [ # Optional. The benefits included with the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9792 "A String",
9793 ],
9794 "name": "A String", # Required during job update.
9795 #
9796 # Resource name assigned to a job by the API, for example, "/jobs/foo". Use
9797 # of this field in job queries and API calls is preferred over the use of
9798 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9799 "level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9800 "companyTitle": "A String", # Deprecated. Use company_display_name instead.
9801 #
9802 # Output only.
9803 #
9804 # The name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9805 "region": "A String", # Optional. The job Region (for example, state, country) throughout which the job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9806 # is available. If this field is set, a
9807 # LocationFilter in a search query within the job region
9808 # finds this job if an exact location match is not specified.
9809 # If this field is set, setting job locations
9810 # to the same location level as this field is strongly recommended.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9811 "promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9812 # The value determines the sort order of the jobs returned when searching for
9813 # jobs using the featured jobs search call, with higher promotional values
9814 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9815 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9816 #
9817 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9818 "referenceUrl": "A String", # Output only. The URL of a web page that displays job details.
9819 "customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9820 # attributes that are not covered by the provided structured fields.
9821 #
9822 # This field is a more general combination of the deprecated id-based
9823 # filterable_custom_fields and string-based
9824 # non_filterable_custom_fields.
9825 #
9826 # The keys of the map are strings up to 64 bytes and must match the
9827 # pattern: a-zA-Z*.
9828 #
9829 # At most 100 filterable and at most 100 unfilterable keys are supported.
9830 # For filterable `string_values`, across all keys at most 200 values are
9831 # allowed, with each string no more than 255 characters. For unfilterable
9832 # `string_values`, the maximum total size of `string_values` across all keys
9833 # is 50KB.
9834 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9835 "filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9836 # If false, values are not searchable.
9837 #
9838 # Default is false.
9839 "stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must
9840 # be specified.
9841 #
9842 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
9843 # `CASE_INSENSITIVE_MATCH`) search.
9844 # For filterable `string_values`, a maximum total number of 200 values
9845 # is allowed, with each `string_value` has a byte size of no more than
9846 # 255B. For unfilterable `string_values`, the maximum total byte size of
9847 # unfilterable `string_values` is 50KB.
9848 #
9849 # Empty strings are not allowed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9850 "values": [ # Required. String values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9851 "A String",
9852 ],
9853 },
9854 "longValue": "A String", # Optional but at least one of string_values or long_value must
9855 # be specified.
9856 #
9857 # This field is used to perform number range search.
9858 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For
9859 # `long_value`, a value between Long.MIN and Long.MAX is allowed.
9860 },
9861 },
9862 "distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be
9863 # provided.
9864 #
9865 # A unique company identifier used by job distributors to identify an
9866 # employer's company entity. company_name takes precedence over
9867 # this field, and is the recommended field to use to identify companies.
9868 #
9869 # The maximum number of allowed characters is 255.
9870 },
9871 "commuteInfo": { # Output only. # Commute information which is generated based on specified
9872 # CommutePreference.
9873 #
9874 # Commute details related to this job.
9875 "travelDuration": "A String", # The number of seconds required to travel to the job location from the query
9876 # location. A duration of 0 seconds indicates that the job is not
9877 # reachable within the requested duration, but was returned as part of an
9878 # expanded query.
9879 "jobLocation": { # Output only. # Location used as the destination in the commute calculation.
9880 #
9881 # A resource that represents a location with full geographic
9882 # information.
9883 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
9884 # location bounding box in which a circle with the specified radius
9885 # centered from LatLng coves the area associated with the job location.
9886 # For example, currently, "Mountain View, CA, USA" has a radius of
9887 # 7885.79 meters.
9888 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
9889 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
9890 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
9891 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9892 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
9893 # of doubles representing degrees latitude and degrees longitude. Unless
9894 # specified otherwise, this must conform to the
9895 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
9896 # standard&lt;/a&gt;. Values must be within normalized ranges.
9897 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
9898 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
9899 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9900 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
9901 # such as postal delivery and payments addresses. Given a postal address,
9902 # a postal service can deliver items to a premises, P.O. Box, or other
9903 # delivery location.
9904 # Given a postal address, a postal service can deliver items to a premise, P.O.
9905 # Box or similar.
9906 # It is not intended to model geographical locations (roads, towns,
9907 # mountains).
9908 #
9909 # In typical usage an address would be created via user input or from importing
9910 # existing data, depending on the type of process.
9911 #
9912 # Advice on address input / editing:
9913 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9914 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9915 # - Users should not be presented with UI elements for input or editing of
9916 # fields outside countries where that field is used.
9917 #
9918 # For more guidance on how to use this schema, please see:
9919 # https://support.google.com/business/answer/6397478
9920 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
9921 # known). This is often the UI language of the input form or is expected
9922 # to match one of the languages used in the address' country/region, or their
9923 # transliterated equivalents.
9924 # This can affect formatting in certain countries, but is not critical
9925 # to the correctness of the data and will never affect any validation or
9926 # other non-formatting related operations.
9927 #
9928 # If this value is not known, it should be omitted (rather than specifying a
9929 # possibly incorrect default).
9930 #
9931 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
9932 "recipients": [ # Optional. The recipient at the address.
9933 # This field may, under certain circumstances, contain multiline information.
9934 # For example, it might contain "care of" information.
9935 "A String",
9936 ],
9937 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
9938 # Examples: US city, IT comune, UK post town.
9939 # In regions of the world where localities are not well defined or do not fit
9940 # into this structure well, leave locality empty and use address_lines.
9941 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
9942 # in most regions. Where it is used, the value is either a string like
9943 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
9944 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
9945 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
9946 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
9947 # is never inferred and it is up to the user to ensure the value is
9948 # correct. See http://cldr.unicode.org/ and
9949 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
9950 # for details. Example: "CH" for Switzerland.
9951 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
9952 # addresses of a country or region.
9953 # For example, this can be a state, a province, an oblast, or a prefecture.
9954 # Specifically, for Spain this is the province and not the autonomous
9955 # community (e.g. "Barcelona" and not "Catalonia").
9956 # Many countries don't use an administrative area in postal addresses. E.g.
9957 # in Switzerland this should be left unpopulated.
9958 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
9959 #
9960 # Because values in address_lines do not have type information and may
9961 # sometimes contain multiple values in a single field (e.g.
9962 # "Austin, TX"), it is important that the line order is clear. The order of
9963 # address lines should be "envelope order" for the country/region of the
9964 # address. In places where this can vary (e.g. Japan), address_language is
9965 # used to make it explicit (e.g. "ja" for large-to-small ordering and
9966 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
9967 # an address can be selected based on the language.
9968 #
9969 # The minimum permitted structural representation of an address consists
9970 # of a region_code with all remaining information placed in the
9971 # address_lines. It would be possible to format such an address very
9972 # approximately without geocoding, but no semantic reasoning could be
9973 # made about any of the address components until it was at least
9974 # partially resolved.
9975 #
9976 # Creating an address only containing a region_code and address_lines, and
9977 # then geocoding is the recommended way to handle completely unstructured
9978 # addresses (as opposed to guessing which parts of the address should be
9979 # localities or administrative areas).
9980 "A String",
9981 ],
9982 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
9983 # postal codes to be present, but where they are used, they may trigger
9984 # additional validation with other parts of the address (e.g. state/zip
9985 # validation in the U.S.A.).
9986 "organization": "A String", # Optional. The name of the organization at the address.
9987 "sublocality": "A String", # Optional. Sublocality of the address.
9988 # For example, this can be neighborhoods, boroughs, districts.
9989 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
9990 # the latest revision.
9991 #
9992 # All new revisions **must** be backward compatible with old revisions.
9993 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9994 },
9995 },
9996 "jobSummary": "A String", # A summary of the job with core information that's displayed on the search
9997 # results listing page.
9998 "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most
9999 # closely matching a search query's keywords, if available. The matching
10000 # query keywords are enclosed in HTML bold tags.
10001 },
10002 ],
10003 "numJobsFromBroadenedQuery": 42, # If query broadening is enabled, we may append additional results from the
10004 # broadened query. This number indicates how many of the jobs returned in the
10005 # jobs field are from the broadened query. These results are always at the
10006 # end of the jobs list. In particular, a value of 0 means all the jobs in the
10007 # jobs list are from the original (without broadening) query. If this
10008 # field is non-zero, subsequent requests with offset after this result set
10009 # should contain all broadened results.
10010 "appliedJobLocationFilters": [ # The location filters that the service applied to the specified query. If
10011 # any filters are lat-lng based, the JobLocation.location_type is
10012 # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.
10013 { # Output only.
10014 #
10015 # A resource that represents a location with full geographic
10016 # information.
10017 "radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the
10018 # location bounding box in which a circle with the specified radius
10019 # centered from LatLng coves the area associated with the job location.
10020 # For example, currently, "Mountain View, CA, USA" has a radius of
10021 # 7885.79 meters.
10022 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
10023 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
10024 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
10025 # LocationType#LOCALITY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10026 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
10027 # of doubles representing degrees latitude and degrees longitude. Unless
10028 # specified otherwise, this must conform to the
10029 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
10030 # standard&lt;/a&gt;. Values must be within normalized ranges.
10031 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
10032 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
10033 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10034 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
10035 # such as postal delivery and payments addresses. Given a postal address,
10036 # a postal service can deliver items to a premises, P.O. Box, or other
10037 # delivery location.
10038 # Given a postal address, a postal service can deliver items to a premise, P.O.
10039 # Box or similar.
10040 # It is not intended to model geographical locations (roads, towns,
10041 # mountains).
10042 #
10043 # In typical usage an address would be created via user input or from importing
10044 # existing data, depending on the type of process.
10045 #
10046 # Advice on address input / editing:
10047 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10048 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10049 # - Users should not be presented with UI elements for input or editing of
10050 # fields outside countries where that field is used.
10051 #
10052 # For more guidance on how to use this schema, please see:
10053 # https://support.google.com/business/answer/6397478
10054 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
10055 # known). This is often the UI language of the input form or is expected
10056 # to match one of the languages used in the address' country/region, or their
10057 # transliterated equivalents.
10058 # This can affect formatting in certain countries, but is not critical
10059 # to the correctness of the data and will never affect any validation or
10060 # other non-formatting related operations.
10061 #
10062 # If this value is not known, it should be omitted (rather than specifying a
10063 # possibly incorrect default).
10064 #
10065 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
10066 "recipients": [ # Optional. The recipient at the address.
10067 # This field may, under certain circumstances, contain multiline information.
10068 # For example, it might contain "care of" information.
10069 "A String",
10070 ],
10071 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
10072 # Examples: US city, IT comune, UK post town.
10073 # In regions of the world where localities are not well defined or do not fit
10074 # into this structure well, leave locality empty and use address_lines.
10075 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
10076 # in most regions. Where it is used, the value is either a string like
10077 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
10078 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
10079 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
10080 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
10081 # is never inferred and it is up to the user to ensure the value is
10082 # correct. See http://cldr.unicode.org/ and
10083 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
10084 # for details. Example: "CH" for Switzerland.
10085 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
10086 # addresses of a country or region.
10087 # For example, this can be a state, a province, an oblast, or a prefecture.
10088 # Specifically, for Spain this is the province and not the autonomous
10089 # community (e.g. "Barcelona" and not "Catalonia").
10090 # Many countries don't use an administrative area in postal addresses. E.g.
10091 # in Switzerland this should be left unpopulated.
10092 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
10093 #
10094 # Because values in address_lines do not have type information and may
10095 # sometimes contain multiple values in a single field (e.g.
10096 # "Austin, TX"), it is important that the line order is clear. The order of
10097 # address lines should be "envelope order" for the country/region of the
10098 # address. In places where this can vary (e.g. Japan), address_language is
10099 # used to make it explicit (e.g. "ja" for large-to-small ordering and
10100 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
10101 # an address can be selected based on the language.
10102 #
10103 # The minimum permitted structural representation of an address consists
10104 # of a region_code with all remaining information placed in the
10105 # address_lines. It would be possible to format such an address very
10106 # approximately without geocoding, but no semantic reasoning could be
10107 # made about any of the address components until it was at least
10108 # partially resolved.
10109 #
10110 # Creating an address only containing a region_code and address_lines, and
10111 # then geocoding is the recommended way to handle completely unstructured
10112 # addresses (as opposed to guessing which parts of the address should be
10113 # localities or administrative areas).
10114 "A String",
10115 ],
10116 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
10117 # postal codes to be present, but where they are used, they may trigger
10118 # additional validation with other parts of the address (e.g. state/zip
10119 # validation in the U.S.A.).
10120 "organization": "A String", # Optional. The name of the organization at the address.
10121 "sublocality": "A String", # Optional. Sublocality of the address.
10122 # For example, this can be neighborhoods, boroughs, districts.
10123 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
10124 # the latest revision.
10125 #
10126 # All new revisions **must** be backward compatible with old revisions.
10127 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10128 },
10129 ],
10130 "histogramResults": { # Output only. # The histogram results that match specified
10131 # SearchJobsRequest.HistogramFacets.
10132 #
10133 # Histogram results that matches HistogramFacets specified in
10134 # SearchJobsRequest.
10135 "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that
10136 # matches HistogramFacets.custom_attribute_histogram_facets.
10137 { # Output only.
10138 #
10139 # Custom attribute histogram result.
10140 "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for
10141 # custom attribute long values associated with `key`.
10142 #
10143 # Custom numeric bucketing result.
10144 "counts": [ # Count within each bucket. Its size is the length of
10145 # NumericBucketingOption.bucket_bounds plus 1.
10146 { # Represents count of jobs within one bucket.
10147 "count": 42, # Number of jobs whose numeric field value fall into `range`.
10148 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
10149 # that is, the count represents number of jobs in this range.
10150 "to": 3.14, # Ending value of the bucket range.
10151 "from": 3.14, # Starting value of the bucket range.
10152 },
10153 },
10154 ],
10155 "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if
10156 # [NumericBucketingOption.requires_min_max] is set to true.
10157 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
10158 # [NumericBucketingOption.requires_min_max] is set to true.
10159 },
10160 "stringValueHistogramResult": { # Stores a map from the values of string custom field associated
10161 # with `key` to the number of jobs with that value in this histogram result.
10162 "a_key": 42,
10163 },
10164 "key": "A String", # Stores the key of custom attribute the histogram is performed on.
10165 },
10166 ],
10167 "simpleHistogramResults": [ # Specifies histogram results that matches
10168 # HistogramFacets.simple_histogram_facets.
10169 { # Output only.
10170 #
10171 # Result of a histogram call. The response contains the histogram map for the
10172 # search type specified by HistogramResult.field.
10173 # The response is a map of each filter value to the corresponding count of
10174 # jobs for that filter.
10175 "values": { # A map from the values of field to the number of jobs with that value
10176 # in this search result.
10177 #
10178 # Key: search type (filter names, such as the companyName).
10179 #
10180 # Values: the count of jobs that match the filter for this search.
10181 "a_key": 42,
10182 },
10183 "searchType": "A String", # The Histogram search filters.
10184 },
10185 ],
10186 "compensationHistogramResults": [ # Specifies compensation field-based histogram results that matches
10187 # HistogramFacets.compensation_histogram_requests.
10188 { # Output only.
10189 #
10190 # Compensation based histogram result.
10191 "type": "A String", # Type of the request, corresponding to
10192 # CompensationHistogramRequest.type.
10193 "result": { # Output only. # Histogram result.
10194 #
10195 # Custom numeric bucketing result.
10196 "counts": [ # Count within each bucket. Its size is the length of
10197 # NumericBucketingOption.bucket_bounds plus 1.
10198 { # Represents count of jobs within one bucket.
10199 "count": 42, # Number of jobs whose numeric field value fall into `range`.
10200 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
10201 # that is, the count represents number of jobs in this range.
10202 "to": 3.14, # Ending value of the bucket range.
10203 "from": 3.14, # Starting value of the bucket range.
10204 },
10205 },
10206 ],
10207 "maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if
10208 # [NumericBucketingOption.requires_min_max] is set to true.
10209 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
10210 # [NumericBucketingOption.requires_min_max] is set to true.
10211 },
10212 },
10213 ],
10214 },
10215 "jobView": "A String", # Corresponds to SearchJobsRequest.job_view.
10216 "appliedCommuteFilter": { # Input only. # The commute filter the service applied to the specified query. This
10217 # information is only available when query has a valid CommutePreference.
10218 #
10219 # Parameters needed for commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10220 "departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10221 # integer between 0 and 23, representing the hour in the time zone of the
10222 # start_location. Must not be present if road_traffic is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10223 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10224 # Must not be present if departure_hour_local is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10225 "allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10226 # For city level addresses, the city center is used. For state and coarser
10227 # level addresses, text matching is used.
10228 # If this field is set to `false` or is not specified, only jobs that include
10229 # street level addresses will be returned by commute search.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10230 "method": "A String", # Required. The method of transportation for which to calculate the commute time.
10231 "startLocation": { # 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10232 # commute time.
10233 # of doubles representing degrees latitude and degrees longitude. Unless
10234 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10235 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
10236 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10237 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
10238 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
10239 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10240 "travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
10241 # (one hour). Format is `123s`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10242 },
10243 "spellResult": { # Output only. # The spell checking result, and correction.
10244 #
10245 # Spell check result.
10246 "corrected": True or False, # Indicates if the query was corrected by the spell checker.
10247 "correctedText": "A String", # Correction output consisting of the corrected keyword string.
10248 },
10249 "metadata": { # Output only. # Additional information for the API invocation, such as the request
10250 # tracking id.
10251 #
10252 # Additional information returned to client, such as debugging
10253 # information.
10254 "requestId": "A String", # A unique id associated with this call.
10255 # This id is logged for tracking purposes.
10256 "experimentIdList": [ # Identifiers for the versions of the search algorithm used during
10257 # this API invocation if multiple algorithms are used.
10258 # The default value is empty.
10259 # For search response only.
10260 42,
10261 ],
10262 "mode": "A String", # For search response only. Indicates the mode of a performed search.
10263 },
10264 }</pre>
10265</div>
10266
10267<div class="method">
10268 <code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code>
10269 <pre>Retrieves the next page of results.
10270
10271Args:
10272 previous_request: The request for the previous page. (required)
10273 previous_response: The response from the request for the previous page. (required)
10274
10275Returns:
10276 A request object that you can call 'execute()' on to request the next
10277 page. Returns None if there are no more items in the collection.
10278 </pre>
10279</div>
10280
10281<div class="method">
10282 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
10283 <pre>Retrieves the next page of results.
10284
10285Args:
10286 previous_request: The request for the previous page. (required)
10287 previous_response: The response from the request for the previous page. (required)
10288
10289Returns:
10290 A request object that you can call 'execute()' on to request the next
10291 page. Returns None if there are no more items in the collection.
10292 </pre>
10293</div>
10294
10295</body></html>