Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / jobs_v3.projects.jobs.html
blob: aaa6b1f87238aa62a36cc21a1efe27ab91d4371b [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_v3.html">Cloud Talent Solution API</a> . <a href="jobs_v3.projects.html">projects</a> . <a href="jobs_v3.projects.jobs.html">jobs</a></h1>
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(parent, 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 Jobs 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(parent, 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)</a></code></p>
85<p class="firstline">Deletes the specified job.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves the specified job, whose status is OPEN or recently EXPIRED</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, jobView=None, filter=None)</a></code></p>
91<p class="firstline">Lists jobs by filter.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <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]97<p class="firstline">Updates specified job.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#search">search(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>
104<p class="toc_element">
105 <code><a href="#searchForAlert_next">searchForAlert_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
109<p class="firstline">Retrieves the next page of results.</p>
110<h3>Method Details</h3>
111<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 <pre>Deletes a list of Jobs by filter.
114
115Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116 parent: string, Required. The resource name of the project under which the job is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117
118The format is "projects/{project_id}", for example,
119"projects/api-test-project". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 The object takes the form of:
122
123{ # Input only.
124 #
125 # Batch delete jobs request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 "filter": "A String", # Required. The filter string specifies the jobs to be deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 #
128 # Supported operator: =, AND
129 #
130 # The fields eligible for filtering are:
131 #
132 # * `companyName` (Required)
133 # * `requisitionId` (Required)
134 #
135 # Sample Query: companyName = "projects/api-test-project/companies/123" AND
136 # requisitionId = "req-1"
137 }
138
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # A generic empty message that you can re-use to avoid defining duplicated
148 # empty messages in your APIs. A typical example is to use it as the request
149 # or the response type of an API method. For instance:
150 #
151 # service Foo {
152 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
153 # }
154 #
155 # The JSON representation for `Empty` is empty JSON object `{}`.
156 }</pre>
157</div>
158
159<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 <pre>Creates a new job.
162
163Typically, the job becomes searchable within 10 seconds, but it may take
164up to 5 minutes.
165
166Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 parent: string, Required. The resource name of the project under which the job is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168
169The format is "projects/{project_id}", for example,
170"projects/api-test-project". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]171 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 The object takes the form of:
173
174{ # Input only.
175 #
176 # Create job request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "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]178 # or "job requisition"). A job belongs to a Company, which is the hiring
179 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 "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]181 # any requirements for fluency that are associated with the job.
182 #
183 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
184 # For more information, see
185 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
186 # class="external" target="_blank" }.
187 #
188 # If this field is unspecified and Job.description is present, detected
189 # language code based on Job.description is assigned, otherwise
190 # defaults to 'en_US'.
191 "addresses": [ # Optional but strongly recommended for the best service experience.
192 #
193 # Location(s) where the employer is looking to hire for this job posting.
194 #
195 # Specifying the full street address(es) of the hiring location enables
196 # better API results, especially job searches by commute time.
197 #
198 # At most 50 locations are allowed for best search performance. If a job has
199 # more locations, it is suggested to split it into multiple jobs with unique
200 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
201 # multiple jobs with the same company_name, language_code and
202 # requisition_id are not allowed. If the original requisition_id must
203 # be preserved, a custom field should be used for storage. It is also
204 # suggested to group the locations that close to each other in the same job
205 # for better search experience.
206 #
207 # The maximum number of allowed characters is 500.
208 "A String",
209 ],
210 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]211 "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]212 # The value determines the sort order of the jobs returned when searching for
213 # jobs using the featured jobs search call, with higher promotional values
214 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]215 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 #
217 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]218 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 # full time or
220 # part time.
221 "A String",
222 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]223 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227 # Job application information.
228 "instruction": "A String", # Optional but at least one of uris,
229 # emails or instruction must be
230 # specified.
231 #
232 # Use this field to provide instructions, such as "Mail your application
233 # to ...", that a candidate can follow to apply for the job.
234 #
235 # This field accepts and sanitizes HTML input, and also accepts
236 # bold, italic, ordered list, and unordered list markup tags.
237 #
238 # The maximum number of allowed characters is 3,000.
239 "uris": [ # Optional but at least one of uris,
240 # emails or instruction must be
241 # specified.
242 #
243 # Use this URI field to direct an applicant to a website, for example to
244 # link to an online application form.
245 #
246 # The maximum number of allowed characters for each entry is 2,000.
247 "A String",
248 ],
249 "emails": [ # Optional but at least one of uris,
250 # emails or instruction must be
251 # specified.
252 #
253 # Use this field to specify email address(es) to which resumes or
254 # applications can be sent.
255 #
256 # The maximum number of allowed characters for each entry is 255.
257 "A String",
258 ],
259 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
261 # experience.
262 #
263 # The expiration timestamp of the job. After this timestamp, the
264 # job is marked as expired, and it no longer appears in search results. The
265 # expired job can't be deleted or listed by the DeleteJob and
266 # ListJobs APIs, but it can be retrieved with the GetJob API or
267 # updated with the UpdateJob API. An expired job can be updated and
268 # opened again by using a future expiration timestamp. Updating an expired
269 # job fails if there is another existing open job with same company_name,
270 # language_code and requisition_id.
271 #
272 # The expired jobs are retained in our system for 90 days. However, the
273 # overall expired job count cannot exceed 3 times the maximum of open jobs
274 # count over the past week, otherwise jobs with earlier expire time are
275 # cleaned first. Expired jobs are no longer accessible after they are cleaned
276 # out.
277 #
278 # Invalid timestamps are ignored, and treated as expire time not provided.
279 #
280 # Timestamp before the instant request is made is considered valid, the job
281 # will be treated as expired immediately.
282 #
283 # If this value is not provided at the time of job creation or is invalid,
284 # the job posting expires after 30 days from the job's creation time. For
285 # example, if the job was created on 2017/01/01 13:00AM UTC with an
286 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
287 #
288 # If this value is not provided on job update, it depends on the field masks
289 # set by UpdateJobRequest.update_mask. If the field masks include
290 # expiry_time, or the masks are empty meaning that every field is
291 # updated, the job posting expires after 30 days from the job's last
292 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]293 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 #
295 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]296 "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]297 # recommended as an alternative to using the more general description
298 # field.
299 #
300 # This field accepts and sanitizes HTML input, and also accepts
301 # bold, italic, ordered list, and unordered list markup tags.
302 #
303 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
308 # all compensation entries' CompensationEntry.compensation times
309 # CompensationEntry.expected_units_per_year.
310 #
311 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312 "minCompensation": { # 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]313 # to zero and the currency code is set to match the
314 # currency code of max_compensation.
315 "nanos": 42, # Number of nano (10^-9) units of the amount.
316 # The value must be between -999,999,999 and +999,999,999 inclusive.
317 # If `units` is positive, `nanos` must be positive or zero.
318 # If `units` is zero, `nanos` can be positive, zero, or negative.
319 # If `units` is negative, `nanos` must be negative or zero.
320 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
321 "units": "A String", # The whole units of the amount.
322 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
323 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
324 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]325 "maxCompensation": { # 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]326 # to a maximal compensation value and the currency code is set to
327 # match the currency code of
328 # min_compensation.
329 "nanos": 42, # Number of nano (10^-9) units of the amount.
330 # The value must be between -999,999,999 and +999,999,999 inclusive.
331 # If `units` is positive, `nanos` must be positive or zero.
332 # If `units` is zero, `nanos` can be positive, zero, or negative.
333 # If `units` is negative, `nanos` must be negative or zero.
334 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
335 "units": "A String", # The whole units of the amount.
336 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
337 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
338 },
339 },
340 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
341 # base compensation entry's CompensationEntry.compensation times
342 # CompensationEntry.expected_units_per_year.
343 #
344 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]345 "minCompensation": { # 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]346 # to zero and the currency code is set to match the
347 # currency code of max_compensation.
348 "nanos": 42, # Number of nano (10^-9) units of the amount.
349 # The value must be between -999,999,999 and +999,999,999 inclusive.
350 # If `units` is positive, `nanos` must be positive or zero.
351 # If `units` is zero, `nanos` can be positive, zero, or negative.
352 # If `units` is negative, `nanos` must be negative or zero.
353 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
354 "units": "A String", # The whole units of the amount.
355 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
356 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
357 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358 "maxCompensation": { # 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]359 # to a maximal compensation value and the currency code is set to
360 # match the currency code of
361 # min_compensation.
362 "nanos": 42, # Number of nano (10^-9) units of the amount.
363 # The value must be between -999,999,999 and +999,999,999 inclusive.
364 # If `units` is positive, `nanos` must be positive or zero.
365 # If `units` is zero, `nanos` can be positive, zero, or negative.
366 # If `units` is negative, `nanos` must be negative or zero.
367 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
368 "units": "A String", # The whole units of the amount.
369 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
370 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
371 },
372 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]373 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 #
375 # At most one entry can be of type
376 # CompensationInfo.CompensationType.BASE, which is
377 # referred as ** base compensation entry ** for the job.
378 { # A compensation entry that represents one component of compensation, such
379 # as base pay, bonus, or other compensation type.
380 #
381 # Annualization: One compensation entry can be annualized if
382 # - it contains valid amount or range.
383 # - and its expected_units_per_year is set or can be derived.
384 # Its annualized range is determined as (amount or range) times
385 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]386 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 # indicate equity terms or provide additional context to an estimated
388 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 "range": { # Compensation range. # Optional. Compensation range.
390 "minCompensation": { # 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]391 # to zero and the currency code is set to match the
392 # currency code of max_compensation.
393 "nanos": 42, # Number of nano (10^-9) units of the amount.
394 # The value must be between -999,999,999 and +999,999,999 inclusive.
395 # If `units` is positive, `nanos` must be positive or zero.
396 # If `units` is zero, `nanos` can be positive, zero, or negative.
397 # If `units` is negative, `nanos` must be negative or zero.
398 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
399 "units": "A String", # The whole units of the amount.
400 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
401 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
402 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]403 "maxCompensation": { # 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]404 # to a maximal compensation value and the currency code is set to
405 # match the currency code of
406 # min_compensation.
407 "nanos": 42, # Number of nano (10^-9) units of the amount.
408 # The value must be between -999,999,999 and +999,999,999 inclusive.
409 # If `units` is positive, `nanos` must be positive or zero.
410 # If `units` is zero, `nanos` can be positive, zero, or negative.
411 # If `units` is negative, `nanos` must be negative or zero.
412 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
413 "units": "A String", # The whole units of the amount.
414 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
415 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
416 },
417 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 "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]419 # Job.employment_types is FULLTIME, a default value is inferred
420 # based on unit. Default values:
421 # - HOURLY: 2080
422 # - DAILY: 260
423 # - WEEKLY: 52
424 # - MONTHLY: 12
425 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]426 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]427 "nanos": 42, # Number of nano (10^-9) units of the amount.
428 # The value must be between -999,999,999 and +999,999,999 inclusive.
429 # If `units` is positive, `nanos` must be positive or zero.
430 # If `units` is zero, `nanos` can be positive, zero, or negative.
431 # If `units` is negative, `nanos` must be negative or zero.
432 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
433 "units": "A String", # The whole units of the amount.
434 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
435 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
436 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]437 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 #
439 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]440 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 #
442 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
443 },
444 ],
445 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]446 "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]447 # position.
448 #
449 # The maximum number of allowed characters is 255.
450 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]451 "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]452 # client to identify a job. This field is intended to be used by clients
453 # for client identification and tracking of postings. A job is not allowed
454 # to be created if there is another job with the same [company_name],
455 # language_code and requisition_id.
456 #
457 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]458 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]459 # value is the time the request arrives at the server. Invalid timestamps are
460 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]461 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
462 # description of the company and related information. Separate fields are
463 # provided on the job object for responsibilities,
464 # qualifications, and other job characteristics. Use of
465 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]467 # This field accepts and sanitizes HTML input, and also accepts
468 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]470 # The maximum number of allowed characters is 100,000.
471 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]472 # "projects/api-test-project/companies/foo".
473 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
474 #
475 # Derived details about the job posting.
476 "jobCategories": [ # Job categories derived from Job.title and Job.description.
477 "A String",
478 ],
479 "locations": [ # Structured locations of the job, resolved from Job.addresses.
480 #
481 # locations are exactly matched to Job.addresses in the same
482 # order.
483 { # Output only.
484 #
485 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]486 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
487 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
488 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
489 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
491 # location bounding box in which a circle with the specified radius
492 # centered from LatLng covers the area associated with the job location.
493 # For example, currently, "Mountain View, CA, USA" has a radius of
494 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]495 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
496 # of doubles representing degrees latitude and degrees longitude. Unless
497 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]498 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
499 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
501 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
502 },
503 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
504 # such as postal delivery and payments addresses. Given a postal address,
505 # a postal service can deliver items to a premises, P.O. Box, or other
506 # delivery location.
507 # Given a postal address, a postal service can deliver items to a premise, P.O.
508 # Box or similar.
509 # It is not intended to model geographical locations (roads, towns,
510 # mountains).
511 #
512 # In typical usage an address would be created via user input or from importing
513 # existing data, depending on the type of process.
514 #
515 # Advice on address input / editing:
516 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]517 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]518 # - Users should not be presented with UI elements for input or editing of
519 # fields outside countries where that field is used.
520 #
521 # For more guidance on how to use this schema, please see:
522 # https://support.google.com/business/answer/6397478
523 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
524 # known). This is often the UI language of the input form or is expected
525 # to match one of the languages used in the address' country/region, or their
526 # transliterated equivalents.
527 # This can affect formatting in certain countries, but is not critical
528 # to the correctness of the data and will never affect any validation or
529 # other non-formatting related operations.
530 #
531 # If this value is not known, it should be omitted (rather than specifying a
532 # possibly incorrect default).
533 #
534 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
535 "recipients": [ # Optional. The recipient at the address.
536 # This field may, under certain circumstances, contain multiline information.
537 # For example, it might contain "care of" information.
538 "A String",
539 ],
540 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
541 # Examples: US city, IT comune, UK post town.
542 # In regions of the world where localities are not well defined or do not fit
543 # into this structure well, leave locality empty and use address_lines.
544 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
545 # in most regions. Where it is used, the value is either a string like
546 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
547 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
548 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
549 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
550 # is never inferred and it is up to the user to ensure the value is
551 # correct. See http://cldr.unicode.org/ and
552 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
553 # for details. Example: "CH" for Switzerland.
554 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
555 # addresses of a country or region.
556 # For example, this can be a state, a province, an oblast, or a prefecture.
557 # Specifically, for Spain this is the province and not the autonomous
558 # community (e.g. "Barcelona" and not "Catalonia").
559 # Many countries don't use an administrative area in postal addresses. E.g.
560 # in Switzerland this should be left unpopulated.
561 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
562 #
563 # Because values in address_lines do not have type information and may
564 # sometimes contain multiple values in a single field (e.g.
565 # "Austin, TX"), it is important that the line order is clear. The order of
566 # address lines should be "envelope order" for the country/region of the
567 # address. In places where this can vary (e.g. Japan), address_language is
568 # used to make it explicit (e.g. "ja" for large-to-small ordering and
569 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
570 # an address can be selected based on the language.
571 #
572 # The minimum permitted structural representation of an address consists
573 # of a region_code with all remaining information placed in the
574 # address_lines. It would be possible to format such an address very
575 # approximately without geocoding, but no semantic reasoning could be
576 # made about any of the address components until it was at least
577 # partially resolved.
578 #
579 # Creating an address only containing a region_code and address_lines, and
580 # then geocoding is the recommended way to handle completely unstructured
581 # addresses (as opposed to guessing which parts of the address should be
582 # localities or administrative areas).
583 "A String",
584 ],
585 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
586 # postal codes to be present, but where they are used, they may trigger
587 # additional validation with other parts of the address (e.g. state/zip
588 # validation in the U.S.A.).
589 "organization": "A String", # Optional. The name of the organization at the address.
590 "sublocality": "A String", # Optional. Sublocality of the address.
591 # For example, this can be neighborhoods, boroughs, districts.
592 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
593 # the latest revision.
594 #
595 # All new revisions **must** be backward compatible with old revisions.
596 },
597 },
598 ],
599 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]600 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]601 # job. The use of this field is recommended
602 # as an alternative to using the more general description field.
603 #
604 # This field accepts and sanitizes HTML input, and also accepts
605 # bold, italic, ordered list, and unordered list markup tags.
606 #
607 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]608 "jobBenefits": [ # Optional. The benefits included with the job.
609 "A String",
610 ],
611 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
612 # incentives associated with the job not including salary or pay.
613 #
614 # The maximum number of allowed characters is 10,000.
615 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]616 #
617 # The visibility of the job.
618 #
619 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
620 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]621 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]622 # the job is available. If this field is set, a
623 # LocationFilter in a search query within the job region
624 # finds this job posting if an exact location match isn't specified.
625 # If this field is set to PostingRegion.NATION or
626 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
627 # to the same location level as this field is strongly recommended.
628 "name": "A String", # Required during job update.
629 #
630 # The resource name for the job. This is generated by the service when a
631 # job is created.
632 #
633 # The format is "projects/{project_id}/jobs/{job_id}",
634 # for example, "projects/api-test-project/jobs/1234".
635 #
636 # Use of this field in job queries and API calls is preferred over the use of
637 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]638 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]639 #
640 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]641 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]642 #
643 # * description
644 # * applicationInfo.instruction
645 # * incentives
646 # * qualifications
647 # * responsibilities
648 #
649 # HTML tags in these fields may be stripped if sanitiazation is not
650 # disabled.
651 #
652 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]653 "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]654 # more precise address for the job.
655 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]656 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]657 "A String",
658 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]659 "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]660 # attributes that are not covered by the provided structured fields.
661 #
662 # The keys of the map are strings up to 64 bytes and must match the
663 # pattern: a-zA-Z*. For example, key0LikeThis or
664 # KEY_1_LIKE_THIS.
665 #
666 # At most 100 filterable and at most 100 unfilterable keys are supported.
667 # For filterable `string_values`, across all keys at most 200 values are
668 # allowed, with each string no more than 255 characters. For unfilterable
669 # `string_values`, the maximum total size of `string_values` across all keys
670 # is 50KB.
671 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]672 "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]673 # If false, values are not searchable.
674 #
675 # Default is false.
676 "stringValues": [ # Optional but exactly one of string_values or long_values must
677 # be specified.
678 #
679 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
680 # `CASE_INSENSITIVE_MATCH`) search.
681 # For filterable `string_value`s, a maximum total number of 200 values
682 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]683 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]684 # unfilterable `string_values` is 50KB.
685 #
686 # Empty string is not allowed.
687 "A String",
688 ],
689 "longValues": [ # Optional but exactly one of string_values or long_values must
690 # be specified.
691 #
692 # This field is used to perform number range search.
693 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
694 #
695 # Currently at most 1 long_values is supported.
696 "A String",
697 ],
698 },
699 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]700 "jobLevel": "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]701 },
702 }
703
704 x__xgafv: string, V1 error format.
705 Allowed values
706 1 - v1 error format
707 2 - v2 error format
708
709Returns:
710 An object of the form:
711
712 { # A Job resource represents a job posting (also referred to as a "job listing"
713 # or "job requisition"). A job belongs to a Company, which is the hiring
714 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]715 "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]716 # any requirements for fluency that are associated with the job.
717 #
718 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
719 # For more information, see
720 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
721 # class="external" target="_blank" }.
722 #
723 # If this field is unspecified and Job.description is present, detected
724 # language code based on Job.description is assigned, otherwise
725 # defaults to 'en_US'.
726 "addresses": [ # Optional but strongly recommended for the best service experience.
727 #
728 # Location(s) where the employer is looking to hire for this job posting.
729 #
730 # Specifying the full street address(es) of the hiring location enables
731 # better API results, especially job searches by commute time.
732 #
733 # At most 50 locations are allowed for best search performance. If a job has
734 # more locations, it is suggested to split it into multiple jobs with unique
735 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
736 # multiple jobs with the same company_name, language_code and
737 # requisition_id are not allowed. If the original requisition_id must
738 # be preserved, a custom field should be used for storage. It is also
739 # suggested to group the locations that close to each other in the same job
740 # for better search experience.
741 #
742 # The maximum number of allowed characters is 500.
743 "A String",
744 ],
745 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]746 "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]747 # The value determines the sort order of the jobs returned when searching for
748 # jobs using the featured jobs search call, with higher promotional values
749 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]750 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]751 #
752 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]753 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]754 # full time or
755 # part time.
756 "A String",
757 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]758 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]759 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]760 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]761 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]762 # Job application information.
763 "instruction": "A String", # Optional but at least one of uris,
764 # emails or instruction must be
765 # specified.
766 #
767 # Use this field to provide instructions, such as "Mail your application
768 # to ...", that a candidate can follow to apply for the job.
769 #
770 # This field accepts and sanitizes HTML input, and also accepts
771 # bold, italic, ordered list, and unordered list markup tags.
772 #
773 # The maximum number of allowed characters is 3,000.
774 "uris": [ # Optional but at least one of uris,
775 # emails or instruction must be
776 # specified.
777 #
778 # Use this URI field to direct an applicant to a website, for example to
779 # link to an online application form.
780 #
781 # The maximum number of allowed characters for each entry is 2,000.
782 "A String",
783 ],
784 "emails": [ # Optional but at least one of uris,
785 # emails or instruction must be
786 # specified.
787 #
788 # Use this field to specify email address(es) to which resumes or
789 # applications can be sent.
790 #
791 # The maximum number of allowed characters for each entry is 255.
792 "A String",
793 ],
794 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]795 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
796 # experience.
797 #
798 # The expiration timestamp of the job. After this timestamp, the
799 # job is marked as expired, and it no longer appears in search results. The
800 # expired job can't be deleted or listed by the DeleteJob and
801 # ListJobs APIs, but it can be retrieved with the GetJob API or
802 # updated with the UpdateJob API. An expired job can be updated and
803 # opened again by using a future expiration timestamp. Updating an expired
804 # job fails if there is another existing open job with same company_name,
805 # language_code and requisition_id.
806 #
807 # The expired jobs are retained in our system for 90 days. However, the
808 # overall expired job count cannot exceed 3 times the maximum of open jobs
809 # count over the past week, otherwise jobs with earlier expire time are
810 # cleaned first. Expired jobs are no longer accessible after they are cleaned
811 # out.
812 #
813 # Invalid timestamps are ignored, and treated as expire time not provided.
814 #
815 # Timestamp before the instant request is made is considered valid, the job
816 # will be treated as expired immediately.
817 #
818 # If this value is not provided at the time of job creation or is invalid,
819 # the job posting expires after 30 days from the job's creation time. For
820 # example, if the job was created on 2017/01/01 13:00AM UTC with an
821 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
822 #
823 # If this value is not provided on job update, it depends on the field masks
824 # set by UpdateJobRequest.update_mask. If the field masks include
825 # expiry_time, or the masks are empty meaning that every field is
826 # updated, the job posting expires after 30 days from the job's last
827 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]828 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]829 #
830 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]831 "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]832 # recommended as an alternative to using the more general description
833 # field.
834 #
835 # This field accepts and sanitizes HTML input, and also accepts
836 # bold, italic, ordered list, and unordered list markup tags.
837 #
838 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]839 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]840 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]841 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]842 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
843 # all compensation entries' CompensationEntry.compensation times
844 # CompensationEntry.expected_units_per_year.
845 #
846 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]847 "minCompensation": { # 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]848 # to zero and the currency code is set to match the
849 # currency code of max_compensation.
850 "nanos": 42, # Number of nano (10^-9) units of the amount.
851 # The value must be between -999,999,999 and +999,999,999 inclusive.
852 # If `units` is positive, `nanos` must be positive or zero.
853 # If `units` is zero, `nanos` can be positive, zero, or negative.
854 # If `units` is negative, `nanos` must be negative or zero.
855 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
856 "units": "A String", # The whole units of the amount.
857 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
858 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
859 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]860 "maxCompensation": { # 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]861 # to a maximal compensation value and the currency code is set to
862 # match the currency code of
863 # min_compensation.
864 "nanos": 42, # Number of nano (10^-9) units of the amount.
865 # The value must be between -999,999,999 and +999,999,999 inclusive.
866 # If `units` is positive, `nanos` must be positive or zero.
867 # If `units` is zero, `nanos` can be positive, zero, or negative.
868 # If `units` is negative, `nanos` must be negative or zero.
869 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
870 "units": "A String", # The whole units of the amount.
871 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
872 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
873 },
874 },
875 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
876 # base compensation entry's CompensationEntry.compensation times
877 # CompensationEntry.expected_units_per_year.
878 #
879 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]880 "minCompensation": { # 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]881 # to zero and the currency code is set to match the
882 # currency code of max_compensation.
883 "nanos": 42, # Number of nano (10^-9) units of the amount.
884 # The value must be between -999,999,999 and +999,999,999 inclusive.
885 # If `units` is positive, `nanos` must be positive or zero.
886 # If `units` is zero, `nanos` can be positive, zero, or negative.
887 # If `units` is negative, `nanos` must be negative or zero.
888 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
889 "units": "A String", # The whole units of the amount.
890 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
891 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
892 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]893 "maxCompensation": { # 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]894 # to a maximal compensation value and the currency code is set to
895 # match the currency code of
896 # min_compensation.
897 "nanos": 42, # Number of nano (10^-9) units of the amount.
898 # The value must be between -999,999,999 and +999,999,999 inclusive.
899 # If `units` is positive, `nanos` must be positive or zero.
900 # If `units` is zero, `nanos` can be positive, zero, or negative.
901 # If `units` is negative, `nanos` must be negative or zero.
902 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
903 "units": "A String", # The whole units of the amount.
904 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
905 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
906 },
907 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]908 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]909 #
910 # At most one entry can be of type
911 # CompensationInfo.CompensationType.BASE, which is
912 # referred as ** base compensation entry ** for the job.
913 { # A compensation entry that represents one component of compensation, such
914 # as base pay, bonus, or other compensation type.
915 #
916 # Annualization: One compensation entry can be annualized if
917 # - it contains valid amount or range.
918 # - and its expected_units_per_year is set or can be derived.
919 # Its annualized range is determined as (amount or range) times
920 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]921 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]922 # indicate equity terms or provide additional context to an estimated
923 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]924 "range": { # Compensation range. # Optional. Compensation range.
925 "minCompensation": { # 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]926 # to zero and the currency code is set to match the
927 # currency code of max_compensation.
928 "nanos": 42, # Number of nano (10^-9) units of the amount.
929 # The value must be between -999,999,999 and +999,999,999 inclusive.
930 # If `units` is positive, `nanos` must be positive or zero.
931 # If `units` is zero, `nanos` can be positive, zero, or negative.
932 # If `units` is negative, `nanos` must be negative or zero.
933 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
934 "units": "A String", # The whole units of the amount.
935 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
936 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
937 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]938 "maxCompensation": { # 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]939 # to a maximal compensation value and the currency code is set to
940 # match the currency code of
941 # min_compensation.
942 "nanos": 42, # Number of nano (10^-9) units of the amount.
943 # The value must be between -999,999,999 and +999,999,999 inclusive.
944 # If `units` is positive, `nanos` must be positive or zero.
945 # If `units` is zero, `nanos` can be positive, zero, or negative.
946 # If `units` is negative, `nanos` must be negative or zero.
947 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
948 "units": "A String", # The whole units of the amount.
949 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
950 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
951 },
952 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]953 "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]954 # Job.employment_types is FULLTIME, a default value is inferred
955 # based on unit. Default values:
956 # - HOURLY: 2080
957 # - DAILY: 260
958 # - WEEKLY: 52
959 # - MONTHLY: 12
960 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]961 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]962 "nanos": 42, # Number of nano (10^-9) units of the amount.
963 # The value must be between -999,999,999 and +999,999,999 inclusive.
964 # If `units` is positive, `nanos` must be positive or zero.
965 # If `units` is zero, `nanos` can be positive, zero, or negative.
966 # If `units` is negative, `nanos` must be negative or zero.
967 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
968 "units": "A String", # The whole units of the amount.
969 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
970 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
971 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]972 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]973 #
974 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]975 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]976 #
977 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
978 },
979 ],
980 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]981 "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]982 # position.
983 #
984 # The maximum number of allowed characters is 255.
985 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]986 "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]987 # client to identify a job. This field is intended to be used by clients
988 # for client identification and tracking of postings. A job is not allowed
989 # to be created if there is another job with the same [company_name],
990 # language_code and requisition_id.
991 #
992 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]993 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]994 # value is the time the request arrives at the server. Invalid timestamps are
995 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]996 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
997 # description of the company and related information. Separate fields are
998 # provided on the job object for responsibilities,
999 # qualifications, and other job characteristics. Use of
1000 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1001 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1002 # This field accepts and sanitizes HTML input, and also accepts
1003 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1004 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1005 # The maximum number of allowed characters is 100,000.
1006 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1007 # "projects/api-test-project/companies/foo".
1008 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
1009 #
1010 # Derived details about the job posting.
1011 "jobCategories": [ # Job categories derived from Job.title and Job.description.
1012 "A String",
1013 ],
1014 "locations": [ # Structured locations of the job, resolved from Job.addresses.
1015 #
1016 # locations are exactly matched to Job.addresses in the same
1017 # order.
1018 { # Output only.
1019 #
1020 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1021 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
1022 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
1023 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
1024 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1025 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
1026 # location bounding box in which a circle with the specified radius
1027 # centered from LatLng covers the area associated with the job location.
1028 # For example, currently, "Mountain View, CA, USA" has a radius of
1029 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1030 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
1031 # of doubles representing degrees latitude and degrees longitude. Unless
1032 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1033 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
1034 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1035 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
1036 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
1037 },
1038 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
1039 # such as postal delivery and payments addresses. Given a postal address,
1040 # a postal service can deliver items to a premises, P.O. Box, or other
1041 # delivery location.
1042 # Given a postal address, a postal service can deliver items to a premise, P.O.
1043 # Box or similar.
1044 # It is not intended to model geographical locations (roads, towns,
1045 # mountains).
1046 #
1047 # In typical usage an address would be created via user input or from importing
1048 # existing data, depending on the type of process.
1049 #
1050 # Advice on address input / editing:
1051 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1052 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1053 # - Users should not be presented with UI elements for input or editing of
1054 # fields outside countries where that field is used.
1055 #
1056 # For more guidance on how to use this schema, please see:
1057 # https://support.google.com/business/answer/6397478
1058 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
1059 # known). This is often the UI language of the input form or is expected
1060 # to match one of the languages used in the address' country/region, or their
1061 # transliterated equivalents.
1062 # This can affect formatting in certain countries, but is not critical
1063 # to the correctness of the data and will never affect any validation or
1064 # other non-formatting related operations.
1065 #
1066 # If this value is not known, it should be omitted (rather than specifying a
1067 # possibly incorrect default).
1068 #
1069 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
1070 "recipients": [ # Optional. The recipient at the address.
1071 # This field may, under certain circumstances, contain multiline information.
1072 # For example, it might contain "care of" information.
1073 "A String",
1074 ],
1075 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
1076 # Examples: US city, IT comune, UK post town.
1077 # In regions of the world where localities are not well defined or do not fit
1078 # into this structure well, leave locality empty and use address_lines.
1079 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
1080 # in most regions. Where it is used, the value is either a string like
1081 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
1082 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
1083 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
1084 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
1085 # is never inferred and it is up to the user to ensure the value is
1086 # correct. See http://cldr.unicode.org/ and
1087 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
1088 # for details. Example: "CH" for Switzerland.
1089 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
1090 # addresses of a country or region.
1091 # For example, this can be a state, a province, an oblast, or a prefecture.
1092 # Specifically, for Spain this is the province and not the autonomous
1093 # community (e.g. "Barcelona" and not "Catalonia").
1094 # Many countries don't use an administrative area in postal addresses. E.g.
1095 # in Switzerland this should be left unpopulated.
1096 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
1097 #
1098 # Because values in address_lines do not have type information and may
1099 # sometimes contain multiple values in a single field (e.g.
1100 # "Austin, TX"), it is important that the line order is clear. The order of
1101 # address lines should be "envelope order" for the country/region of the
1102 # address. In places where this can vary (e.g. Japan), address_language is
1103 # used to make it explicit (e.g. "ja" for large-to-small ordering and
1104 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
1105 # an address can be selected based on the language.
1106 #
1107 # The minimum permitted structural representation of an address consists
1108 # of a region_code with all remaining information placed in the
1109 # address_lines. It would be possible to format such an address very
1110 # approximately without geocoding, but no semantic reasoning could be
1111 # made about any of the address components until it was at least
1112 # partially resolved.
1113 #
1114 # Creating an address only containing a region_code and address_lines, and
1115 # then geocoding is the recommended way to handle completely unstructured
1116 # addresses (as opposed to guessing which parts of the address should be
1117 # localities or administrative areas).
1118 "A String",
1119 ],
1120 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
1121 # postal codes to be present, but where they are used, they may trigger
1122 # additional validation with other parts of the address (e.g. state/zip
1123 # validation in the U.S.A.).
1124 "organization": "A String", # Optional. The name of the organization at the address.
1125 "sublocality": "A String", # Optional. Sublocality of the address.
1126 # For example, this can be neighborhoods, boroughs, districts.
1127 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
1128 # the latest revision.
1129 #
1130 # All new revisions **must** be backward compatible with old revisions.
1131 },
1132 },
1133 ],
1134 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1135 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1136 # job. The use of this field is recommended
1137 # as an alternative to using the more general description field.
1138 #
1139 # This field accepts and sanitizes HTML input, and also accepts
1140 # bold, italic, ordered list, and unordered list markup tags.
1141 #
1142 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1143 "jobBenefits": [ # Optional. The benefits included with the job.
1144 "A String",
1145 ],
1146 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
1147 # incentives associated with the job not including salary or pay.
1148 #
1149 # The maximum number of allowed characters is 10,000.
1150 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1151 #
1152 # The visibility of the job.
1153 #
1154 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
1155 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1156 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1157 # the job is available. If this field is set, a
1158 # LocationFilter in a search query within the job region
1159 # finds this job posting if an exact location match isn't specified.
1160 # If this field is set to PostingRegion.NATION or
1161 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
1162 # to the same location level as this field is strongly recommended.
1163 "name": "A String", # Required during job update.
1164 #
1165 # The resource name for the job. This is generated by the service when a
1166 # job is created.
1167 #
1168 # The format is "projects/{project_id}/jobs/{job_id}",
1169 # for example, "projects/api-test-project/jobs/1234".
1170 #
1171 # Use of this field in job queries and API calls is preferred over the use of
1172 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1173 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1174 #
1175 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1176 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1177 #
1178 # * description
1179 # * applicationInfo.instruction
1180 # * incentives
1181 # * qualifications
1182 # * responsibilities
1183 #
1184 # HTML tags in these fields may be stripped if sanitiazation is not
1185 # disabled.
1186 #
1187 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1188 "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]1189 # more precise address for the job.
1190 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1191 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1192 "A String",
1193 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1194 "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]1195 # attributes that are not covered by the provided structured fields.
1196 #
1197 # The keys of the map are strings up to 64 bytes and must match the
1198 # pattern: a-zA-Z*. For example, key0LikeThis or
1199 # KEY_1_LIKE_THIS.
1200 #
1201 # At most 100 filterable and at most 100 unfilterable keys are supported.
1202 # For filterable `string_values`, across all keys at most 200 values are
1203 # allowed, with each string no more than 255 characters. For unfilterable
1204 # `string_values`, the maximum total size of `string_values` across all keys
1205 # is 50KB.
1206 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1207 "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]1208 # If false, values are not searchable.
1209 #
1210 # Default is false.
1211 "stringValues": [ # Optional but exactly one of string_values or long_values must
1212 # be specified.
1213 #
1214 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
1215 # `CASE_INSENSITIVE_MATCH`) search.
1216 # For filterable `string_value`s, a maximum total number of 200 values
1217 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1218 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1219 # unfilterable `string_values` is 50KB.
1220 #
1221 # Empty string is not allowed.
1222 "A String",
1223 ],
1224 "longValues": [ # Optional but exactly one of string_values or long_values must
1225 # be specified.
1226 #
1227 # This field is used to perform number range search.
1228 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
1229 #
1230 # Currently at most 1 long_values is supported.
1231 "A String",
1232 ],
1233 },
1234 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1235 "jobLevel": "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]1236 }</pre>
1237</div>
1238
1239<div class="method">
1240 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
1241 <pre>Deletes the specified job.
1242
1243Typically, the job becomes unsearchable within 10 seconds, but it may take
1244up to 5 minutes.
1245
1246Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1247 name: string, Required. The resource name of the job to be deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1248
1249The format is "projects/{project_id}/jobs/{job_id}",
1250for example, "projects/api-test-project/jobs/1234". (required)
1251 x__xgafv: string, V1 error format.
1252 Allowed values
1253 1 - v1 error format
1254 2 - v2 error format
1255
1256Returns:
1257 An object of the form:
1258
1259 { # A generic empty message that you can re-use to avoid defining duplicated
1260 # empty messages in your APIs. A typical example is to use it as the request
1261 # or the response type of an API method. For instance:
1262 #
1263 # service Foo {
1264 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1265 # }
1266 #
1267 # The JSON representation for `Empty` is empty JSON object `{}`.
1268 }</pre>
1269</div>
1270
1271<div class="method">
1272 <code class="details" id="get">get(name, x__xgafv=None)</code>
1273 <pre>Retrieves the specified job, whose status is OPEN or recently EXPIRED
1274within the last 90 days.
1275
1276Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1277 name: string, Required. The resource name of the job to retrieve.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1278
1279The format is "projects/{project_id}/jobs/{job_id}",
1280for example, "projects/api-test-project/jobs/1234". (required)
1281 x__xgafv: string, V1 error format.
1282 Allowed values
1283 1 - v1 error format
1284 2 - v2 error format
1285
1286Returns:
1287 An object of the form:
1288
1289 { # A Job resource represents a job posting (also referred to as a "job listing"
1290 # or "job requisition"). A job belongs to a Company, which is the hiring
1291 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1292 "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]1293 # any requirements for fluency that are associated with the job.
1294 #
1295 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
1296 # For more information, see
1297 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
1298 # class="external" target="_blank" }.
1299 #
1300 # If this field is unspecified and Job.description is present, detected
1301 # language code based on Job.description is assigned, otherwise
1302 # defaults to 'en_US'.
1303 "addresses": [ # Optional but strongly recommended for the best service experience.
1304 #
1305 # Location(s) where the employer is looking to hire for this job posting.
1306 #
1307 # Specifying the full street address(es) of the hiring location enables
1308 # better API results, especially job searches by commute time.
1309 #
1310 # At most 50 locations are allowed for best search performance. If a job has
1311 # more locations, it is suggested to split it into multiple jobs with unique
1312 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
1313 # multiple jobs with the same company_name, language_code and
1314 # requisition_id are not allowed. If the original requisition_id must
1315 # be preserved, a custom field should be used for storage. It is also
1316 # suggested to group the locations that close to each other in the same job
1317 # for better search experience.
1318 #
1319 # The maximum number of allowed characters is 500.
1320 "A String",
1321 ],
1322 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1323 "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]1324 # The value determines the sort order of the jobs returned when searching for
1325 # jobs using the featured jobs search call, with higher promotional values
1326 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1327 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1328 #
1329 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1330 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1331 # full time or
1332 # part time.
1333 "A String",
1334 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1335 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1336 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1337 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1338 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1339 # Job application information.
1340 "instruction": "A String", # Optional but at least one of uris,
1341 # emails or instruction must be
1342 # specified.
1343 #
1344 # Use this field to provide instructions, such as "Mail your application
1345 # to ...", that a candidate can follow to apply for the job.
1346 #
1347 # This field accepts and sanitizes HTML input, and also accepts
1348 # bold, italic, ordered list, and unordered list markup tags.
1349 #
1350 # The maximum number of allowed characters is 3,000.
1351 "uris": [ # Optional but at least one of uris,
1352 # emails or instruction must be
1353 # specified.
1354 #
1355 # Use this URI field to direct an applicant to a website, for example to
1356 # link to an online application form.
1357 #
1358 # The maximum number of allowed characters for each entry is 2,000.
1359 "A String",
1360 ],
1361 "emails": [ # Optional but at least one of uris,
1362 # emails or instruction must be
1363 # specified.
1364 #
1365 # Use this field to specify email address(es) to which resumes or
1366 # applications can be sent.
1367 #
1368 # The maximum number of allowed characters for each entry is 255.
1369 "A String",
1370 ],
1371 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1372 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
1373 # experience.
1374 #
1375 # The expiration timestamp of the job. After this timestamp, the
1376 # job is marked as expired, and it no longer appears in search results. The
1377 # expired job can't be deleted or listed by the DeleteJob and
1378 # ListJobs APIs, but it can be retrieved with the GetJob API or
1379 # updated with the UpdateJob API. An expired job can be updated and
1380 # opened again by using a future expiration timestamp. Updating an expired
1381 # job fails if there is another existing open job with same company_name,
1382 # language_code and requisition_id.
1383 #
1384 # The expired jobs are retained in our system for 90 days. However, the
1385 # overall expired job count cannot exceed 3 times the maximum of open jobs
1386 # count over the past week, otherwise jobs with earlier expire time are
1387 # cleaned first. Expired jobs are no longer accessible after they are cleaned
1388 # out.
1389 #
1390 # Invalid timestamps are ignored, and treated as expire time not provided.
1391 #
1392 # Timestamp before the instant request is made is considered valid, the job
1393 # will be treated as expired immediately.
1394 #
1395 # If this value is not provided at the time of job creation or is invalid,
1396 # the job posting expires after 30 days from the job's creation time. For
1397 # example, if the job was created on 2017/01/01 13:00AM UTC with an
1398 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
1399 #
1400 # If this value is not provided on job update, it depends on the field masks
1401 # set by UpdateJobRequest.update_mask. If the field masks include
1402 # expiry_time, or the masks are empty meaning that every field is
1403 # updated, the job posting expires after 30 days from the job's last
1404 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1405 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1406 #
1407 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1408 "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]1409 # recommended as an alternative to using the more general description
1410 # field.
1411 #
1412 # This field accepts and sanitizes HTML input, and also accepts
1413 # bold, italic, ordered list, and unordered list markup tags.
1414 #
1415 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1416 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1417 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1418 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1419 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
1420 # all compensation entries' CompensationEntry.compensation times
1421 # CompensationEntry.expected_units_per_year.
1422 #
1423 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1424 "minCompensation": { # 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]1425 # to zero and the currency code is set to match the
1426 # currency code of max_compensation.
1427 "nanos": 42, # Number of nano (10^-9) units of the amount.
1428 # The value must be between -999,999,999 and +999,999,999 inclusive.
1429 # If `units` is positive, `nanos` must be positive or zero.
1430 # If `units` is zero, `nanos` can be positive, zero, or negative.
1431 # If `units` is negative, `nanos` must be negative or zero.
1432 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1433 "units": "A String", # The whole units of the amount.
1434 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1435 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1436 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1437 "maxCompensation": { # 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]1438 # to a maximal compensation value and the currency code is set to
1439 # match the currency code of
1440 # min_compensation.
1441 "nanos": 42, # Number of nano (10^-9) units of the amount.
1442 # The value must be between -999,999,999 and +999,999,999 inclusive.
1443 # If `units` is positive, `nanos` must be positive or zero.
1444 # If `units` is zero, `nanos` can be positive, zero, or negative.
1445 # If `units` is negative, `nanos` must be negative or zero.
1446 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1447 "units": "A String", # The whole units of the amount.
1448 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1449 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1450 },
1451 },
1452 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
1453 # base compensation entry's CompensationEntry.compensation times
1454 # CompensationEntry.expected_units_per_year.
1455 #
1456 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1457 "minCompensation": { # 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]1458 # to zero and the currency code is set to match the
1459 # currency code of max_compensation.
1460 "nanos": 42, # Number of nano (10^-9) units of the amount.
1461 # The value must be between -999,999,999 and +999,999,999 inclusive.
1462 # If `units` is positive, `nanos` must be positive or zero.
1463 # If `units` is zero, `nanos` can be positive, zero, or negative.
1464 # If `units` is negative, `nanos` must be negative or zero.
1465 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1466 "units": "A String", # The whole units of the amount.
1467 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1468 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1469 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1470 "maxCompensation": { # 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]1471 # to a maximal compensation value and the currency code is set to
1472 # match the currency code of
1473 # min_compensation.
1474 "nanos": 42, # Number of nano (10^-9) units of the amount.
1475 # The value must be between -999,999,999 and +999,999,999 inclusive.
1476 # If `units` is positive, `nanos` must be positive or zero.
1477 # If `units` is zero, `nanos` can be positive, zero, or negative.
1478 # If `units` is negative, `nanos` must be negative or zero.
1479 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1480 "units": "A String", # The whole units of the amount.
1481 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1482 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1483 },
1484 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1485 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1486 #
1487 # At most one entry can be of type
1488 # CompensationInfo.CompensationType.BASE, which is
1489 # referred as ** base compensation entry ** for the job.
1490 { # A compensation entry that represents one component of compensation, such
1491 # as base pay, bonus, or other compensation type.
1492 #
1493 # Annualization: One compensation entry can be annualized if
1494 # - it contains valid amount or range.
1495 # - and its expected_units_per_year is set or can be derived.
1496 # Its annualized range is determined as (amount or range) times
1497 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1498 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1499 # indicate equity terms or provide additional context to an estimated
1500 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1501 "range": { # Compensation range. # Optional. Compensation range.
1502 "minCompensation": { # 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]1503 # to zero and the currency code is set to match the
1504 # currency code of max_compensation.
1505 "nanos": 42, # Number of nano (10^-9) units of the amount.
1506 # The value must be between -999,999,999 and +999,999,999 inclusive.
1507 # If `units` is positive, `nanos` must be positive or zero.
1508 # If `units` is zero, `nanos` can be positive, zero, or negative.
1509 # If `units` is negative, `nanos` must be negative or zero.
1510 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1511 "units": "A String", # The whole units of the amount.
1512 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1513 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1514 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1515 "maxCompensation": { # 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]1516 # to a maximal compensation value and the currency code is set to
1517 # match the currency code of
1518 # min_compensation.
1519 "nanos": 42, # Number of nano (10^-9) units of the amount.
1520 # The value must be between -999,999,999 and +999,999,999 inclusive.
1521 # If `units` is positive, `nanos` must be positive or zero.
1522 # If `units` is zero, `nanos` can be positive, zero, or negative.
1523 # If `units` is negative, `nanos` must be negative or zero.
1524 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1525 "units": "A String", # The whole units of the amount.
1526 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1527 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1528 },
1529 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1530 "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]1531 # Job.employment_types is FULLTIME, a default value is inferred
1532 # based on unit. Default values:
1533 # - HOURLY: 2080
1534 # - DAILY: 260
1535 # - WEEKLY: 52
1536 # - MONTHLY: 12
1537 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1538 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1539 "nanos": 42, # Number of nano (10^-9) units of the amount.
1540 # The value must be between -999,999,999 and +999,999,999 inclusive.
1541 # If `units` is positive, `nanos` must be positive or zero.
1542 # If `units` is zero, `nanos` can be positive, zero, or negative.
1543 # If `units` is negative, `nanos` must be negative or zero.
1544 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1545 "units": "A String", # The whole units of the amount.
1546 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1547 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1548 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1549 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1550 #
1551 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1552 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1553 #
1554 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
1555 },
1556 ],
1557 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1558 "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]1559 # position.
1560 #
1561 # The maximum number of allowed characters is 255.
1562 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1563 "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]1564 # client to identify a job. This field is intended to be used by clients
1565 # for client identification and tracking of postings. A job is not allowed
1566 # to be created if there is another job with the same [company_name],
1567 # language_code and requisition_id.
1568 #
1569 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1570 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1571 # value is the time the request arrives at the server. Invalid timestamps are
1572 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1573 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
1574 # description of the company and related information. Separate fields are
1575 # provided on the job object for responsibilities,
1576 # qualifications, and other job characteristics. Use of
1577 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1578 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1579 # This field accepts and sanitizes HTML input, and also accepts
1580 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1581 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1582 # The maximum number of allowed characters is 100,000.
1583 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1584 # "projects/api-test-project/companies/foo".
1585 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
1586 #
1587 # Derived details about the job posting.
1588 "jobCategories": [ # Job categories derived from Job.title and Job.description.
1589 "A String",
1590 ],
1591 "locations": [ # Structured locations of the job, resolved from Job.addresses.
1592 #
1593 # locations are exactly matched to Job.addresses in the same
1594 # order.
1595 { # Output only.
1596 #
1597 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1598 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
1599 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
1600 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
1601 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1602 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
1603 # location bounding box in which a circle with the specified radius
1604 # centered from LatLng covers the area associated with the job location.
1605 # For example, currently, "Mountain View, CA, USA" has a radius of
1606 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1607 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
1608 # of doubles representing degrees latitude and degrees longitude. Unless
1609 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1610 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
1611 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1612 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
1613 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
1614 },
1615 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
1616 # such as postal delivery and payments addresses. Given a postal address,
1617 # a postal service can deliver items to a premises, P.O. Box, or other
1618 # delivery location.
1619 # Given a postal address, a postal service can deliver items to a premise, P.O.
1620 # Box or similar.
1621 # It is not intended to model geographical locations (roads, towns,
1622 # mountains).
1623 #
1624 # In typical usage an address would be created via user input or from importing
1625 # existing data, depending on the type of process.
1626 #
1627 # Advice on address input / editing:
1628 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1629 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1630 # - Users should not be presented with UI elements for input or editing of
1631 # fields outside countries where that field is used.
1632 #
1633 # For more guidance on how to use this schema, please see:
1634 # https://support.google.com/business/answer/6397478
1635 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
1636 # known). This is often the UI language of the input form or is expected
1637 # to match one of the languages used in the address' country/region, or their
1638 # transliterated equivalents.
1639 # This can affect formatting in certain countries, but is not critical
1640 # to the correctness of the data and will never affect any validation or
1641 # other non-formatting related operations.
1642 #
1643 # If this value is not known, it should be omitted (rather than specifying a
1644 # possibly incorrect default).
1645 #
1646 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
1647 "recipients": [ # Optional. The recipient at the address.
1648 # This field may, under certain circumstances, contain multiline information.
1649 # For example, it might contain "care of" information.
1650 "A String",
1651 ],
1652 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
1653 # Examples: US city, IT comune, UK post town.
1654 # In regions of the world where localities are not well defined or do not fit
1655 # into this structure well, leave locality empty and use address_lines.
1656 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
1657 # in most regions. Where it is used, the value is either a string like
1658 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
1659 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
1660 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
1661 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
1662 # is never inferred and it is up to the user to ensure the value is
1663 # correct. See http://cldr.unicode.org/ and
1664 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
1665 # for details. Example: "CH" for Switzerland.
1666 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
1667 # addresses of a country or region.
1668 # For example, this can be a state, a province, an oblast, or a prefecture.
1669 # Specifically, for Spain this is the province and not the autonomous
1670 # community (e.g. "Barcelona" and not "Catalonia").
1671 # Many countries don't use an administrative area in postal addresses. E.g.
1672 # in Switzerland this should be left unpopulated.
1673 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
1674 #
1675 # Because values in address_lines do not have type information and may
1676 # sometimes contain multiple values in a single field (e.g.
1677 # "Austin, TX"), it is important that the line order is clear. The order of
1678 # address lines should be "envelope order" for the country/region of the
1679 # address. In places where this can vary (e.g. Japan), address_language is
1680 # used to make it explicit (e.g. "ja" for large-to-small ordering and
1681 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
1682 # an address can be selected based on the language.
1683 #
1684 # The minimum permitted structural representation of an address consists
1685 # of a region_code with all remaining information placed in the
1686 # address_lines. It would be possible to format such an address very
1687 # approximately without geocoding, but no semantic reasoning could be
1688 # made about any of the address components until it was at least
1689 # partially resolved.
1690 #
1691 # Creating an address only containing a region_code and address_lines, and
1692 # then geocoding is the recommended way to handle completely unstructured
1693 # addresses (as opposed to guessing which parts of the address should be
1694 # localities or administrative areas).
1695 "A String",
1696 ],
1697 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
1698 # postal codes to be present, but where they are used, they may trigger
1699 # additional validation with other parts of the address (e.g. state/zip
1700 # validation in the U.S.A.).
1701 "organization": "A String", # Optional. The name of the organization at the address.
1702 "sublocality": "A String", # Optional. Sublocality of the address.
1703 # For example, this can be neighborhoods, boroughs, districts.
1704 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
1705 # the latest revision.
1706 #
1707 # All new revisions **must** be backward compatible with old revisions.
1708 },
1709 },
1710 ],
1711 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1712 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1713 # job. The use of this field is recommended
1714 # as an alternative to using the more general description field.
1715 #
1716 # This field accepts and sanitizes HTML input, and also accepts
1717 # bold, italic, ordered list, and unordered list markup tags.
1718 #
1719 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1720 "jobBenefits": [ # Optional. The benefits included with the job.
1721 "A String",
1722 ],
1723 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
1724 # incentives associated with the job not including salary or pay.
1725 #
1726 # The maximum number of allowed characters is 10,000.
1727 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1728 #
1729 # The visibility of the job.
1730 #
1731 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
1732 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1733 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1734 # the job is available. If this field is set, a
1735 # LocationFilter in a search query within the job region
1736 # finds this job posting if an exact location match isn't specified.
1737 # If this field is set to PostingRegion.NATION or
1738 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
1739 # to the same location level as this field is strongly recommended.
1740 "name": "A String", # Required during job update.
1741 #
1742 # The resource name for the job. This is generated by the service when a
1743 # job is created.
1744 #
1745 # The format is "projects/{project_id}/jobs/{job_id}",
1746 # for example, "projects/api-test-project/jobs/1234".
1747 #
1748 # Use of this field in job queries and API calls is preferred over the use of
1749 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1750 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1751 #
1752 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1753 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1754 #
1755 # * description
1756 # * applicationInfo.instruction
1757 # * incentives
1758 # * qualifications
1759 # * responsibilities
1760 #
1761 # HTML tags in these fields may be stripped if sanitiazation is not
1762 # disabled.
1763 #
1764 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1765 "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]1766 # more precise address for the job.
1767 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1768 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1769 "A String",
1770 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1771 "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]1772 # attributes that are not covered by the provided structured fields.
1773 #
1774 # The keys of the map are strings up to 64 bytes and must match the
1775 # pattern: a-zA-Z*. For example, key0LikeThis or
1776 # KEY_1_LIKE_THIS.
1777 #
1778 # At most 100 filterable and at most 100 unfilterable keys are supported.
1779 # For filterable `string_values`, across all keys at most 200 values are
1780 # allowed, with each string no more than 255 characters. For unfilterable
1781 # `string_values`, the maximum total size of `string_values` across all keys
1782 # is 50KB.
1783 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1784 "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]1785 # If false, values are not searchable.
1786 #
1787 # Default is false.
1788 "stringValues": [ # Optional but exactly one of string_values or long_values must
1789 # be specified.
1790 #
1791 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
1792 # `CASE_INSENSITIVE_MATCH`) search.
1793 # For filterable `string_value`s, a maximum total number of 200 values
1794 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1795 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1796 # unfilterable `string_values` is 50KB.
1797 #
1798 # Empty string is not allowed.
1799 "A String",
1800 ],
1801 "longValues": [ # Optional but exactly one of string_values or long_values must
1802 # be specified.
1803 #
1804 # This field is used to perform number range search.
1805 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
1806 #
1807 # Currently at most 1 long_values is supported.
1808 "A String",
1809 ],
1810 },
1811 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1812 "jobLevel": "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]1813 }</pre>
1814</div>
1815
1816<div class="method">
1817 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, jobView=None, filter=None)</code>
1818 <pre>Lists jobs by filter.
1819
1820Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1821 parent: string, Required. The resource name of the project under which the job is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1822
1823The format is "projects/{project_id}", for example,
1824"projects/api-test-project". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1825 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]1826
1827If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed
1828page size is 1000. Otherwise, the maximum allowed page size is 100.
1829
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1830Default is 100 if empty or a number &lt; 1 is specified.
1831 pageToken: string, Optional. The starting point of a query result.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1832 x__xgafv: string, V1 error format.
1833 Allowed values
1834 1 - v1 error format
1835 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1836 jobView: string, Optional. The desired job attributes returned for jobs in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1837search response. Defaults to JobView.JOB_VIEW_FULL if no value is
1838specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1839 filter: string, Required. The filter string specifies the jobs to be enumerated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1840
1841Supported operator: =, AND
1842
1843The fields eligible for filtering are:
1844
1845* `companyName` (Required)
1846* `requisitionId` (Optional)
1847
1848Sample Query:
1849
1850* companyName = "projects/api-test-project/companies/123"
1851* companyName = "projects/api-test-project/companies/123" AND requisitionId
1852= "req-1"
1853
1854Returns:
1855 An object of the form:
1856
1857 { # Output only.
1858 #
1859 # List jobs response.
1860 "nextPageToken": "A String", # A token to retrieve the next page of results.
1861 "jobs": [ # The Jobs for a given company.
1862 #
1863 # The maximum number of items returned is based on the limit field
1864 # provided in the request.
1865 { # A Job resource represents a job posting (also referred to as a "job listing"
1866 # or "job requisition"). A job belongs to a Company, which is the hiring
1867 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1868 "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]1869 # any requirements for fluency that are associated with the job.
1870 #
1871 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
1872 # For more information, see
1873 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
1874 # class="external" target="_blank" }.
1875 #
1876 # If this field is unspecified and Job.description is present, detected
1877 # language code based on Job.description is assigned, otherwise
1878 # defaults to 'en_US'.
1879 "addresses": [ # Optional but strongly recommended for the best service experience.
1880 #
1881 # Location(s) where the employer is looking to hire for this job posting.
1882 #
1883 # Specifying the full street address(es) of the hiring location enables
1884 # better API results, especially job searches by commute time.
1885 #
1886 # At most 50 locations are allowed for best search performance. If a job has
1887 # more locations, it is suggested to split it into multiple jobs with unique
1888 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
1889 # multiple jobs with the same company_name, language_code and
1890 # requisition_id are not allowed. If the original requisition_id must
1891 # be preserved, a custom field should be used for storage. It is also
1892 # suggested to group the locations that close to each other in the same job
1893 # for better search experience.
1894 #
1895 # The maximum number of allowed characters is 500.
1896 "A String",
1897 ],
1898 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1899 "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]1900 # The value determines the sort order of the jobs returned when searching for
1901 # jobs using the featured jobs search call, with higher promotional values
1902 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1903 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1904 #
1905 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1906 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1907 # full time or
1908 # part time.
1909 "A String",
1910 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1911 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1912 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1913 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1914 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1915 # Job application information.
1916 "instruction": "A String", # Optional but at least one of uris,
1917 # emails or instruction must be
1918 # specified.
1919 #
1920 # Use this field to provide instructions, such as "Mail your application
1921 # to ...", that a candidate can follow to apply for the job.
1922 #
1923 # This field accepts and sanitizes HTML input, and also accepts
1924 # bold, italic, ordered list, and unordered list markup tags.
1925 #
1926 # The maximum number of allowed characters is 3,000.
1927 "uris": [ # Optional but at least one of uris,
1928 # emails or instruction must be
1929 # specified.
1930 #
1931 # Use this URI field to direct an applicant to a website, for example to
1932 # link to an online application form.
1933 #
1934 # The maximum number of allowed characters for each entry is 2,000.
1935 "A String",
1936 ],
1937 "emails": [ # Optional but at least one of uris,
1938 # emails or instruction must be
1939 # specified.
1940 #
1941 # Use this field to specify email address(es) to which resumes or
1942 # applications can be sent.
1943 #
1944 # The maximum number of allowed characters for each entry is 255.
1945 "A String",
1946 ],
1947 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1948 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
1949 # experience.
1950 #
1951 # The expiration timestamp of the job. After this timestamp, the
1952 # job is marked as expired, and it no longer appears in search results. The
1953 # expired job can't be deleted or listed by the DeleteJob and
1954 # ListJobs APIs, but it can be retrieved with the GetJob API or
1955 # updated with the UpdateJob API. An expired job can be updated and
1956 # opened again by using a future expiration timestamp. Updating an expired
1957 # job fails if there is another existing open job with same company_name,
1958 # language_code and requisition_id.
1959 #
1960 # The expired jobs are retained in our system for 90 days. However, the
1961 # overall expired job count cannot exceed 3 times the maximum of open jobs
1962 # count over the past week, otherwise jobs with earlier expire time are
1963 # cleaned first. Expired jobs are no longer accessible after they are cleaned
1964 # out.
1965 #
1966 # Invalid timestamps are ignored, and treated as expire time not provided.
1967 #
1968 # Timestamp before the instant request is made is considered valid, the job
1969 # will be treated as expired immediately.
1970 #
1971 # If this value is not provided at the time of job creation or is invalid,
1972 # the job posting expires after 30 days from the job's creation time. For
1973 # example, if the job was created on 2017/01/01 13:00AM UTC with an
1974 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
1975 #
1976 # If this value is not provided on job update, it depends on the field masks
1977 # set by UpdateJobRequest.update_mask. If the field masks include
1978 # expiry_time, or the masks are empty meaning that every field is
1979 # updated, the job posting expires after 30 days from the job's last
1980 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1981 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1982 #
1983 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1984 "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]1985 # recommended as an alternative to using the more general description
1986 # field.
1987 #
1988 # This field accepts and sanitizes HTML input, and also accepts
1989 # bold, italic, ordered list, and unordered list markup tags.
1990 #
1991 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1992 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1993 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1994 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1995 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
1996 # all compensation entries' CompensationEntry.compensation times
1997 # CompensationEntry.expected_units_per_year.
1998 #
1999 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2000 "minCompensation": { # 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]2001 # to zero and the currency code is set to match the
2002 # currency code of max_compensation.
2003 "nanos": 42, # Number of nano (10^-9) units of the amount.
2004 # The value must be between -999,999,999 and +999,999,999 inclusive.
2005 # If `units` is positive, `nanos` must be positive or zero.
2006 # If `units` is zero, `nanos` can be positive, zero, or negative.
2007 # If `units` is negative, `nanos` must be negative or zero.
2008 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2009 "units": "A String", # The whole units of the amount.
2010 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2011 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2012 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2013 "maxCompensation": { # 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]2014 # to a maximal compensation value and the currency code is set to
2015 # match the currency code of
2016 # min_compensation.
2017 "nanos": 42, # Number of nano (10^-9) units of the amount.
2018 # The value must be between -999,999,999 and +999,999,999 inclusive.
2019 # If `units` is positive, `nanos` must be positive or zero.
2020 # If `units` is zero, `nanos` can be positive, zero, or negative.
2021 # If `units` is negative, `nanos` must be negative or zero.
2022 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2023 "units": "A String", # The whole units of the amount.
2024 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2025 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2026 },
2027 },
2028 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
2029 # base compensation entry's CompensationEntry.compensation times
2030 # CompensationEntry.expected_units_per_year.
2031 #
2032 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2033 "minCompensation": { # 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]2034 # to zero and the currency code is set to match the
2035 # currency code of max_compensation.
2036 "nanos": 42, # Number of nano (10^-9) units of the amount.
2037 # The value must be between -999,999,999 and +999,999,999 inclusive.
2038 # If `units` is positive, `nanos` must be positive or zero.
2039 # If `units` is zero, `nanos` can be positive, zero, or negative.
2040 # If `units` is negative, `nanos` must be negative or zero.
2041 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2042 "units": "A String", # The whole units of the amount.
2043 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2044 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2045 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2046 "maxCompensation": { # 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]2047 # to a maximal compensation value and the currency code is set to
2048 # match the currency code of
2049 # min_compensation.
2050 "nanos": 42, # Number of nano (10^-9) units of the amount.
2051 # The value must be between -999,999,999 and +999,999,999 inclusive.
2052 # If `units` is positive, `nanos` must be positive or zero.
2053 # If `units` is zero, `nanos` can be positive, zero, or negative.
2054 # If `units` is negative, `nanos` must be negative or zero.
2055 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2056 "units": "A String", # The whole units of the amount.
2057 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2058 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2059 },
2060 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2061 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2062 #
2063 # At most one entry can be of type
2064 # CompensationInfo.CompensationType.BASE, which is
2065 # referred as ** base compensation entry ** for the job.
2066 { # A compensation entry that represents one component of compensation, such
2067 # as base pay, bonus, or other compensation type.
2068 #
2069 # Annualization: One compensation entry can be annualized if
2070 # - it contains valid amount or range.
2071 # - and its expected_units_per_year is set or can be derived.
2072 # Its annualized range is determined as (amount or range) times
2073 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2074 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2075 # indicate equity terms or provide additional context to an estimated
2076 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2077 "range": { # Compensation range. # Optional. Compensation range.
2078 "minCompensation": { # 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]2079 # to zero and the currency code is set to match the
2080 # currency code of max_compensation.
2081 "nanos": 42, # Number of nano (10^-9) units of the amount.
2082 # The value must be between -999,999,999 and +999,999,999 inclusive.
2083 # If `units` is positive, `nanos` must be positive or zero.
2084 # If `units` is zero, `nanos` can be positive, zero, or negative.
2085 # If `units` is negative, `nanos` must be negative or zero.
2086 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2087 "units": "A String", # The whole units of the amount.
2088 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2089 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2090 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2091 "maxCompensation": { # 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]2092 # to a maximal compensation value and the currency code is set to
2093 # match the currency code of
2094 # min_compensation.
2095 "nanos": 42, # Number of nano (10^-9) units of the amount.
2096 # The value must be between -999,999,999 and +999,999,999 inclusive.
2097 # If `units` is positive, `nanos` must be positive or zero.
2098 # If `units` is zero, `nanos` can be positive, zero, or negative.
2099 # If `units` is negative, `nanos` must be negative or zero.
2100 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2101 "units": "A String", # The whole units of the amount.
2102 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2103 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2104 },
2105 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2106 "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]2107 # Job.employment_types is FULLTIME, a default value is inferred
2108 # based on unit. Default values:
2109 # - HOURLY: 2080
2110 # - DAILY: 260
2111 # - WEEKLY: 52
2112 # - MONTHLY: 12
2113 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2114 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2115 "nanos": 42, # Number of nano (10^-9) units of the amount.
2116 # The value must be between -999,999,999 and +999,999,999 inclusive.
2117 # If `units` is positive, `nanos` must be positive or zero.
2118 # If `units` is zero, `nanos` can be positive, zero, or negative.
2119 # If `units` is negative, `nanos` must be negative or zero.
2120 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2121 "units": "A String", # The whole units of the amount.
2122 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2123 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2124 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2125 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2126 #
2127 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2128 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2129 #
2130 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
2131 },
2132 ],
2133 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2134 "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]2135 # position.
2136 #
2137 # The maximum number of allowed characters is 255.
2138 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2139 "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]2140 # client to identify a job. This field is intended to be used by clients
2141 # for client identification and tracking of postings. A job is not allowed
2142 # to be created if there is another job with the same [company_name],
2143 # language_code and requisition_id.
2144 #
2145 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2146 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2147 # value is the time the request arrives at the server. Invalid timestamps are
2148 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2149 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
2150 # description of the company and related information. Separate fields are
2151 # provided on the job object for responsibilities,
2152 # qualifications, and other job characteristics. Use of
2153 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2154 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2155 # This field accepts and sanitizes HTML input, and also accepts
2156 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2157 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2158 # The maximum number of allowed characters is 100,000.
2159 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2160 # "projects/api-test-project/companies/foo".
2161 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
2162 #
2163 # Derived details about the job posting.
2164 "jobCategories": [ # Job categories derived from Job.title and Job.description.
2165 "A String",
2166 ],
2167 "locations": [ # Structured locations of the job, resolved from Job.addresses.
2168 #
2169 # locations are exactly matched to Job.addresses in the same
2170 # order.
2171 { # Output only.
2172 #
2173 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2174 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
2175 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
2176 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
2177 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2178 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
2179 # location bounding box in which a circle with the specified radius
2180 # centered from LatLng covers the area associated with the job location.
2181 # For example, currently, "Mountain View, CA, USA" has a radius of
2182 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2183 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
2184 # of doubles representing degrees latitude and degrees longitude. Unless
2185 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2186 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
2187 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2188 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
2189 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
2190 },
2191 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
2192 # such as postal delivery and payments addresses. Given a postal address,
2193 # a postal service can deliver items to a premises, P.O. Box, or other
2194 # delivery location.
2195 # Given a postal address, a postal service can deliver items to a premise, P.O.
2196 # Box or similar.
2197 # It is not intended to model geographical locations (roads, towns,
2198 # mountains).
2199 #
2200 # In typical usage an address would be created via user input or from importing
2201 # existing data, depending on the type of process.
2202 #
2203 # Advice on address input / editing:
2204 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2205 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2206 # - Users should not be presented with UI elements for input or editing of
2207 # fields outside countries where that field is used.
2208 #
2209 # For more guidance on how to use this schema, please see:
2210 # https://support.google.com/business/answer/6397478
2211 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
2212 # known). This is often the UI language of the input form or is expected
2213 # to match one of the languages used in the address' country/region, or their
2214 # transliterated equivalents.
2215 # This can affect formatting in certain countries, but is not critical
2216 # to the correctness of the data and will never affect any validation or
2217 # other non-formatting related operations.
2218 #
2219 # If this value is not known, it should be omitted (rather than specifying a
2220 # possibly incorrect default).
2221 #
2222 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
2223 "recipients": [ # Optional. The recipient at the address.
2224 # This field may, under certain circumstances, contain multiline information.
2225 # For example, it might contain "care of" information.
2226 "A String",
2227 ],
2228 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
2229 # Examples: US city, IT comune, UK post town.
2230 # In regions of the world where localities are not well defined or do not fit
2231 # into this structure well, leave locality empty and use address_lines.
2232 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
2233 # in most regions. Where it is used, the value is either a string like
2234 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
2235 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
2236 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
2237 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
2238 # is never inferred and it is up to the user to ensure the value is
2239 # correct. See http://cldr.unicode.org/ and
2240 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
2241 # for details. Example: "CH" for Switzerland.
2242 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
2243 # addresses of a country or region.
2244 # For example, this can be a state, a province, an oblast, or a prefecture.
2245 # Specifically, for Spain this is the province and not the autonomous
2246 # community (e.g. "Barcelona" and not "Catalonia").
2247 # Many countries don't use an administrative area in postal addresses. E.g.
2248 # in Switzerland this should be left unpopulated.
2249 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
2250 #
2251 # Because values in address_lines do not have type information and may
2252 # sometimes contain multiple values in a single field (e.g.
2253 # "Austin, TX"), it is important that the line order is clear. The order of
2254 # address lines should be "envelope order" for the country/region of the
2255 # address. In places where this can vary (e.g. Japan), address_language is
2256 # used to make it explicit (e.g. "ja" for large-to-small ordering and
2257 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
2258 # an address can be selected based on the language.
2259 #
2260 # The minimum permitted structural representation of an address consists
2261 # of a region_code with all remaining information placed in the
2262 # address_lines. It would be possible to format such an address very
2263 # approximately without geocoding, but no semantic reasoning could be
2264 # made about any of the address components until it was at least
2265 # partially resolved.
2266 #
2267 # Creating an address only containing a region_code and address_lines, and
2268 # then geocoding is the recommended way to handle completely unstructured
2269 # addresses (as opposed to guessing which parts of the address should be
2270 # localities or administrative areas).
2271 "A String",
2272 ],
2273 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
2274 # postal codes to be present, but where they are used, they may trigger
2275 # additional validation with other parts of the address (e.g. state/zip
2276 # validation in the U.S.A.).
2277 "organization": "A String", # Optional. The name of the organization at the address.
2278 "sublocality": "A String", # Optional. Sublocality of the address.
2279 # For example, this can be neighborhoods, boroughs, districts.
2280 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
2281 # the latest revision.
2282 #
2283 # All new revisions **must** be backward compatible with old revisions.
2284 },
2285 },
2286 ],
2287 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2288 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2289 # job. The use of this field is recommended
2290 # as an alternative to using the more general description field.
2291 #
2292 # This field accepts and sanitizes HTML input, and also accepts
2293 # bold, italic, ordered list, and unordered list markup tags.
2294 #
2295 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2296 "jobBenefits": [ # Optional. The benefits included with the job.
2297 "A String",
2298 ],
2299 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
2300 # incentives associated with the job not including salary or pay.
2301 #
2302 # The maximum number of allowed characters is 10,000.
2303 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2304 #
2305 # The visibility of the job.
2306 #
2307 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
2308 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2309 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2310 # the job is available. If this field is set, a
2311 # LocationFilter in a search query within the job region
2312 # finds this job posting if an exact location match isn't specified.
2313 # If this field is set to PostingRegion.NATION or
2314 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
2315 # to the same location level as this field is strongly recommended.
2316 "name": "A String", # Required during job update.
2317 #
2318 # The resource name for the job. This is generated by the service when a
2319 # job is created.
2320 #
2321 # The format is "projects/{project_id}/jobs/{job_id}",
2322 # for example, "projects/api-test-project/jobs/1234".
2323 #
2324 # Use of this field in job queries and API calls is preferred over the use of
2325 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2326 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2327 #
2328 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2329 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2330 #
2331 # * description
2332 # * applicationInfo.instruction
2333 # * incentives
2334 # * qualifications
2335 # * responsibilities
2336 #
2337 # HTML tags in these fields may be stripped if sanitiazation is not
2338 # disabled.
2339 #
2340 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2341 "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]2342 # more precise address for the job.
2343 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2344 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2345 "A String",
2346 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2347 "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]2348 # attributes that are not covered by the provided structured fields.
2349 #
2350 # The keys of the map are strings up to 64 bytes and must match the
2351 # pattern: a-zA-Z*. For example, key0LikeThis or
2352 # KEY_1_LIKE_THIS.
2353 #
2354 # At most 100 filterable and at most 100 unfilterable keys are supported.
2355 # For filterable `string_values`, across all keys at most 200 values are
2356 # allowed, with each string no more than 255 characters. For unfilterable
2357 # `string_values`, the maximum total size of `string_values` across all keys
2358 # is 50KB.
2359 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2360 "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]2361 # If false, values are not searchable.
2362 #
2363 # Default is false.
2364 "stringValues": [ # Optional but exactly one of string_values or long_values must
2365 # be specified.
2366 #
2367 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
2368 # `CASE_INSENSITIVE_MATCH`) search.
2369 # For filterable `string_value`s, a maximum total number of 200 values
2370 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2371 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2372 # unfilterable `string_values` is 50KB.
2373 #
2374 # Empty string is not allowed.
2375 "A String",
2376 ],
2377 "longValues": [ # Optional but exactly one of string_values or long_values must
2378 # be specified.
2379 #
2380 # This field is used to perform number range search.
2381 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
2382 #
2383 # Currently at most 1 long_values is supported.
2384 "A String",
2385 ],
2386 },
2387 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2388 "jobLevel": "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]2389 },
2390 ],
2391 "metadata": { # Output only. # Additional information for the API invocation, such as the request
2392 # tracking id.
2393 #
2394 # Additional information returned to client, such as debugging information.
2395 "requestId": "A String", # A unique id associated with this call.
2396 # This id is logged for tracking purposes.
2397 },
2398 }</pre>
2399</div>
2400
2401<div class="method">
2402 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2403 <pre>Retrieves the next page of results.
2404
2405Args:
2406 previous_request: The request for the previous page. (required)
2407 previous_response: The response from the request for the previous page. (required)
2408
2409Returns:
2410 A request object that you can call 'execute()' on to request the next
2411 page. Returns None if there are no more items in the collection.
2412 </pre>
2413</div>
2414
2415<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2416 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2417 <pre>Updates specified job.
2418
2419Typically, updated contents become visible in search results within 10
2420seconds, but it may take up to 5 minutes.
2421
2422Args:
2423 name: string, Required during job update.
2424
2425The resource name for the job. This is generated by the service when a
2426job is created.
2427
2428The format is "projects/{project_id}/jobs/{job_id}",
2429for example, "projects/api-test-project/jobs/1234".
2430
2431Use of this field in job queries and API calls is preferred over the use of
2432requisition_id since this value is unique. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2433 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2434 The object takes the form of:
2435
2436{ # Input only.
2437 #
2438 # Update job request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2439 "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]2440 # or "job requisition"). A job belongs to a Company, which is the hiring
2441 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2442 "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]2443 # any requirements for fluency that are associated with the job.
2444 #
2445 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
2446 # For more information, see
2447 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
2448 # class="external" target="_blank" }.
2449 #
2450 # If this field is unspecified and Job.description is present, detected
2451 # language code based on Job.description is assigned, otherwise
2452 # defaults to 'en_US'.
2453 "addresses": [ # Optional but strongly recommended for the best service experience.
2454 #
2455 # Location(s) where the employer is looking to hire for this job posting.
2456 #
2457 # Specifying the full street address(es) of the hiring location enables
2458 # better API results, especially job searches by commute time.
2459 #
2460 # At most 50 locations are allowed for best search performance. If a job has
2461 # more locations, it is suggested to split it into multiple jobs with unique
2462 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
2463 # multiple jobs with the same company_name, language_code and
2464 # requisition_id are not allowed. If the original requisition_id must
2465 # be preserved, a custom field should be used for storage. It is also
2466 # suggested to group the locations that close to each other in the same job
2467 # for better search experience.
2468 #
2469 # The maximum number of allowed characters is 500.
2470 "A String",
2471 ],
2472 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2473 "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]2474 # The value determines the sort order of the jobs returned when searching for
2475 # jobs using the featured jobs search call, with higher promotional values
2476 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2477 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2478 #
2479 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2480 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2481 # full time or
2482 # part time.
2483 "A String",
2484 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2485 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2486 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2487 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2488 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2489 # Job application information.
2490 "instruction": "A String", # Optional but at least one of uris,
2491 # emails or instruction must be
2492 # specified.
2493 #
2494 # Use this field to provide instructions, such as "Mail your application
2495 # to ...", that a candidate can follow to apply for the job.
2496 #
2497 # This field accepts and sanitizes HTML input, and also accepts
2498 # bold, italic, ordered list, and unordered list markup tags.
2499 #
2500 # The maximum number of allowed characters is 3,000.
2501 "uris": [ # Optional but at least one of uris,
2502 # emails or instruction must be
2503 # specified.
2504 #
2505 # Use this URI field to direct an applicant to a website, for example to
2506 # link to an online application form.
2507 #
2508 # The maximum number of allowed characters for each entry is 2,000.
2509 "A String",
2510 ],
2511 "emails": [ # Optional but at least one of uris,
2512 # emails or instruction must be
2513 # specified.
2514 #
2515 # Use this field to specify email address(es) to which resumes or
2516 # applications can be sent.
2517 #
2518 # The maximum number of allowed characters for each entry is 255.
2519 "A String",
2520 ],
2521 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2522 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
2523 # experience.
2524 #
2525 # The expiration timestamp of the job. After this timestamp, the
2526 # job is marked as expired, and it no longer appears in search results. The
2527 # expired job can't be deleted or listed by the DeleteJob and
2528 # ListJobs APIs, but it can be retrieved with the GetJob API or
2529 # updated with the UpdateJob API. An expired job can be updated and
2530 # opened again by using a future expiration timestamp. Updating an expired
2531 # job fails if there is another existing open job with same company_name,
2532 # language_code and requisition_id.
2533 #
2534 # The expired jobs are retained in our system for 90 days. However, the
2535 # overall expired job count cannot exceed 3 times the maximum of open jobs
2536 # count over the past week, otherwise jobs with earlier expire time are
2537 # cleaned first. Expired jobs are no longer accessible after they are cleaned
2538 # out.
2539 #
2540 # Invalid timestamps are ignored, and treated as expire time not provided.
2541 #
2542 # Timestamp before the instant request is made is considered valid, the job
2543 # will be treated as expired immediately.
2544 #
2545 # If this value is not provided at the time of job creation or is invalid,
2546 # the job posting expires after 30 days from the job's creation time. For
2547 # example, if the job was created on 2017/01/01 13:00AM UTC with an
2548 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
2549 #
2550 # If this value is not provided on job update, it depends on the field masks
2551 # set by UpdateJobRequest.update_mask. If the field masks include
2552 # expiry_time, or the masks are empty meaning that every field is
2553 # updated, the job posting expires after 30 days from the job's last
2554 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2555 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2556 #
2557 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2558 "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]2559 # recommended as an alternative to using the more general description
2560 # field.
2561 #
2562 # This field accepts and sanitizes HTML input, and also accepts
2563 # bold, italic, ordered list, and unordered list markup tags.
2564 #
2565 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2566 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2567 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2568 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2569 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
2570 # all compensation entries' CompensationEntry.compensation times
2571 # CompensationEntry.expected_units_per_year.
2572 #
2573 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2574 "minCompensation": { # 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]2575 # to zero and the currency code is set to match the
2576 # currency code of max_compensation.
2577 "nanos": 42, # Number of nano (10^-9) units of the amount.
2578 # The value must be between -999,999,999 and +999,999,999 inclusive.
2579 # If `units` is positive, `nanos` must be positive or zero.
2580 # If `units` is zero, `nanos` can be positive, zero, or negative.
2581 # If `units` is negative, `nanos` must be negative or zero.
2582 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2583 "units": "A String", # The whole units of the amount.
2584 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2585 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2586 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2587 "maxCompensation": { # 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]2588 # to a maximal compensation value and the currency code is set to
2589 # match the currency code of
2590 # min_compensation.
2591 "nanos": 42, # Number of nano (10^-9) units of the amount.
2592 # The value must be between -999,999,999 and +999,999,999 inclusive.
2593 # If `units` is positive, `nanos` must be positive or zero.
2594 # If `units` is zero, `nanos` can be positive, zero, or negative.
2595 # If `units` is negative, `nanos` must be negative or zero.
2596 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2597 "units": "A String", # The whole units of the amount.
2598 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2599 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2600 },
2601 },
2602 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
2603 # base compensation entry's CompensationEntry.compensation times
2604 # CompensationEntry.expected_units_per_year.
2605 #
2606 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2607 "minCompensation": { # 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]2608 # to zero and the currency code is set to match the
2609 # currency code of max_compensation.
2610 "nanos": 42, # Number of nano (10^-9) units of the amount.
2611 # The value must be between -999,999,999 and +999,999,999 inclusive.
2612 # If `units` is positive, `nanos` must be positive or zero.
2613 # If `units` is zero, `nanos` can be positive, zero, or negative.
2614 # If `units` is negative, `nanos` must be negative or zero.
2615 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2616 "units": "A String", # The whole units of the amount.
2617 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2618 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2619 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2620 "maxCompensation": { # 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]2621 # to a maximal compensation value and the currency code is set to
2622 # match the currency code of
2623 # min_compensation.
2624 "nanos": 42, # Number of nano (10^-9) units of the amount.
2625 # The value must be between -999,999,999 and +999,999,999 inclusive.
2626 # If `units` is positive, `nanos` must be positive or zero.
2627 # If `units` is zero, `nanos` can be positive, zero, or negative.
2628 # If `units` is negative, `nanos` must be negative or zero.
2629 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2630 "units": "A String", # The whole units of the amount.
2631 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2632 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2633 },
2634 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2635 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2636 #
2637 # At most one entry can be of type
2638 # CompensationInfo.CompensationType.BASE, which is
2639 # referred as ** base compensation entry ** for the job.
2640 { # A compensation entry that represents one component of compensation, such
2641 # as base pay, bonus, or other compensation type.
2642 #
2643 # Annualization: One compensation entry can be annualized if
2644 # - it contains valid amount or range.
2645 # - and its expected_units_per_year is set or can be derived.
2646 # Its annualized range is determined as (amount or range) times
2647 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2648 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2649 # indicate equity terms or provide additional context to an estimated
2650 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2651 "range": { # Compensation range. # Optional. Compensation range.
2652 "minCompensation": { # 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]2653 # to zero and the currency code is set to match the
2654 # currency code of max_compensation.
2655 "nanos": 42, # Number of nano (10^-9) units of the amount.
2656 # The value must be between -999,999,999 and +999,999,999 inclusive.
2657 # If `units` is positive, `nanos` must be positive or zero.
2658 # If `units` is zero, `nanos` can be positive, zero, or negative.
2659 # If `units` is negative, `nanos` must be negative or zero.
2660 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2661 "units": "A String", # The whole units of the amount.
2662 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2663 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2664 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2665 "maxCompensation": { # 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]2666 # to a maximal compensation value and the currency code is set to
2667 # match the currency code of
2668 # min_compensation.
2669 "nanos": 42, # Number of nano (10^-9) units of the amount.
2670 # The value must be between -999,999,999 and +999,999,999 inclusive.
2671 # If `units` is positive, `nanos` must be positive or zero.
2672 # If `units` is zero, `nanos` can be positive, zero, or negative.
2673 # If `units` is negative, `nanos` must be negative or zero.
2674 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2675 "units": "A String", # The whole units of the amount.
2676 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2677 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2678 },
2679 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2680 "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]2681 # Job.employment_types is FULLTIME, a default value is inferred
2682 # based on unit. Default values:
2683 # - HOURLY: 2080
2684 # - DAILY: 260
2685 # - WEEKLY: 52
2686 # - MONTHLY: 12
2687 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2688 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2689 "nanos": 42, # Number of nano (10^-9) units of the amount.
2690 # The value must be between -999,999,999 and +999,999,999 inclusive.
2691 # If `units` is positive, `nanos` must be positive or zero.
2692 # If `units` is zero, `nanos` can be positive, zero, or negative.
2693 # If `units` is negative, `nanos` must be negative or zero.
2694 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2695 "units": "A String", # The whole units of the amount.
2696 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2697 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2698 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2699 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2700 #
2701 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2702 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2703 #
2704 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
2705 },
2706 ],
2707 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2708 "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]2709 # position.
2710 #
2711 # The maximum number of allowed characters is 255.
2712 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2713 "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]2714 # client to identify a job. This field is intended to be used by clients
2715 # for client identification and tracking of postings. A job is not allowed
2716 # to be created if there is another job with the same [company_name],
2717 # language_code and requisition_id.
2718 #
2719 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2720 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2721 # value is the time the request arrives at the server. Invalid timestamps are
2722 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2723 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
2724 # description of the company and related information. Separate fields are
2725 # provided on the job object for responsibilities,
2726 # qualifications, and other job characteristics. Use of
2727 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2728 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2729 # This field accepts and sanitizes HTML input, and also accepts
2730 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2731 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2732 # The maximum number of allowed characters is 100,000.
2733 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2734 # "projects/api-test-project/companies/foo".
2735 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
2736 #
2737 # Derived details about the job posting.
2738 "jobCategories": [ # Job categories derived from Job.title and Job.description.
2739 "A String",
2740 ],
2741 "locations": [ # Structured locations of the job, resolved from Job.addresses.
2742 #
2743 # locations are exactly matched to Job.addresses in the same
2744 # order.
2745 { # Output only.
2746 #
2747 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2748 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
2749 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
2750 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
2751 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2752 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
2753 # location bounding box in which a circle with the specified radius
2754 # centered from LatLng covers the area associated with the job location.
2755 # For example, currently, "Mountain View, CA, USA" has a radius of
2756 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2757 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
2758 # of doubles representing degrees latitude and degrees longitude. Unless
2759 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2760 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
2761 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2762 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
2763 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
2764 },
2765 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
2766 # such as postal delivery and payments addresses. Given a postal address,
2767 # a postal service can deliver items to a premises, P.O. Box, or other
2768 # delivery location.
2769 # Given a postal address, a postal service can deliver items to a premise, P.O.
2770 # Box or similar.
2771 # It is not intended to model geographical locations (roads, towns,
2772 # mountains).
2773 #
2774 # In typical usage an address would be created via user input or from importing
2775 # existing data, depending on the type of process.
2776 #
2777 # Advice on address input / editing:
2778 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2779 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2780 # - Users should not be presented with UI elements for input or editing of
2781 # fields outside countries where that field is used.
2782 #
2783 # For more guidance on how to use this schema, please see:
2784 # https://support.google.com/business/answer/6397478
2785 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
2786 # known). This is often the UI language of the input form or is expected
2787 # to match one of the languages used in the address' country/region, or their
2788 # transliterated equivalents.
2789 # This can affect formatting in certain countries, but is not critical
2790 # to the correctness of the data and will never affect any validation or
2791 # other non-formatting related operations.
2792 #
2793 # If this value is not known, it should be omitted (rather than specifying a
2794 # possibly incorrect default).
2795 #
2796 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
2797 "recipients": [ # Optional. The recipient at the address.
2798 # This field may, under certain circumstances, contain multiline information.
2799 # For example, it might contain "care of" information.
2800 "A String",
2801 ],
2802 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
2803 # Examples: US city, IT comune, UK post town.
2804 # In regions of the world where localities are not well defined or do not fit
2805 # into this structure well, leave locality empty and use address_lines.
2806 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
2807 # in most regions. Where it is used, the value is either a string like
2808 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
2809 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
2810 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
2811 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
2812 # is never inferred and it is up to the user to ensure the value is
2813 # correct. See http://cldr.unicode.org/ and
2814 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
2815 # for details. Example: "CH" for Switzerland.
2816 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
2817 # addresses of a country or region.
2818 # For example, this can be a state, a province, an oblast, or a prefecture.
2819 # Specifically, for Spain this is the province and not the autonomous
2820 # community (e.g. "Barcelona" and not "Catalonia").
2821 # Many countries don't use an administrative area in postal addresses. E.g.
2822 # in Switzerland this should be left unpopulated.
2823 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
2824 #
2825 # Because values in address_lines do not have type information and may
2826 # sometimes contain multiple values in a single field (e.g.
2827 # "Austin, TX"), it is important that the line order is clear. The order of
2828 # address lines should be "envelope order" for the country/region of the
2829 # address. In places where this can vary (e.g. Japan), address_language is
2830 # used to make it explicit (e.g. "ja" for large-to-small ordering and
2831 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
2832 # an address can be selected based on the language.
2833 #
2834 # The minimum permitted structural representation of an address consists
2835 # of a region_code with all remaining information placed in the
2836 # address_lines. It would be possible to format such an address very
2837 # approximately without geocoding, but no semantic reasoning could be
2838 # made about any of the address components until it was at least
2839 # partially resolved.
2840 #
2841 # Creating an address only containing a region_code and address_lines, and
2842 # then geocoding is the recommended way to handle completely unstructured
2843 # addresses (as opposed to guessing which parts of the address should be
2844 # localities or administrative areas).
2845 "A String",
2846 ],
2847 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
2848 # postal codes to be present, but where they are used, they may trigger
2849 # additional validation with other parts of the address (e.g. state/zip
2850 # validation in the U.S.A.).
2851 "organization": "A String", # Optional. The name of the organization at the address.
2852 "sublocality": "A String", # Optional. Sublocality of the address.
2853 # For example, this can be neighborhoods, boroughs, districts.
2854 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
2855 # the latest revision.
2856 #
2857 # All new revisions **must** be backward compatible with old revisions.
2858 },
2859 },
2860 ],
2861 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2862 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2863 # job. The use of this field is recommended
2864 # as an alternative to using the more general description field.
2865 #
2866 # This field accepts and sanitizes HTML input, and also accepts
2867 # bold, italic, ordered list, and unordered list markup tags.
2868 #
2869 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2870 "jobBenefits": [ # Optional. The benefits included with the job.
2871 "A String",
2872 ],
2873 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
2874 # incentives associated with the job not including salary or pay.
2875 #
2876 # The maximum number of allowed characters is 10,000.
2877 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2878 #
2879 # The visibility of the job.
2880 #
2881 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
2882 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2883 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2884 # the job is available. If this field is set, a
2885 # LocationFilter in a search query within the job region
2886 # finds this job posting if an exact location match isn't specified.
2887 # If this field is set to PostingRegion.NATION or
2888 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
2889 # to the same location level as this field is strongly recommended.
2890 "name": "A String", # Required during job update.
2891 #
2892 # The resource name for the job. This is generated by the service when a
2893 # job is created.
2894 #
2895 # The format is "projects/{project_id}/jobs/{job_id}",
2896 # for example, "projects/api-test-project/jobs/1234".
2897 #
2898 # Use of this field in job queries and API calls is preferred over the use of
2899 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2900 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2901 #
2902 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2903 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2904 #
2905 # * description
2906 # * applicationInfo.instruction
2907 # * incentives
2908 # * qualifications
2909 # * responsibilities
2910 #
2911 # HTML tags in these fields may be stripped if sanitiazation is not
2912 # disabled.
2913 #
2914 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2915 "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]2916 # more precise address for the job.
2917 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2918 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2919 "A String",
2920 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2921 "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]2922 # attributes that are not covered by the provided structured fields.
2923 #
2924 # The keys of the map are strings up to 64 bytes and must match the
2925 # pattern: a-zA-Z*. For example, key0LikeThis or
2926 # KEY_1_LIKE_THIS.
2927 #
2928 # At most 100 filterable and at most 100 unfilterable keys are supported.
2929 # For filterable `string_values`, across all keys at most 200 values are
2930 # allowed, with each string no more than 255 characters. For unfilterable
2931 # `string_values`, the maximum total size of `string_values` across all keys
2932 # is 50KB.
2933 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2934 "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]2935 # If false, values are not searchable.
2936 #
2937 # Default is false.
2938 "stringValues": [ # Optional but exactly one of string_values or long_values must
2939 # be specified.
2940 #
2941 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
2942 # `CASE_INSENSITIVE_MATCH`) search.
2943 # For filterable `string_value`s, a maximum total number of 200 values
2944 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2945 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2946 # unfilterable `string_values` is 50KB.
2947 #
2948 # Empty string is not allowed.
2949 "A String",
2950 ],
2951 "longValues": [ # Optional but exactly one of string_values or long_values must
2952 # be specified.
2953 #
2954 # This field is used to perform number range search.
2955 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
2956 #
2957 # Currently at most 1 long_values is supported.
2958 "A String",
2959 ],
2960 },
2961 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2962 "jobLevel": "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]2963 },
2964 "updateMask": "A String", # Optional but strongly recommended to be provided for the best service
2965 # experience.
2966 #
2967 # If update_mask is provided, only the specified fields in
2968 # job are updated. Otherwise all the fields are updated.
2969 #
2970 # A field mask to restrict the fields that are updated. Only
2971 # top level fields of Job are supported.
2972 }
2973
2974 x__xgafv: string, V1 error format.
2975 Allowed values
2976 1 - v1 error format
2977 2 - v2 error format
2978
2979Returns:
2980 An object of the form:
2981
2982 { # A Job resource represents a job posting (also referred to as a "job listing"
2983 # or "job requisition"). A job belongs to a Company, which is the hiring
2984 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2985 "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]2986 # any requirements for fluency that are associated with the job.
2987 #
2988 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
2989 # For more information, see
2990 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
2991 # class="external" target="_blank" }.
2992 #
2993 # If this field is unspecified and Job.description is present, detected
2994 # language code based on Job.description is assigned, otherwise
2995 # defaults to 'en_US'.
2996 "addresses": [ # Optional but strongly recommended for the best service experience.
2997 #
2998 # Location(s) where the employer is looking to hire for this job posting.
2999 #
3000 # Specifying the full street address(es) of the hiring location enables
3001 # better API results, especially job searches by commute time.
3002 #
3003 # At most 50 locations are allowed for best search performance. If a job has
3004 # more locations, it is suggested to split it into multiple jobs with unique
3005 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
3006 # multiple jobs with the same company_name, language_code and
3007 # requisition_id are not allowed. If the original requisition_id must
3008 # be preserved, a custom field should be used for storage. It is also
3009 # suggested to group the locations that close to each other in the same job
3010 # for better search experience.
3011 #
3012 # The maximum number of allowed characters is 500.
3013 "A String",
3014 ],
3015 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3016 "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]3017 # The value determines the sort order of the jobs returned when searching for
3018 # jobs using the featured jobs search call, with higher promotional values
3019 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3020 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3021 #
3022 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3023 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3024 # full time or
3025 # part time.
3026 "A String",
3027 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3028 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3029 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3030 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3031 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3032 # Job application information.
3033 "instruction": "A String", # Optional but at least one of uris,
3034 # emails or instruction must be
3035 # specified.
3036 #
3037 # Use this field to provide instructions, such as "Mail your application
3038 # to ...", that a candidate can follow to apply for the job.
3039 #
3040 # This field accepts and sanitizes HTML input, and also accepts
3041 # bold, italic, ordered list, and unordered list markup tags.
3042 #
3043 # The maximum number of allowed characters is 3,000.
3044 "uris": [ # Optional but at least one of uris,
3045 # emails or instruction must be
3046 # specified.
3047 #
3048 # Use this URI field to direct an applicant to a website, for example to
3049 # link to an online application form.
3050 #
3051 # The maximum number of allowed characters for each entry is 2,000.
3052 "A String",
3053 ],
3054 "emails": [ # Optional but at least one of uris,
3055 # emails or instruction must be
3056 # specified.
3057 #
3058 # Use this field to specify email address(es) to which resumes or
3059 # applications can be sent.
3060 #
3061 # The maximum number of allowed characters for each entry is 255.
3062 "A String",
3063 ],
3064 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3065 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
3066 # experience.
3067 #
3068 # The expiration timestamp of the job. After this timestamp, the
3069 # job is marked as expired, and it no longer appears in search results. The
3070 # expired job can't be deleted or listed by the DeleteJob and
3071 # ListJobs APIs, but it can be retrieved with the GetJob API or
3072 # updated with the UpdateJob API. An expired job can be updated and
3073 # opened again by using a future expiration timestamp. Updating an expired
3074 # job fails if there is another existing open job with same company_name,
3075 # language_code and requisition_id.
3076 #
3077 # The expired jobs are retained in our system for 90 days. However, the
3078 # overall expired job count cannot exceed 3 times the maximum of open jobs
3079 # count over the past week, otherwise jobs with earlier expire time are
3080 # cleaned first. Expired jobs are no longer accessible after they are cleaned
3081 # out.
3082 #
3083 # Invalid timestamps are ignored, and treated as expire time not provided.
3084 #
3085 # Timestamp before the instant request is made is considered valid, the job
3086 # will be treated as expired immediately.
3087 #
3088 # If this value is not provided at the time of job creation or is invalid,
3089 # the job posting expires after 30 days from the job's creation time. For
3090 # example, if the job was created on 2017/01/01 13:00AM UTC with an
3091 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
3092 #
3093 # If this value is not provided on job update, it depends on the field masks
3094 # set by UpdateJobRequest.update_mask. If the field masks include
3095 # expiry_time, or the masks are empty meaning that every field is
3096 # updated, the job posting expires after 30 days from the job's last
3097 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3098 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3099 #
3100 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3101 "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]3102 # recommended as an alternative to using the more general description
3103 # field.
3104 #
3105 # This field accepts and sanitizes HTML input, and also accepts
3106 # bold, italic, ordered list, and unordered list markup tags.
3107 #
3108 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3109 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3110 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3111 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3112 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
3113 # all compensation entries' CompensationEntry.compensation times
3114 # CompensationEntry.expected_units_per_year.
3115 #
3116 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3117 "minCompensation": { # 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]3118 # to zero and the currency code is set to match the
3119 # currency code of max_compensation.
3120 "nanos": 42, # Number of nano (10^-9) units of the amount.
3121 # The value must be between -999,999,999 and +999,999,999 inclusive.
3122 # If `units` is positive, `nanos` must be positive or zero.
3123 # If `units` is zero, `nanos` can be positive, zero, or negative.
3124 # If `units` is negative, `nanos` must be negative or zero.
3125 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3126 "units": "A String", # The whole units of the amount.
3127 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3128 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3129 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3130 "maxCompensation": { # 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]3131 # to a maximal compensation value and the currency code is set to
3132 # match the currency code of
3133 # min_compensation.
3134 "nanos": 42, # Number of nano (10^-9) units of the amount.
3135 # The value must be between -999,999,999 and +999,999,999 inclusive.
3136 # If `units` is positive, `nanos` must be positive or zero.
3137 # If `units` is zero, `nanos` can be positive, zero, or negative.
3138 # If `units` is negative, `nanos` must be negative or zero.
3139 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3140 "units": "A String", # The whole units of the amount.
3141 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3142 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3143 },
3144 },
3145 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
3146 # base compensation entry's CompensationEntry.compensation times
3147 # CompensationEntry.expected_units_per_year.
3148 #
3149 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3150 "minCompensation": { # 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]3151 # to zero and the currency code is set to match the
3152 # currency code of max_compensation.
3153 "nanos": 42, # Number of nano (10^-9) units of the amount.
3154 # The value must be between -999,999,999 and +999,999,999 inclusive.
3155 # If `units` is positive, `nanos` must be positive or zero.
3156 # If `units` is zero, `nanos` can be positive, zero, or negative.
3157 # If `units` is negative, `nanos` must be negative or zero.
3158 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3159 "units": "A String", # The whole units of the amount.
3160 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3161 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3162 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3163 "maxCompensation": { # 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]3164 # to a maximal compensation value and the currency code is set to
3165 # match the currency code of
3166 # min_compensation.
3167 "nanos": 42, # Number of nano (10^-9) units of the amount.
3168 # The value must be between -999,999,999 and +999,999,999 inclusive.
3169 # If `units` is positive, `nanos` must be positive or zero.
3170 # If `units` is zero, `nanos` can be positive, zero, or negative.
3171 # If `units` is negative, `nanos` must be negative or zero.
3172 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3173 "units": "A String", # The whole units of the amount.
3174 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3175 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3176 },
3177 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3178 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3179 #
3180 # At most one entry can be of type
3181 # CompensationInfo.CompensationType.BASE, which is
3182 # referred as ** base compensation entry ** for the job.
3183 { # A compensation entry that represents one component of compensation, such
3184 # as base pay, bonus, or other compensation type.
3185 #
3186 # Annualization: One compensation entry can be annualized if
3187 # - it contains valid amount or range.
3188 # - and its expected_units_per_year is set or can be derived.
3189 # Its annualized range is determined as (amount or range) times
3190 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3191 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3192 # indicate equity terms or provide additional context to an estimated
3193 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3194 "range": { # Compensation range. # Optional. Compensation range.
3195 "minCompensation": { # 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]3196 # to zero and the currency code is set to match the
3197 # currency code of max_compensation.
3198 "nanos": 42, # Number of nano (10^-9) units of the amount.
3199 # The value must be between -999,999,999 and +999,999,999 inclusive.
3200 # If `units` is positive, `nanos` must be positive or zero.
3201 # If `units` is zero, `nanos` can be positive, zero, or negative.
3202 # If `units` is negative, `nanos` must be negative or zero.
3203 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3204 "units": "A String", # The whole units of the amount.
3205 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3206 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3207 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3208 "maxCompensation": { # 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]3209 # to a maximal compensation value and the currency code is set to
3210 # match the currency code of
3211 # min_compensation.
3212 "nanos": 42, # Number of nano (10^-9) units of the amount.
3213 # The value must be between -999,999,999 and +999,999,999 inclusive.
3214 # If `units` is positive, `nanos` must be positive or zero.
3215 # If `units` is zero, `nanos` can be positive, zero, or negative.
3216 # If `units` is negative, `nanos` must be negative or zero.
3217 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3218 "units": "A String", # The whole units of the amount.
3219 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3220 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3221 },
3222 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3223 "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]3224 # Job.employment_types is FULLTIME, a default value is inferred
3225 # based on unit. Default values:
3226 # - HOURLY: 2080
3227 # - DAILY: 260
3228 # - WEEKLY: 52
3229 # - MONTHLY: 12
3230 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3231 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3232 "nanos": 42, # Number of nano (10^-9) units of the amount.
3233 # The value must be between -999,999,999 and +999,999,999 inclusive.
3234 # If `units` is positive, `nanos` must be positive or zero.
3235 # If `units` is zero, `nanos` can be positive, zero, or negative.
3236 # If `units` is negative, `nanos` must be negative or zero.
3237 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3238 "units": "A String", # The whole units of the amount.
3239 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3240 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3241 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3242 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3243 #
3244 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3245 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3246 #
3247 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
3248 },
3249 ],
3250 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3251 "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]3252 # position.
3253 #
3254 # The maximum number of allowed characters is 255.
3255 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3256 "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]3257 # client to identify a job. This field is intended to be used by clients
3258 # for client identification and tracking of postings. A job is not allowed
3259 # to be created if there is another job with the same [company_name],
3260 # language_code and requisition_id.
3261 #
3262 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3263 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3264 # value is the time the request arrives at the server. Invalid timestamps are
3265 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3266 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
3267 # description of the company and related information. Separate fields are
3268 # provided on the job object for responsibilities,
3269 # qualifications, and other job characteristics. Use of
3270 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3271 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3272 # This field accepts and sanitizes HTML input, and also accepts
3273 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3274 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3275 # The maximum number of allowed characters is 100,000.
3276 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3277 # "projects/api-test-project/companies/foo".
3278 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
3279 #
3280 # Derived details about the job posting.
3281 "jobCategories": [ # Job categories derived from Job.title and Job.description.
3282 "A String",
3283 ],
3284 "locations": [ # Structured locations of the job, resolved from Job.addresses.
3285 #
3286 # locations are exactly matched to Job.addresses in the same
3287 # order.
3288 { # Output only.
3289 #
3290 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3291 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
3292 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
3293 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
3294 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3295 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
3296 # location bounding box in which a circle with the specified radius
3297 # centered from LatLng covers the area associated with the job location.
3298 # For example, currently, "Mountain View, CA, USA" has a radius of
3299 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3300 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
3301 # of doubles representing degrees latitude and degrees longitude. Unless
3302 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3303 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3304 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3305 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3306 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3307 },
3308 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
3309 # such as postal delivery and payments addresses. Given a postal address,
3310 # a postal service can deliver items to a premises, P.O. Box, or other
3311 # delivery location.
3312 # Given a postal address, a postal service can deliver items to a premise, P.O.
3313 # Box or similar.
3314 # It is not intended to model geographical locations (roads, towns,
3315 # mountains).
3316 #
3317 # In typical usage an address would be created via user input or from importing
3318 # existing data, depending on the type of process.
3319 #
3320 # Advice on address input / editing:
3321 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3322 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3323 # - Users should not be presented with UI elements for input or editing of
3324 # fields outside countries where that field is used.
3325 #
3326 # For more guidance on how to use this schema, please see:
3327 # https://support.google.com/business/answer/6397478
3328 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
3329 # known). This is often the UI language of the input form or is expected
3330 # to match one of the languages used in the address' country/region, or their
3331 # transliterated equivalents.
3332 # This can affect formatting in certain countries, but is not critical
3333 # to the correctness of the data and will never affect any validation or
3334 # other non-formatting related operations.
3335 #
3336 # If this value is not known, it should be omitted (rather than specifying a
3337 # possibly incorrect default).
3338 #
3339 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
3340 "recipients": [ # Optional. The recipient at the address.
3341 # This field may, under certain circumstances, contain multiline information.
3342 # For example, it might contain "care of" information.
3343 "A String",
3344 ],
3345 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
3346 # Examples: US city, IT comune, UK post town.
3347 # In regions of the world where localities are not well defined or do not fit
3348 # into this structure well, leave locality empty and use address_lines.
3349 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
3350 # in most regions. Where it is used, the value is either a string like
3351 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
3352 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
3353 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
3354 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
3355 # is never inferred and it is up to the user to ensure the value is
3356 # correct. See http://cldr.unicode.org/ and
3357 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
3358 # for details. Example: "CH" for Switzerland.
3359 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
3360 # addresses of a country or region.
3361 # For example, this can be a state, a province, an oblast, or a prefecture.
3362 # Specifically, for Spain this is the province and not the autonomous
3363 # community (e.g. "Barcelona" and not "Catalonia").
3364 # Many countries don't use an administrative area in postal addresses. E.g.
3365 # in Switzerland this should be left unpopulated.
3366 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
3367 #
3368 # Because values in address_lines do not have type information and may
3369 # sometimes contain multiple values in a single field (e.g.
3370 # "Austin, TX"), it is important that the line order is clear. The order of
3371 # address lines should be "envelope order" for the country/region of the
3372 # address. In places where this can vary (e.g. Japan), address_language is
3373 # used to make it explicit (e.g. "ja" for large-to-small ordering and
3374 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
3375 # an address can be selected based on the language.
3376 #
3377 # The minimum permitted structural representation of an address consists
3378 # of a region_code with all remaining information placed in the
3379 # address_lines. It would be possible to format such an address very
3380 # approximately without geocoding, but no semantic reasoning could be
3381 # made about any of the address components until it was at least
3382 # partially resolved.
3383 #
3384 # Creating an address only containing a region_code and address_lines, and
3385 # then geocoding is the recommended way to handle completely unstructured
3386 # addresses (as opposed to guessing which parts of the address should be
3387 # localities or administrative areas).
3388 "A String",
3389 ],
3390 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
3391 # postal codes to be present, but where they are used, they may trigger
3392 # additional validation with other parts of the address (e.g. state/zip
3393 # validation in the U.S.A.).
3394 "organization": "A String", # Optional. The name of the organization at the address.
3395 "sublocality": "A String", # Optional. Sublocality of the address.
3396 # For example, this can be neighborhoods, boroughs, districts.
3397 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
3398 # the latest revision.
3399 #
3400 # All new revisions **must** be backward compatible with old revisions.
3401 },
3402 },
3403 ],
3404 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3405 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3406 # job. The use of this field is recommended
3407 # as an alternative to using the more general description field.
3408 #
3409 # This field accepts and sanitizes HTML input, and also accepts
3410 # bold, italic, ordered list, and unordered list markup tags.
3411 #
3412 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3413 "jobBenefits": [ # Optional. The benefits included with the job.
3414 "A String",
3415 ],
3416 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
3417 # incentives associated with the job not including salary or pay.
3418 #
3419 # The maximum number of allowed characters is 10,000.
3420 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3421 #
3422 # The visibility of the job.
3423 #
3424 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
3425 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3426 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3427 # the job is available. If this field is set, a
3428 # LocationFilter in a search query within the job region
3429 # finds this job posting if an exact location match isn't specified.
3430 # If this field is set to PostingRegion.NATION or
3431 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
3432 # to the same location level as this field is strongly recommended.
3433 "name": "A String", # Required during job update.
3434 #
3435 # The resource name for the job. This is generated by the service when a
3436 # job is created.
3437 #
3438 # The format is "projects/{project_id}/jobs/{job_id}",
3439 # for example, "projects/api-test-project/jobs/1234".
3440 #
3441 # Use of this field in job queries and API calls is preferred over the use of
3442 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3443 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3444 #
3445 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3446 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3447 #
3448 # * description
3449 # * applicationInfo.instruction
3450 # * incentives
3451 # * qualifications
3452 # * responsibilities
3453 #
3454 # HTML tags in these fields may be stripped if sanitiazation is not
3455 # disabled.
3456 #
3457 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3458 "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]3459 # more precise address for the job.
3460 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3461 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3462 "A String",
3463 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3464 "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]3465 # attributes that are not covered by the provided structured fields.
3466 #
3467 # The keys of the map are strings up to 64 bytes and must match the
3468 # pattern: a-zA-Z*. For example, key0LikeThis or
3469 # KEY_1_LIKE_THIS.
3470 #
3471 # At most 100 filterable and at most 100 unfilterable keys are supported.
3472 # For filterable `string_values`, across all keys at most 200 values are
3473 # allowed, with each string no more than 255 characters. For unfilterable
3474 # `string_values`, the maximum total size of `string_values` across all keys
3475 # is 50KB.
3476 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3477 "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]3478 # If false, values are not searchable.
3479 #
3480 # Default is false.
3481 "stringValues": [ # Optional but exactly one of string_values or long_values must
3482 # be specified.
3483 #
3484 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
3485 # `CASE_INSENSITIVE_MATCH`) search.
3486 # For filterable `string_value`s, a maximum total number of 200 values
3487 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3488 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3489 # unfilterable `string_values` is 50KB.
3490 #
3491 # Empty string is not allowed.
3492 "A String",
3493 ],
3494 "longValues": [ # Optional but exactly one of string_values or long_values must
3495 # be specified.
3496 #
3497 # This field is used to perform number range search.
3498 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
3499 #
3500 # Currently at most 1 long_values is supported.
3501 "A String",
3502 ],
3503 },
3504 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3505 "jobLevel": "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]3506 }</pre>
3507</div>
3508
3509<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3510 <code class="details" id="search">search(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3511 <pre>Searches for jobs using the provided SearchJobsRequest.
3512
3513This call constrains the visibility of jobs
3514present in the database, and only returns jobs that the caller has
3515permission to search against.
3516
3517Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3518 parent: string, Required. The resource name of the project to search within.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3519
3520The format is "projects/{project_id}", for example,
3521"projects/api-test-project". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3522 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3523 The object takes the form of:
3524
3525{ # Input only.
3526 #
3527 # The Request body of the `SearchJobs` call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3528 "orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3529 # "relevance desc".
3530 #
3531 # Supported options are:
3532 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3533 # * `"relevance desc"`: By relevance descending, as determined by the API
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3534 # algorithms. Relevance thresholding of query results is only available
3535 # with this ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3536 # * `"posting_publish_time desc"`: By Job.posting_publish_time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3537 # descending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3538 # * `"posting_update_time desc"`: By Job.posting_update_time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3539 # descending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3540 # * `"title"`: By Job.title ascending.
3541 # * `"title desc"`: By Job.title descending.
3542 # * `"annualized_base_compensation"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3543 # CompensationInfo.annualized_base_compensation_range ascending. Jobs
3544 # whose annualized base compensation is unspecified are put at the end of
3545 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3546 # * `"annualized_base_compensation desc"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3547 # CompensationInfo.annualized_base_compensation_range descending. Jobs
3548 # whose annualized base compensation is unspecified are put at the end of
3549 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3550 # * `"annualized_total_compensation"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3551 # CompensationInfo.annualized_total_compensation_range ascending. Jobs
3552 # whose annualized base compensation is unspecified are put at the end of
3553 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3554 # * `"annualized_total_compensation desc"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3555 # CompensationInfo.annualized_total_compensation_range descending. Jobs
3556 # whose annualized base compensation is unspecified are put at the end of
3557 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3558 "diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3559 # the search results. Jobs are identified as highly similar based on
3560 # their titles, job categories, and locations. Highly similar results are
3561 # clustered so that only one representative job of the cluster is
3562 # displayed to the job seeker higher up in the results, with the other jobs
3563 # being displayed lower down in the results.
3564 #
3565 # Defaults to DiversificationLevel.SIMPLE if no value
3566 # is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3567 "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.
3568 # Broadened queries append results to the end of the matching results
3569 # list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3570 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3571 # Defaults to false.
3572 "jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.
3573 #
3574 # The query required to perform a search query.
3575 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
3576 # service attempts to correct a misspelled query,
3577 # for example, "enginee" is corrected to "engineer".
3578 #
3579 # Defaults to false: a spell check is performed.
3580 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
3581 # Job.custom_attributes marked as `filterable`.
3582 #
3583 # The syntax for this expression is a subset of SQL syntax.
3584 #
3585 # Supported operators are: `=`, `!=`, `&lt;`, `&lt;=`, `&gt;`, and `&gt;=` where the
3586 # left of the operator is a custom field key and the right of the operator
3587 # is a number or a quoted string. You must escape backslash (\\) and
3588 # quote (\") characters.
3589 #
3590 # Supported functions are `LOWER([field_name])` to
3591 # perform a case insensitive match and `EMPTY([field_name])` to filter on the
3592 # existence of a key.
3593 #
3594 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
3595 # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
3596 # comparisons or functions are allowed in the expression. The expression
3597 # must be &lt; 6000 bytes in length.
3598 #
3599 # Sample Query:
3600 # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
3601 # driving_years &gt; 10`
3602 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
3603 # search against, such as EmploymentType.FULL_TIME.
3604 #
3605 # If a value is not specified, jobs in the search results includes any
3606 # employment type.
3607 #
3608 # If multiple values are specified, jobs in the search results include
3609 # any of the specified employment types.
3610 "A String",
3611 ],
3612 "queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to
3613 # better interpret the query.
3614 #
3615 # If a value isn't specified, the query language code is automatically
3616 # detected, which may not be accurate.
3617 #
3618 # Language code should be in BCP-47 format, such as "en-US" or "sr-Latn".
3619 # For more information, see
3620 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
3621 "query": "A String", # Optional. The query string that matches against the job title, description, and
3622 # location fields.
3623 #
3624 # The maximum number of allowed characters is 255.
3625 "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched
3626 # against.
3627 "endTime": "A String", # End of the period.
3628 "startTime": "A String", # Begin of the period.
3629 },
3630 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for
3631 # example, driving or public transit). Note: This only works with COMMUTE
3632 # MODE. When specified, [JobQuery.location_filters] is
3633 # ignored.
3634 #
3635 # Currently we don't support sorting by commute time.
3636 #
3637 # Parameters needed for commute search.
3638 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
3639 "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as
3640 # google.type.TimeOfDay in local time zone.
3641 #
3642 # Currently traffic model is restricted to hour level resolution.
3643 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3644 # types are google.type.Date and `google.protobuf.Timestamp`.
3645 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3646 # to allow the value "24:00:00" for scenarios like business closing time.
3647 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3648 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3649 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3650 # allow the value 60 if it allows leap-seconds.
3651 },
3652 "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the
3653 # commute time.
3654 # of doubles representing degrees latitude and degrees longitude. Unless
3655 # specified otherwise, this must conform to the
3656 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3657 # standard&lt;/a&gt;. Values must be within normalized ranges.
3658 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3659 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3660 },
3661 "allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS
3662 # coordinates) might also be returned. For city and coarser level addresses,
3663 # text matching is used. If this field is set to false or is not specified,
3664 # only jobs that include precise addresses are returned by Commute
3665 # Search.
3666 #
3667 # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not
3668 # able to calculate accurate commute times to jobs with city level and
3669 # coarser address information. Jobs with imprecise addresses will return a
3670 # `travel_duration` time of 0 regardless of distance from the job seeker.
3671 "travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
3672 # (one hour). Format is `123s`.
3673 "commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.
3674 },
3675 "jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.
3676 # See Category for more information.
3677 #
3678 # If a value is not specified, jobs from any category are searched against.
3679 #
3680 # If multiple values are specified, jobs from any of the specified
3681 # categories are searched against.
3682 "A String",
3683 ],
3684 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
3685 # for example, "en-US".
3686 #
3687 # If a value isn't specified, the search results can contain jobs in any
3688 # locale.
3689 #
3690 #
3691 # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".
3692 # For more information, see
3693 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
3694 #
3695 # At most 10 language code filters are allowed.
3696 "A String",
3697 ],
3698 "companyNames": [ # Optional. This filter specifies the company entities to search against.
3699 #
3700 # If a value isn't specified, jobs are searched for against all
3701 # companies.
3702 #
3703 # If multiple values are specified, jobs are searched against the
3704 # companies specified.
3705 #
3706 # The format is "projects/{project_id}/companies/{company_id}", for example,
3707 # "projects/api-test-project/companies/foo".
3708 #
3709 # At most 20 company filters are allowed.
3710 "A String",
3711 ],
3712 "companyDisplayNames": [ # Optional. This filter specifies the exact company display
3713 # name of the jobs to search against.
3714 #
3715 # If a value isn't specified, jobs within the search results are
3716 # associated with any company.
3717 #
3718 # If multiple values are specified, jobs within the search results may be
3719 # associated with any of the specified companies.
3720 #
3721 # At most 20 company display name filters are allowed.
3722 "A String",
3723 ],
3724 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
3725 # search against. See LocationFilter for more information.
3726 #
3727 # If a location value isn't specified, jobs fitting the other search
3728 # criteria are retrieved regardless of where they're located.
3729 #
3730 # If multiple values are specified, jobs are retrieved from any of the
3731 # specified locations. If different values are specified for the
3732 # LocationFilter.distance_in_miles parameter, the maximum provided
3733 # distance is used for all locations.
3734 #
3735 # At most 5 location filters are allowed.
3736 { # Input only.
3737 #
3738 # Geographic region of the search.
3739 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used
3740 # to address ambiguity of the user-input location, for example, "Liverpool"
3741 # against "Liverpool, NY, US" or "Liverpool, UK".
3742 #
3743 # Set this field if all the jobs to search against are from a same region,
3744 # or jobs are world-wide, but the job seeker is from a specific region.
3745 #
3746 # See http://cldr.unicode.org/ and
3747 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
3748 # for details. Example: "CH" for Switzerland.
3749 "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
3750 # search. This field's ignored if `address` is provided.
3751 # of doubles representing degrees latitude and degrees longitude. Unless
3752 # specified otherwise, this must conform to the
3753 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
3754 # standard&lt;/a&gt;. Values must be within normalized ranges.
3755 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
3756 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
3757 },
3758 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
3759 # identified as a city or smaller. When the location being searched for is a
3760 # state or larger, this field is ignored.
3761 "telecommutePreference": "A String", # Optional. Allows the client to return jobs without a
3762 # set location, specifically, telecommuting jobs (telecommuting is considered
3763 # by the service as a special location.
3764 # Job.posting_region indicates if a job permits telecommuting.
3765 # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,
3766 # telecommuting jobs are searched, and address and lat_lng are
3767 # ignored. If not set or set to
3768 # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not
3769 # searched.
3770 #
3771 # This filter can be used by itself to search exclusively for telecommuting
3772 # jobs, or it can be combined with another location
3773 # filter to search for a combination of job locations,
3774 # such as "Mountain View" or "telecommuting" jobs. However, when used in
3775 # combination with other location filters, telecommuting jobs can be
3776 # treated as less relevant than other jobs in the search response.
3777 "address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
3778 },
3779 ],
3780 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
3781 # Job.compensation_info. For example, if the filter is specified
3782 # as "Hourly job with per-hour compensation &gt; $15", only jobs meeting
3783 # these criteria are searched. If a filter isn't defined, all open jobs
3784 # are searched.
3785 #
3786 # Filter on job compensation type and amount.
3787 "units": [ # Required. Specify desired `base compensation entry's`
3788 # CompensationInfo.CompensationUnit.
3789 "A String",
3790 ],
3791 "range": { # Compensation range. # Optional. Compensation range.
3792 "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
3793 # to zero and the currency code is set to match the
3794 # currency code of max_compensation.
3795 "nanos": 42, # Number of nano (10^-9) units of the amount.
3796 # The value must be between -999,999,999 and +999,999,999 inclusive.
3797 # If `units` is positive, `nanos` must be positive or zero.
3798 # If `units` is zero, `nanos` can be positive, zero, or negative.
3799 # If `units` is negative, `nanos` must be negative or zero.
3800 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3801 "units": "A String", # The whole units of the amount.
3802 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3803 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3804 },
3805 "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
3806 # to a maximal compensation value and the currency code is set to
3807 # match the currency code of
3808 # min_compensation.
3809 "nanos": 42, # Number of nano (10^-9) units of the amount.
3810 # The value must be between -999,999,999 and +999,999,999 inclusive.
3811 # If `units` is positive, `nanos` must be positive or zero.
3812 # If `units` is zero, `nanos` can be positive, zero, or negative.
3813 # If `units` is negative, `nanos` must be negative or zero.
3814 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3815 "units": "A String", # The whole units of the amount.
3816 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3817 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3818 },
3819 },
3820 "type": "A String", # Required. Type of filter.
3821 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are
3822 # included.
3823 },
3824 },
3825 "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.
3826 # Increasing this value above the default value of 10 can increase search
3827 # response time. The value can be between 1 and 100.
3828 "histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.
3829 #
3830 # Histogram facets to be specified in SearchJobsRequest.
3831 "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,
3832 # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
3833 "A String",
3834 ],
3835 "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.
3836 # Duplicate values of CustomAttributeHistogramRequest.key are not
3837 # allowed.
3838 { # Custom attributes histogram request. An error is thrown if neither
3839 # string_value_histogram or long_value_histogram_bucketing_option has
3840 # been defined.
3841 "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for
3842 # each key as a string.
3843 "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's
3844 # filterable long custom field values, or min/max value requirements.
3845 #
3846 # Use this field to specify bucketing option for the histogram search response.
3847 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
3848 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
3849 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
3850 # [buckets_bound is supported.
3851 3.14,
3852 ],
3853 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
3854 # value of the numeric field.
3855 },
3856 "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified
3857 # without `long_value_histogram_bucketing_option`, histogram on string values
3858 # of the given `key` is triggered, otherwise histogram is performed on long
3859 # values.
3860 },
3861 ],
3862 "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.
3863 # Duplicate values of CompensationHistogramRequest.type are not allowed.
3864 { # Input only.
3865 #
3866 # Compensation based histogram request.
3867 "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.
3868 #
3869 # Use this field to specify bucketing option for the histogram search response.
3870 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
3871 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
3872 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
3873 # [buckets_bound is supported.
3874 3.14,
3875 ],
3876 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
3877 # value of the numeric field.
3878 },
3879 "type": "A String", # Required. Type of the request, representing which field the histogramming should be
3880 # performed over. A single request can only specify one histogram of each
3881 # `CompensationHistogramRequestType`.
3882 },
3883 ],
3884 },
3885 "searchMode": "A String", # Optional. Mode of a search.
3886 #
3887 # Defaults to SearchMode.JOB_SEARCH.
3888 "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the
3889 # search quality of the service. The identifiers (such as `user_id`) are
3890 # provided by users, and must be unique and consistent.
3891 #
3892 # Meta information related to the job searcher or entity
3893 # conducting the job search. This information is used to improve the
3894 # performance of the service.
3895 "userId": "A String", # Required. A unique user identification string, as determined by the client.
3896 # To have the strongest positive impact on search quality
3897 # make sure the client-level is unique.
3898 # Obfuscate this field for privacy concerns before
3899 # providing it to the service.
3900 #
3901 # If this field is not available for some reason, send "UNKNOWN". Note
3902 # that any improvements to the model for a particular tenant
3903 # site, rely on this field being set correctly to a unique user_id.
3904 #
3905 # The maximum number of allowed characters is 255.
3906 "sessionId": "A String", # Required. A unique session identification string. A session is defined as the
3907 # duration of an end user's interaction with the service over a certain
3908 # period.
3909 # Obfuscate this field for privacy concerns before
3910 # providing it to the service.
3911 #
3912 # If this field is not available for some reason, send "UNKNOWN". Note
3913 # that any improvements to the model for a particular tenant
3914 # site, rely on this field being set correctly to some unique session_id.
3915 #
3916 # The maximum number of allowed characters is 255.
3917 "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the
3918 # service.
3919 # other entity conducting the job search. Providing this information improves
3920 # the quality of the search results across devices.
3921 "deviceType": "A String", # Optional. Type of the device.
3922 "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that
3923 # distinguishes the device from other devices.
3924 },
3925 "domain": "A String", # Required. The client-defined scope or source of the service call, which typically
3926 # is the domain on
3927 # which the service has been implemented and is currently being run.
3928 #
3929 # For example, if the service is being run by client &lt;em&gt;Foo, Inc.&lt;/em&gt;, on
3930 # job board www.foo.com and career site www.bar.com, then this field is
3931 # set to "foo.com" for use on the job board, and "bar.com" for use on the
3932 # career site.
3933 #
3934 # If this field isn't available for some reason, send "UNKNOWN".
3935 # Any improvements to the model for a particular tenant site rely on this
3936 # field being set correctly to a domain.
3937 #
3938 # The maximum number of allowed characters is 255.
3939 },
3940 "pageToken": "A String", # Optional. The token specifying the current offset within
3941 # search results. See SearchJobsResponse.next_page_token for
3942 # an explanation of how to obtain the next set of query results.
3943 "disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3944 # Job.description, Job.company_display_name, Job.locations,
3945 # Job.qualifications. When disable keyword match is turned off, a
3946 # keyword match returns jobs that do not match given category filters when
3947 # there are matching keywords. For example, the query "program manager," a
3948 # result is returned even if the job posting has the title "software
3949 # developer," which does not fall into "program manager" ontology, but does
3950 # have "program manager" appearing in its description.
3951 #
3952 # For queries like "cloud" that does not contain title or
3953 # location specific ontology, jobs with "cloud" keyword matches are returned
3954 # regardless of this flag's value.
3955 #
3956 # Please use Company.keyword_searchable_custom_fields or
3957 # Company.keyword_searchable_custom_attributes if company specific
3958 # globally matched custom field/attribute string values is needed. Enabling
3959 # keyword match improves recall of subsequent search requests.
3960 #
3961 # Defaults to false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3962 "requirePreciseResultSize": 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]3963 # count of the first 300 results. Setting this to `true` ensures
3964 # consistency in the number of results per page. Best practice is to set this
3965 # value to true if a client allows users to jump directly to a
3966 # non-sequential search results page.
3967 #
3968 # Enabling this flag may adversely impact performance.
3969 #
3970 # Defaults to false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3971 "jobView": "A String", # Optional. The desired job attributes returned for jobs in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3972 # search response. Defaults to JobView.SMALL if no value is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3973 "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]3974 # location, amongst the jobs deemed by the API as relevant) in search
3975 # results. This field is only considered if page_token is unset.
3976 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3977 # The maximum allowed value is 5000. Otherwise an error is thrown.
3978 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3979 # For example, 0 means to return results starting from the first matching
3980 # job, and 10 means to return from the 11th job. This can be used for
3981 # pagination, (for example, pageSize = 10 and offset = 10 means to return
3982 # from the second page).
3983 }
3984
3985 x__xgafv: string, V1 error format.
3986 Allowed values
3987 1 - v1 error format
3988 2 - v2 error format
3989
3990Returns:
3991 An object of the form:
3992
3993 { # Output only.
3994 #
3995 # Response for SearchJob method.
3996 "nextPageToken": "A String", # The token that specifies the starting position of the next page of results.
3997 # This field is empty if there are no more results.
3998 "spellCorrection": { # Output only. # The spell checking result, and correction.
3999 #
4000 # Spell check result.
4001 "corrected": True or False, # Indicates if the query was corrected by the spell checker.
4002 "correctedText": "A String", # Correction output consisting of the corrected keyword string.
4003 },
4004 "totalSize": 42, # The precise result count, which is available only if the client set
4005 # enable_precise_result_size to `true`, or if the response
4006 # is the last page of results. Otherwise, the value is `-1`.
4007 "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.
4008 { # Output only.
4009 #
4010 # Job entry with metadata inside SearchJobsResponse.
4011 "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar
4012 # fields that most closely match a search query's keywords, if available.
4013 # All HTML tags in the original fields are stripped when returned in this
4014 # field, and matching query keywords are enclosed in HTML bold tags.
4015 "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.
4016 # or "job requisition"). A job belongs to a Company, which is the hiring
4017 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4018 "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]4019 # any requirements for fluency that are associated with the job.
4020 #
4021 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
4022 # For more information, see
4023 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
4024 # class="external" target="_blank" }.
4025 #
4026 # If this field is unspecified and Job.description is present, detected
4027 # language code based on Job.description is assigned, otherwise
4028 # defaults to 'en_US'.
4029 "addresses": [ # Optional but strongly recommended for the best service experience.
4030 #
4031 # Location(s) where the employer is looking to hire for this job posting.
4032 #
4033 # Specifying the full street address(es) of the hiring location enables
4034 # better API results, especially job searches by commute time.
4035 #
4036 # At most 50 locations are allowed for best search performance. If a job has
4037 # more locations, it is suggested to split it into multiple jobs with unique
4038 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
4039 # multiple jobs with the same company_name, language_code and
4040 # requisition_id are not allowed. If the original requisition_id must
4041 # be preserved, a custom field should be used for storage. It is also
4042 # suggested to group the locations that close to each other in the same job
4043 # for better search experience.
4044 #
4045 # The maximum number of allowed characters is 500.
4046 "A String",
4047 ],
4048 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4049 "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]4050 # The value determines the sort order of the jobs returned when searching for
4051 # jobs using the featured jobs search call, with higher promotional values
4052 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4053 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4054 #
4055 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4056 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4057 # full time or
4058 # part time.
4059 "A String",
4060 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4061 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4062 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4063 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4064 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4065 # Job application information.
4066 "instruction": "A String", # Optional but at least one of uris,
4067 # emails or instruction must be
4068 # specified.
4069 #
4070 # Use this field to provide instructions, such as "Mail your application
4071 # to ...", that a candidate can follow to apply for the job.
4072 #
4073 # This field accepts and sanitizes HTML input, and also accepts
4074 # bold, italic, ordered list, and unordered list markup tags.
4075 #
4076 # The maximum number of allowed characters is 3,000.
4077 "uris": [ # Optional but at least one of uris,
4078 # emails or instruction must be
4079 # specified.
4080 #
4081 # Use this URI field to direct an applicant to a website, for example to
4082 # link to an online application form.
4083 #
4084 # The maximum number of allowed characters for each entry is 2,000.
4085 "A String",
4086 ],
4087 "emails": [ # Optional but at least one of uris,
4088 # emails or instruction must be
4089 # specified.
4090 #
4091 # Use this field to specify email address(es) to which resumes or
4092 # applications can be sent.
4093 #
4094 # The maximum number of allowed characters for each entry is 255.
4095 "A String",
4096 ],
4097 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4098 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
4099 # experience.
4100 #
4101 # The expiration timestamp of the job. After this timestamp, the
4102 # job is marked as expired, and it no longer appears in search results. The
4103 # expired job can't be deleted or listed by the DeleteJob and
4104 # ListJobs APIs, but it can be retrieved with the GetJob API or
4105 # updated with the UpdateJob API. An expired job can be updated and
4106 # opened again by using a future expiration timestamp. Updating an expired
4107 # job fails if there is another existing open job with same company_name,
4108 # language_code and requisition_id.
4109 #
4110 # The expired jobs are retained in our system for 90 days. However, the
4111 # overall expired job count cannot exceed 3 times the maximum of open jobs
4112 # count over the past week, otherwise jobs with earlier expire time are
4113 # cleaned first. Expired jobs are no longer accessible after they are cleaned
4114 # out.
4115 #
4116 # Invalid timestamps are ignored, and treated as expire time not provided.
4117 #
4118 # Timestamp before the instant request is made is considered valid, the job
4119 # will be treated as expired immediately.
4120 #
4121 # If this value is not provided at the time of job creation or is invalid,
4122 # the job posting expires after 30 days from the job's creation time. For
4123 # example, if the job was created on 2017/01/01 13:00AM UTC with an
4124 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
4125 #
4126 # If this value is not provided on job update, it depends on the field masks
4127 # set by UpdateJobRequest.update_mask. If the field masks include
4128 # expiry_time, or the masks are empty meaning that every field is
4129 # updated, the job posting expires after 30 days from the job's last
4130 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4131 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4132 #
4133 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4134 "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]4135 # recommended as an alternative to using the more general description
4136 # field.
4137 #
4138 # This field accepts and sanitizes HTML input, and also accepts
4139 # bold, italic, ordered list, and unordered list markup tags.
4140 #
4141 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4142 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4143 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4144 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4145 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
4146 # all compensation entries' CompensationEntry.compensation times
4147 # CompensationEntry.expected_units_per_year.
4148 #
4149 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4150 "minCompensation": { # 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]4151 # to zero and the currency code is set to match the
4152 # currency code of max_compensation.
4153 "nanos": 42, # Number of nano (10^-9) units of the amount.
4154 # The value must be between -999,999,999 and +999,999,999 inclusive.
4155 # If `units` is positive, `nanos` must be positive or zero.
4156 # If `units` is zero, `nanos` can be positive, zero, or negative.
4157 # If `units` is negative, `nanos` must be negative or zero.
4158 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4159 "units": "A String", # The whole units of the amount.
4160 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4161 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4162 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4163 "maxCompensation": { # 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]4164 # to a maximal compensation value and the currency code is set to
4165 # match the currency code of
4166 # min_compensation.
4167 "nanos": 42, # Number of nano (10^-9) units of the amount.
4168 # The value must be between -999,999,999 and +999,999,999 inclusive.
4169 # If `units` is positive, `nanos` must be positive or zero.
4170 # If `units` is zero, `nanos` can be positive, zero, or negative.
4171 # If `units` is negative, `nanos` must be negative or zero.
4172 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4173 "units": "A String", # The whole units of the amount.
4174 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4175 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4176 },
4177 },
4178 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
4179 # base compensation entry's CompensationEntry.compensation times
4180 # CompensationEntry.expected_units_per_year.
4181 #
4182 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4183 "minCompensation": { # 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]4184 # to zero and the currency code is set to match the
4185 # currency code of max_compensation.
4186 "nanos": 42, # Number of nano (10^-9) units of the amount.
4187 # The value must be between -999,999,999 and +999,999,999 inclusive.
4188 # If `units` is positive, `nanos` must be positive or zero.
4189 # If `units` is zero, `nanos` can be positive, zero, or negative.
4190 # If `units` is negative, `nanos` must be negative or zero.
4191 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4192 "units": "A String", # The whole units of the amount.
4193 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4194 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4195 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4196 "maxCompensation": { # 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]4197 # to a maximal compensation value and the currency code is set to
4198 # match the currency code of
4199 # min_compensation.
4200 "nanos": 42, # Number of nano (10^-9) units of the amount.
4201 # The value must be between -999,999,999 and +999,999,999 inclusive.
4202 # If `units` is positive, `nanos` must be positive or zero.
4203 # If `units` is zero, `nanos` can be positive, zero, or negative.
4204 # If `units` is negative, `nanos` must be negative or zero.
4205 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4206 "units": "A String", # The whole units of the amount.
4207 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4208 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4209 },
4210 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4211 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4212 #
4213 # At most one entry can be of type
4214 # CompensationInfo.CompensationType.BASE, which is
4215 # referred as ** base compensation entry ** for the job.
4216 { # A compensation entry that represents one component of compensation, such
4217 # as base pay, bonus, or other compensation type.
4218 #
4219 # Annualization: One compensation entry can be annualized if
4220 # - it contains valid amount or range.
4221 # - and its expected_units_per_year is set or can be derived.
4222 # Its annualized range is determined as (amount or range) times
4223 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4224 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4225 # indicate equity terms or provide additional context to an estimated
4226 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4227 "range": { # Compensation range. # Optional. Compensation range.
4228 "minCompensation": { # 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]4229 # to zero and the currency code is set to match the
4230 # currency code of max_compensation.
4231 "nanos": 42, # Number of nano (10^-9) units of the amount.
4232 # The value must be between -999,999,999 and +999,999,999 inclusive.
4233 # If `units` is positive, `nanos` must be positive or zero.
4234 # If `units` is zero, `nanos` can be positive, zero, or negative.
4235 # If `units` is negative, `nanos` must be negative or zero.
4236 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4237 "units": "A String", # The whole units of the amount.
4238 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4239 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4240 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4241 "maxCompensation": { # 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]4242 # to a maximal compensation value and the currency code is set to
4243 # match the currency code of
4244 # min_compensation.
4245 "nanos": 42, # Number of nano (10^-9) units of the amount.
4246 # The value must be between -999,999,999 and +999,999,999 inclusive.
4247 # If `units` is positive, `nanos` must be positive or zero.
4248 # If `units` is zero, `nanos` can be positive, zero, or negative.
4249 # If `units` is negative, `nanos` must be negative or zero.
4250 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4251 "units": "A String", # The whole units of the amount.
4252 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4253 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4254 },
4255 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4256 "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]4257 # Job.employment_types is FULLTIME, a default value is inferred
4258 # based on unit. Default values:
4259 # - HOURLY: 2080
4260 # - DAILY: 260
4261 # - WEEKLY: 52
4262 # - MONTHLY: 12
4263 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4264 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4265 "nanos": 42, # Number of nano (10^-9) units of the amount.
4266 # The value must be between -999,999,999 and +999,999,999 inclusive.
4267 # If `units` is positive, `nanos` must be positive or zero.
4268 # If `units` is zero, `nanos` can be positive, zero, or negative.
4269 # If `units` is negative, `nanos` must be negative or zero.
4270 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4271 "units": "A String", # The whole units of the amount.
4272 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4273 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4274 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4275 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4276 #
4277 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4278 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4279 #
4280 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
4281 },
4282 ],
4283 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4284 "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]4285 # position.
4286 #
4287 # The maximum number of allowed characters is 255.
4288 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4289 "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]4290 # client to identify a job. This field is intended to be used by clients
4291 # for client identification and tracking of postings. A job is not allowed
4292 # to be created if there is another job with the same [company_name],
4293 # language_code and requisition_id.
4294 #
4295 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4296 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4297 # value is the time the request arrives at the server. Invalid timestamps are
4298 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4299 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
4300 # description of the company and related information. Separate fields are
4301 # provided on the job object for responsibilities,
4302 # qualifications, and other job characteristics. Use of
4303 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4304 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4305 # This field accepts and sanitizes HTML input, and also accepts
4306 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4307 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4308 # The maximum number of allowed characters is 100,000.
4309 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4310 # "projects/api-test-project/companies/foo".
4311 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
4312 #
4313 # Derived details about the job posting.
4314 "jobCategories": [ # Job categories derived from Job.title and Job.description.
4315 "A String",
4316 ],
4317 "locations": [ # Structured locations of the job, resolved from Job.addresses.
4318 #
4319 # locations are exactly matched to Job.addresses in the same
4320 # order.
4321 { # Output only.
4322 #
4323 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4324 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
4325 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
4326 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
4327 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4328 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
4329 # location bounding box in which a circle with the specified radius
4330 # centered from LatLng covers the area associated with the job location.
4331 # For example, currently, "Mountain View, CA, USA" has a radius of
4332 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4333 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
4334 # of doubles representing degrees latitude and degrees longitude. Unless
4335 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4336 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
4337 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4338 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
4339 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
4340 },
4341 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
4342 # such as postal delivery and payments addresses. Given a postal address,
4343 # a postal service can deliver items to a premises, P.O. Box, or other
4344 # delivery location.
4345 # Given a postal address, a postal service can deliver items to a premise, P.O.
4346 # Box or similar.
4347 # It is not intended to model geographical locations (roads, towns,
4348 # mountains).
4349 #
4350 # In typical usage an address would be created via user input or from importing
4351 # existing data, depending on the type of process.
4352 #
4353 # Advice on address input / editing:
4354 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4355 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4356 # - Users should not be presented with UI elements for input or editing of
4357 # fields outside countries where that field is used.
4358 #
4359 # For more guidance on how to use this schema, please see:
4360 # https://support.google.com/business/answer/6397478
4361 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
4362 # known). This is often the UI language of the input form or is expected
4363 # to match one of the languages used in the address' country/region, or their
4364 # transliterated equivalents.
4365 # This can affect formatting in certain countries, but is not critical
4366 # to the correctness of the data and will never affect any validation or
4367 # other non-formatting related operations.
4368 #
4369 # If this value is not known, it should be omitted (rather than specifying a
4370 # possibly incorrect default).
4371 #
4372 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
4373 "recipients": [ # Optional. The recipient at the address.
4374 # This field may, under certain circumstances, contain multiline information.
4375 # For example, it might contain "care of" information.
4376 "A String",
4377 ],
4378 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
4379 # Examples: US city, IT comune, UK post town.
4380 # In regions of the world where localities are not well defined or do not fit
4381 # into this structure well, leave locality empty and use address_lines.
4382 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
4383 # in most regions. Where it is used, the value is either a string like
4384 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
4385 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
4386 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
4387 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
4388 # is never inferred and it is up to the user to ensure the value is
4389 # correct. See http://cldr.unicode.org/ and
4390 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
4391 # for details. Example: "CH" for Switzerland.
4392 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
4393 # addresses of a country or region.
4394 # For example, this can be a state, a province, an oblast, or a prefecture.
4395 # Specifically, for Spain this is the province and not the autonomous
4396 # community (e.g. "Barcelona" and not "Catalonia").
4397 # Many countries don't use an administrative area in postal addresses. E.g.
4398 # in Switzerland this should be left unpopulated.
4399 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
4400 #
4401 # Because values in address_lines do not have type information and may
4402 # sometimes contain multiple values in a single field (e.g.
4403 # "Austin, TX"), it is important that the line order is clear. The order of
4404 # address lines should be "envelope order" for the country/region of the
4405 # address. In places where this can vary (e.g. Japan), address_language is
4406 # used to make it explicit (e.g. "ja" for large-to-small ordering and
4407 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
4408 # an address can be selected based on the language.
4409 #
4410 # The minimum permitted structural representation of an address consists
4411 # of a region_code with all remaining information placed in the
4412 # address_lines. It would be possible to format such an address very
4413 # approximately without geocoding, but no semantic reasoning could be
4414 # made about any of the address components until it was at least
4415 # partially resolved.
4416 #
4417 # Creating an address only containing a region_code and address_lines, and
4418 # then geocoding is the recommended way to handle completely unstructured
4419 # addresses (as opposed to guessing which parts of the address should be
4420 # localities or administrative areas).
4421 "A String",
4422 ],
4423 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
4424 # postal codes to be present, but where they are used, they may trigger
4425 # additional validation with other parts of the address (e.g. state/zip
4426 # validation in the U.S.A.).
4427 "organization": "A String", # Optional. The name of the organization at the address.
4428 "sublocality": "A String", # Optional. Sublocality of the address.
4429 # For example, this can be neighborhoods, boroughs, districts.
4430 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
4431 # the latest revision.
4432 #
4433 # All new revisions **must** be backward compatible with old revisions.
4434 },
4435 },
4436 ],
4437 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4438 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4439 # job. The use of this field is recommended
4440 # as an alternative to using the more general description field.
4441 #
4442 # This field accepts and sanitizes HTML input, and also accepts
4443 # bold, italic, ordered list, and unordered list markup tags.
4444 #
4445 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4446 "jobBenefits": [ # Optional. The benefits included with the job.
4447 "A String",
4448 ],
4449 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
4450 # incentives associated with the job not including salary or pay.
4451 #
4452 # The maximum number of allowed characters is 10,000.
4453 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4454 #
4455 # The visibility of the job.
4456 #
4457 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
4458 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4459 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4460 # the job is available. If this field is set, a
4461 # LocationFilter in a search query within the job region
4462 # finds this job posting if an exact location match isn't specified.
4463 # If this field is set to PostingRegion.NATION or
4464 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
4465 # to the same location level as this field is strongly recommended.
4466 "name": "A String", # Required during job update.
4467 #
4468 # The resource name for the job. This is generated by the service when a
4469 # job is created.
4470 #
4471 # The format is "projects/{project_id}/jobs/{job_id}",
4472 # for example, "projects/api-test-project/jobs/1234".
4473 #
4474 # Use of this field in job queries and API calls is preferred over the use of
4475 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4476 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4477 #
4478 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4479 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4480 #
4481 # * description
4482 # * applicationInfo.instruction
4483 # * incentives
4484 # * qualifications
4485 # * responsibilities
4486 #
4487 # HTML tags in these fields may be stripped if sanitiazation is not
4488 # disabled.
4489 #
4490 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4491 "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]4492 # more precise address for the job.
4493 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4494 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4495 "A String",
4496 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4497 "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]4498 # attributes that are not covered by the provided structured fields.
4499 #
4500 # The keys of the map are strings up to 64 bytes and must match the
4501 # pattern: a-zA-Z*. For example, key0LikeThis or
4502 # KEY_1_LIKE_THIS.
4503 #
4504 # At most 100 filterable and at most 100 unfilterable keys are supported.
4505 # For filterable `string_values`, across all keys at most 200 values are
4506 # allowed, with each string no more than 255 characters. For unfilterable
4507 # `string_values`, the maximum total size of `string_values` across all keys
4508 # is 50KB.
4509 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4510 "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]4511 # If false, values are not searchable.
4512 #
4513 # Default is false.
4514 "stringValues": [ # Optional but exactly one of string_values or long_values must
4515 # be specified.
4516 #
4517 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
4518 # `CASE_INSENSITIVE_MATCH`) search.
4519 # For filterable `string_value`s, a maximum total number of 200 values
4520 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4521 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4522 # unfilterable `string_values` is 50KB.
4523 #
4524 # Empty string is not allowed.
4525 "A String",
4526 ],
4527 "longValues": [ # Optional but exactly one of string_values or long_values must
4528 # be specified.
4529 #
4530 # This field is used to perform number range search.
4531 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
4532 #
4533 # Currently at most 1 long_values is supported.
4534 "A String",
4535 ],
4536 },
4537 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4538 "jobLevel": "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]4539 },
4540 "commuteInfo": { # Output only. # Commute information which is generated based on specified
4541 # CommuteFilter.
4542 #
4543 # Commute details related to this job.
4544 "travelDuration": "A String", # The number of seconds required to travel to the job location from the
4545 # query location. A duration of 0 seconds indicates that the job is not
4546 # reachable within the requested duration, but was returned as part of an
4547 # expanded query.
4548 "jobLocation": { # Output only. # Location used as the destination in the commute calculation.
4549 #
4550 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4551 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
4552 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
4553 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
4554 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4555 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
4556 # location bounding box in which a circle with the specified radius
4557 # centered from LatLng covers the area associated with the job location.
4558 # For example, currently, "Mountain View, CA, USA" has a radius of
4559 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4560 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
4561 # of doubles representing degrees latitude and degrees longitude. Unless
4562 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4563 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
4564 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4565 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
4566 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
4567 },
4568 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
4569 # such as postal delivery and payments addresses. Given a postal address,
4570 # a postal service can deliver items to a premises, P.O. Box, or other
4571 # delivery location.
4572 # Given a postal address, a postal service can deliver items to a premise, P.O.
4573 # Box or similar.
4574 # It is not intended to model geographical locations (roads, towns,
4575 # mountains).
4576 #
4577 # In typical usage an address would be created via user input or from importing
4578 # existing data, depending on the type of process.
4579 #
4580 # Advice on address input / editing:
4581 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4582 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4583 # - Users should not be presented with UI elements for input or editing of
4584 # fields outside countries where that field is used.
4585 #
4586 # For more guidance on how to use this schema, please see:
4587 # https://support.google.com/business/answer/6397478
4588 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
4589 # known). This is often the UI language of the input form or is expected
4590 # to match one of the languages used in the address' country/region, or their
4591 # transliterated equivalents.
4592 # This can affect formatting in certain countries, but is not critical
4593 # to the correctness of the data and will never affect any validation or
4594 # other non-formatting related operations.
4595 #
4596 # If this value is not known, it should be omitted (rather than specifying a
4597 # possibly incorrect default).
4598 #
4599 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
4600 "recipients": [ # Optional. The recipient at the address.
4601 # This field may, under certain circumstances, contain multiline information.
4602 # For example, it might contain "care of" information.
4603 "A String",
4604 ],
4605 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
4606 # Examples: US city, IT comune, UK post town.
4607 # In regions of the world where localities are not well defined or do not fit
4608 # into this structure well, leave locality empty and use address_lines.
4609 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
4610 # in most regions. Where it is used, the value is either a string like
4611 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
4612 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
4613 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
4614 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
4615 # is never inferred and it is up to the user to ensure the value is
4616 # correct. See http://cldr.unicode.org/ and
4617 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
4618 # for details. Example: "CH" for Switzerland.
4619 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
4620 # addresses of a country or region.
4621 # For example, this can be a state, a province, an oblast, or a prefecture.
4622 # Specifically, for Spain this is the province and not the autonomous
4623 # community (e.g. "Barcelona" and not "Catalonia").
4624 # Many countries don't use an administrative area in postal addresses. E.g.
4625 # in Switzerland this should be left unpopulated.
4626 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
4627 #
4628 # Because values in address_lines do not have type information and may
4629 # sometimes contain multiple values in a single field (e.g.
4630 # "Austin, TX"), it is important that the line order is clear. The order of
4631 # address lines should be "envelope order" for the country/region of the
4632 # address. In places where this can vary (e.g. Japan), address_language is
4633 # used to make it explicit (e.g. "ja" for large-to-small ordering and
4634 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
4635 # an address can be selected based on the language.
4636 #
4637 # The minimum permitted structural representation of an address consists
4638 # of a region_code with all remaining information placed in the
4639 # address_lines. It would be possible to format such an address very
4640 # approximately without geocoding, but no semantic reasoning could be
4641 # made about any of the address components until it was at least
4642 # partially resolved.
4643 #
4644 # Creating an address only containing a region_code and address_lines, and
4645 # then geocoding is the recommended way to handle completely unstructured
4646 # addresses (as opposed to guessing which parts of the address should be
4647 # localities or administrative areas).
4648 "A String",
4649 ],
4650 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
4651 # postal codes to be present, but where they are used, they may trigger
4652 # additional validation with other parts of the address (e.g. state/zip
4653 # validation in the U.S.A.).
4654 "organization": "A String", # Optional. The name of the organization at the address.
4655 "sublocality": "A String", # Optional. Sublocality of the address.
4656 # For example, this can be neighborhoods, boroughs, districts.
4657 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
4658 # the latest revision.
4659 #
4660 # All new revisions **must** be backward compatible with old revisions.
4661 },
4662 },
4663 },
4664 "jobSummary": "A String", # A summary of the job with core information that's displayed on the search
4665 # results listing page.
4666 "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most
4667 # closely matching a search query's keywords, if available. The matching
4668 # query keywords are enclosed in HTML bold tags.
4669 },
4670 ],
4671 "histogramResults": { # Output only. # The histogram results that match specified
4672 # SearchJobsRequest.histogram_facets.
4673 #
4674 # Histogram results that match HistogramFacets specified in
4675 # SearchJobsRequest.
4676 "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match
4677 # HistogramFacets.custom_attribute_histogram_facets.
4678 { # Output only.
4679 #
4680 # Custom attribute histogram result.
4681 "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for
4682 # custom attribute long values associated with `key`.
4683 #
4684 # Custom numeric bucketing result.
4685 "counts": [ # Count within each bucket. Its size is the length of
4686 # NumericBucketingOption.bucket_bounds plus 1.
4687 { # Represents count of jobs within one bucket.
4688 "count": 42, # Number of jobs whose numeric field value fall into `range`.
4689 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
4690 # that is, the count represents number of jobs in this range.
4691 "to": 3.14, # Ending value of the bucket range.
4692 "from": 3.14, # Starting value of the bucket range.
4693 },
4694 },
4695 ],
4696 "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if
4697 # [NumericBucketingOption.requires_min_max] is set to true.
4698 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
4699 # [NumericBucketingOption.requires_min_max] is set to true.
4700 },
4701 "stringValueHistogramResult": { # Stores a map from the values of string custom field associated
4702 # with `key` to the number of jobs with that value in this histogram result.
4703 "a_key": 42,
4704 },
4705 "key": "A String", # Stores the key of custom attribute the histogram is performed on.
4706 },
4707 ],
4708 "simpleHistogramResults": [ # Specifies histogram results that matches
4709 # HistogramFacets.simple_histogram_facets.
4710 { # Output only.
4711 #
4712 # Result of a histogram call. The response contains the histogram map for the
4713 # search type specified by HistogramResult.field.
4714 # The response is a map of each filter value to the corresponding count of
4715 # jobs for that filter.
4716 "values": { # A map from the values of field to the number of jobs with that value
4717 # in this search result.
4718 #
4719 # Key: search type (filter names, such as the companyName).
4720 #
4721 # Values: the count of jobs that match the filter for this search.
4722 "a_key": 42,
4723 },
4724 "searchType": "A String", # The Histogram search filters.
4725 },
4726 ],
4727 "compensationHistogramResults": [ # Specifies compensation field-based histogram results that match
4728 # HistogramFacets.compensation_histogram_requests.
4729 { # Output only.
4730 #
4731 # Compensation based histogram result.
4732 "type": "A String", # Type of the request, corresponding to
4733 # CompensationHistogramRequest.type.
4734 "result": { # Output only. # Histogram result.
4735 #
4736 # Custom numeric bucketing result.
4737 "counts": [ # Count within each bucket. Its size is the length of
4738 # NumericBucketingOption.bucket_bounds plus 1.
4739 { # Represents count of jobs within one bucket.
4740 "count": 42, # Number of jobs whose numeric field value fall into `range`.
4741 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
4742 # that is, the count represents number of jobs in this range.
4743 "to": 3.14, # Ending value of the bucket range.
4744 "from": 3.14, # Starting value of the bucket range.
4745 },
4746 },
4747 ],
4748 "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if
4749 # [NumericBucketingOption.requires_min_max] is set to true.
4750 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
4751 # [NumericBucketingOption.requires_min_max] is set to true.
4752 },
4753 },
4754 ],
4755 },
4756 "estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.
4757 #
4758 # This number is not guaranteed to be accurate. For accurate results,
4759 # see enable_precise_result_size.
4760 "broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the
4761 # broadened query. This number indicates how many of the jobs returned in the
4762 # jobs field are from the broadened query. These results are always at the
4763 # end of the jobs list. In particular, a value of 0, or if the field isn't
4764 # set, all the jobs in the jobs list are from the original
4765 # (without broadening) query. If this field is non-zero, subsequent requests
4766 # with offset after this result set should contain all broadened results.
4767 "locationFilters": [ # The location filters that the service applied to the specified query. If
4768 # any filters are lat-lng based, the JobLocation.location_type is
4769 # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.
4770 { # Output only.
4771 #
4772 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4773 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
4774 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
4775 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
4776 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4777 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
4778 # location bounding box in which a circle with the specified radius
4779 # centered from LatLng covers the area associated with the job location.
4780 # For example, currently, "Mountain View, CA, USA" has a radius of
4781 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4782 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
4783 # of doubles representing degrees latitude and degrees longitude. Unless
4784 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4785 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
4786 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4787 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
4788 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
4789 },
4790 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
4791 # such as postal delivery and payments addresses. Given a postal address,
4792 # a postal service can deliver items to a premises, P.O. Box, or other
4793 # delivery location.
4794 # Given a postal address, a postal service can deliver items to a premise, P.O.
4795 # Box or similar.
4796 # It is not intended to model geographical locations (roads, towns,
4797 # mountains).
4798 #
4799 # In typical usage an address would be created via user input or from importing
4800 # existing data, depending on the type of process.
4801 #
4802 # Advice on address input / editing:
4803 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4804 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4805 # - Users should not be presented with UI elements for input or editing of
4806 # fields outside countries where that field is used.
4807 #
4808 # For more guidance on how to use this schema, please see:
4809 # https://support.google.com/business/answer/6397478
4810 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
4811 # known). This is often the UI language of the input form or is expected
4812 # to match one of the languages used in the address' country/region, or their
4813 # transliterated equivalents.
4814 # This can affect formatting in certain countries, but is not critical
4815 # to the correctness of the data and will never affect any validation or
4816 # other non-formatting related operations.
4817 #
4818 # If this value is not known, it should be omitted (rather than specifying a
4819 # possibly incorrect default).
4820 #
4821 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
4822 "recipients": [ # Optional. The recipient at the address.
4823 # This field may, under certain circumstances, contain multiline information.
4824 # For example, it might contain "care of" information.
4825 "A String",
4826 ],
4827 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
4828 # Examples: US city, IT comune, UK post town.
4829 # In regions of the world where localities are not well defined or do not fit
4830 # into this structure well, leave locality empty and use address_lines.
4831 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
4832 # in most regions. Where it is used, the value is either a string like
4833 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
4834 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
4835 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
4836 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
4837 # is never inferred and it is up to the user to ensure the value is
4838 # correct. See http://cldr.unicode.org/ and
4839 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
4840 # for details. Example: "CH" for Switzerland.
4841 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
4842 # addresses of a country or region.
4843 # For example, this can be a state, a province, an oblast, or a prefecture.
4844 # Specifically, for Spain this is the province and not the autonomous
4845 # community (e.g. "Barcelona" and not "Catalonia").
4846 # Many countries don't use an administrative area in postal addresses. E.g.
4847 # in Switzerland this should be left unpopulated.
4848 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
4849 #
4850 # Because values in address_lines do not have type information and may
4851 # sometimes contain multiple values in a single field (e.g.
4852 # "Austin, TX"), it is important that the line order is clear. The order of
4853 # address lines should be "envelope order" for the country/region of the
4854 # address. In places where this can vary (e.g. Japan), address_language is
4855 # used to make it explicit (e.g. "ja" for large-to-small ordering and
4856 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
4857 # an address can be selected based on the language.
4858 #
4859 # The minimum permitted structural representation of an address consists
4860 # of a region_code with all remaining information placed in the
4861 # address_lines. It would be possible to format such an address very
4862 # approximately without geocoding, but no semantic reasoning could be
4863 # made about any of the address components until it was at least
4864 # partially resolved.
4865 #
4866 # Creating an address only containing a region_code and address_lines, and
4867 # then geocoding is the recommended way to handle completely unstructured
4868 # addresses (as opposed to guessing which parts of the address should be
4869 # localities or administrative areas).
4870 "A String",
4871 ],
4872 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
4873 # postal codes to be present, but where they are used, they may trigger
4874 # additional validation with other parts of the address (e.g. state/zip
4875 # validation in the U.S.A.).
4876 "organization": "A String", # Optional. The name of the organization at the address.
4877 "sublocality": "A String", # Optional. Sublocality of the address.
4878 # For example, this can be neighborhoods, boroughs, districts.
4879 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
4880 # the latest revision.
4881 #
4882 # All new revisions **must** be backward compatible with old revisions.
4883 },
4884 },
4885 ],
4886 "metadata": { # Output only. # Additional information for the API invocation, such as the request
4887 # tracking id.
4888 #
4889 # Additional information returned to client, such as debugging information.
4890 "requestId": "A String", # A unique id associated with this call.
4891 # This id is logged for tracking purposes.
4892 },
4893 }</pre>
4894</div>
4895
4896<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4897 <code class="details" id="searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4898 <pre>Searches for jobs using the provided SearchJobsRequest.
4899
4900This API call is intended for the use case of targeting passive job
4901seekers (for example, job seekers who have signed up to receive email
4902alerts about potential job opportunities), and has different algorithmic
4903adjustments that are targeted to passive job seekers.
4904
4905This call constrains the visibility of jobs
4906present in the database, and only returns jobs the caller has
4907permission to search against.
4908
4909Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4910 parent: string, Required. The resource name of the project to search within.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4911
4912The format is "projects/{project_id}", for example,
4913"projects/api-test-project". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4914 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4915 The object takes the form of:
4916
4917{ # Input only.
4918 #
4919 # The Request body of the `SearchJobs` call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4920 "orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4921 # "relevance desc".
4922 #
4923 # Supported options are:
4924 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4925 # * `"relevance desc"`: By relevance descending, as determined by the API
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4926 # algorithms. Relevance thresholding of query results is only available
4927 # with this ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4928 # * `"posting_publish_time desc"`: By Job.posting_publish_time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4929 # descending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4930 # * `"posting_update_time desc"`: By Job.posting_update_time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4931 # descending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4932 # * `"title"`: By Job.title ascending.
4933 # * `"title desc"`: By Job.title descending.
4934 # * `"annualized_base_compensation"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4935 # CompensationInfo.annualized_base_compensation_range ascending. Jobs
4936 # whose annualized base compensation is unspecified are put at the end of
4937 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4938 # * `"annualized_base_compensation desc"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4939 # CompensationInfo.annualized_base_compensation_range descending. Jobs
4940 # whose annualized base compensation is unspecified are put at the end of
4941 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4942 # * `"annualized_total_compensation"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4943 # CompensationInfo.annualized_total_compensation_range ascending. Jobs
4944 # whose annualized base compensation is unspecified are put at the end of
4945 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4946 # * `"annualized_total_compensation desc"`: By job's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4947 # CompensationInfo.annualized_total_compensation_range descending. Jobs
4948 # whose annualized base compensation is unspecified are put at the end of
4949 # search results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4950 "diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4951 # the search results. Jobs are identified as highly similar based on
4952 # their titles, job categories, and locations. Highly similar results are
4953 # clustered so that only one representative job of the cluster is
4954 # displayed to the job seeker higher up in the results, with the other jobs
4955 # being displayed lower down in the results.
4956 #
4957 # Defaults to DiversificationLevel.SIMPLE if no value
4958 # is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4959 "enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.
4960 # Broadened queries append results to the end of the matching results
4961 # list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4962 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4963 # Defaults to false.
4964 "jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.
4965 #
4966 # The query required to perform a search query.
4967 "disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the
4968 # service attempts to correct a misspelled query,
4969 # for example, "enginee" is corrected to "engineer".
4970 #
4971 # Defaults to false: a spell check is performed.
4972 "customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the
4973 # Job.custom_attributes marked as `filterable`.
4974 #
4975 # The syntax for this expression is a subset of SQL syntax.
4976 #
4977 # Supported operators are: `=`, `!=`, `&lt;`, `&lt;=`, `&gt;`, and `&gt;=` where the
4978 # left of the operator is a custom field key and the right of the operator
4979 # is a number or a quoted string. You must escape backslash (\\) and
4980 # quote (\") characters.
4981 #
4982 # Supported functions are `LOWER([field_name])` to
4983 # perform a case insensitive match and `EMPTY([field_name])` to filter on the
4984 # existence of a key.
4985 #
4986 # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of
4987 # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
4988 # comparisons or functions are allowed in the expression. The expression
4989 # must be &lt; 6000 bytes in length.
4990 #
4991 # Sample Query:
4992 # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
4993 # driving_years &gt; 10`
4994 "employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to
4995 # search against, such as EmploymentType.FULL_TIME.
4996 #
4997 # If a value is not specified, jobs in the search results includes any
4998 # employment type.
4999 #
5000 # If multiple values are specified, jobs in the search results include
5001 # any of the specified employment types.
5002 "A String",
5003 ],
5004 "queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to
5005 # better interpret the query.
5006 #
5007 # If a value isn't specified, the query language code is automatically
5008 # detected, which may not be accurate.
5009 #
5010 # Language code should be in BCP-47 format, such as "en-US" or "sr-Latn".
5011 # For more information, see
5012 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
5013 "query": "A String", # Optional. The query string that matches against the job title, description, and
5014 # location fields.
5015 #
5016 # The maximum number of allowed characters is 255.
5017 "publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched
5018 # against.
5019 "endTime": "A String", # End of the period.
5020 "startTime": "A String", # Begin of the period.
5021 },
5022 "commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for
5023 # example, driving or public transit). Note: This only works with COMMUTE
5024 # MODE. When specified, [JobQuery.location_filters] is
5025 # ignored.
5026 #
5027 # Currently we don't support sorting by commute time.
5028 #
5029 # Parameters needed for commute search.
5030 "roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.
5031 "departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as
5032 # google.type.TimeOfDay in local time zone.
5033 #
5034 # Currently traffic model is restricted to hour level resolution.
5035 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5036 # types are google.type.Date and `google.protobuf.Timestamp`.
5037 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5038 # to allow the value "24:00:00" for scenarios like business closing time.
5039 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5040 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5041 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5042 # allow the value 60 if it allows leap-seconds.
5043 },
5044 "startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the
5045 # commute time.
5046 # of doubles representing degrees latitude and degrees longitude. Unless
5047 # specified otherwise, this must conform to the
5048 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
5049 # standard&lt;/a&gt;. Values must be within normalized ranges.
5050 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
5051 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
5052 },
5053 "allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS
5054 # coordinates) might also be returned. For city and coarser level addresses,
5055 # text matching is used. If this field is set to false or is not specified,
5056 # only jobs that include precise addresses are returned by Commute
5057 # Search.
5058 #
5059 # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not
5060 # able to calculate accurate commute times to jobs with city level and
5061 # coarser address information. Jobs with imprecise addresses will return a
5062 # `travel_duration` time of 0 regardless of distance from the job seeker.
5063 "travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`
5064 # (one hour). Format is `123s`.
5065 "commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.
5066 },
5067 "jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.
5068 # See Category for more information.
5069 #
5070 # If a value is not specified, jobs from any category are searched against.
5071 #
5072 # If multiple values are specified, jobs from any of the specified
5073 # categories are searched against.
5074 "A String",
5075 ],
5076 "languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,
5077 # for example, "en-US".
5078 #
5079 # If a value isn't specified, the search results can contain jobs in any
5080 # locale.
5081 #
5082 #
5083 # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".
5084 # For more information, see
5085 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
5086 #
5087 # At most 10 language code filters are allowed.
5088 "A String",
5089 ],
5090 "companyNames": [ # Optional. This filter specifies the company entities to search against.
5091 #
5092 # If a value isn't specified, jobs are searched for against all
5093 # companies.
5094 #
5095 # If multiple values are specified, jobs are searched against the
5096 # companies specified.
5097 #
5098 # The format is "projects/{project_id}/companies/{company_id}", for example,
5099 # "projects/api-test-project/companies/foo".
5100 #
5101 # At most 20 company filters are allowed.
5102 "A String",
5103 ],
5104 "companyDisplayNames": [ # Optional. This filter specifies the exact company display
5105 # name of the jobs to search against.
5106 #
5107 # If a value isn't specified, jobs within the search results are
5108 # associated with any company.
5109 #
5110 # If multiple values are specified, jobs within the search results may be
5111 # associated with any of the specified companies.
5112 #
5113 # At most 20 company display name filters are allowed.
5114 "A String",
5115 ],
5116 "locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to
5117 # search against. See LocationFilter for more information.
5118 #
5119 # If a location value isn't specified, jobs fitting the other search
5120 # criteria are retrieved regardless of where they're located.
5121 #
5122 # If multiple values are specified, jobs are retrieved from any of the
5123 # specified locations. If different values are specified for the
5124 # LocationFilter.distance_in_miles parameter, the maximum provided
5125 # distance is used for all locations.
5126 #
5127 # At most 5 location filters are allowed.
5128 { # Input only.
5129 #
5130 # Geographic region of the search.
5131 "regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used
5132 # to address ambiguity of the user-input location, for example, "Liverpool"
5133 # against "Liverpool, NY, US" or "Liverpool, UK".
5134 #
5135 # Set this field if all the jobs to search against are from a same region,
5136 # or jobs are world-wide, but the job seeker is from a specific region.
5137 #
5138 # See http://cldr.unicode.org/ and
5139 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
5140 # for details. Example: "CH" for Switzerland.
5141 "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
5142 # search. This field's ignored if `address` is provided.
5143 # of doubles representing degrees latitude and degrees longitude. Unless
5144 # specified otherwise, this must conform to the
5145 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
5146 # standard&lt;/a&gt;. Values must be within normalized ranges.
5147 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
5148 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
5149 },
5150 "distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is
5151 # identified as a city or smaller. When the location being searched for is a
5152 # state or larger, this field is ignored.
5153 "telecommutePreference": "A String", # Optional. Allows the client to return jobs without a
5154 # set location, specifically, telecommuting jobs (telecommuting is considered
5155 # by the service as a special location.
5156 # Job.posting_region indicates if a job permits telecommuting.
5157 # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,
5158 # telecommuting jobs are searched, and address and lat_lng are
5159 # ignored. If not set or set to
5160 # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not
5161 # searched.
5162 #
5163 # This filter can be used by itself to search exclusively for telecommuting
5164 # jobs, or it can be combined with another location
5165 # filter to search for a combination of job locations,
5166 # such as "Mountain View" or "telecommuting" jobs. However, when used in
5167 # combination with other location filters, telecommuting jobs can be
5168 # treated as less relevant than other jobs in the search response.
5169 "address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".
5170 },
5171 ],
5172 "compensationFilter": { # Input only. # Optional. This search filter is applied only to
5173 # Job.compensation_info. For example, if the filter is specified
5174 # as "Hourly job with per-hour compensation &gt; $15", only jobs meeting
5175 # these criteria are searched. If a filter isn't defined, all open jobs
5176 # are searched.
5177 #
5178 # Filter on job compensation type and amount.
5179 "units": [ # Required. Specify desired `base compensation entry's`
5180 # CompensationInfo.CompensationUnit.
5181 "A String",
5182 ],
5183 "range": { # Compensation range. # Optional. Compensation range.
5184 "minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set
5185 # to zero and the currency code is set to match the
5186 # currency code of max_compensation.
5187 "nanos": 42, # Number of nano (10^-9) units of the amount.
5188 # The value must be between -999,999,999 and +999,999,999 inclusive.
5189 # If `units` is positive, `nanos` must be positive or zero.
5190 # If `units` is zero, `nanos` can be positive, zero, or negative.
5191 # If `units` is negative, `nanos` must be negative or zero.
5192 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5193 "units": "A String", # The whole units of the amount.
5194 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5195 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5196 },
5197 "maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set
5198 # to a maximal compensation value and the currency code is set to
5199 # match the currency code of
5200 # min_compensation.
5201 "nanos": 42, # Number of nano (10^-9) units of the amount.
5202 # The value must be between -999,999,999 and +999,999,999 inclusive.
5203 # If `units` is positive, `nanos` must be positive or zero.
5204 # If `units` is zero, `nanos` can be positive, zero, or negative.
5205 # If `units` is negative, `nanos` must be negative or zero.
5206 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5207 "units": "A String", # The whole units of the amount.
5208 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5209 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5210 },
5211 },
5212 "type": "A String", # Required. Type of filter.
5213 "includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are
5214 # included.
5215 },
5216 },
5217 "pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.
5218 # Increasing this value above the default value of 10 can increase search
5219 # response time. The value can be between 1 and 100.
5220 "histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.
5221 #
5222 # Histogram facets to be specified in SearchJobsRequest.
5223 "simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,
5224 # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
5225 "A String",
5226 ],
5227 "customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.
5228 # Duplicate values of CustomAttributeHistogramRequest.key are not
5229 # allowed.
5230 { # Custom attributes histogram request. An error is thrown if neither
5231 # string_value_histogram or long_value_histogram_bucketing_option has
5232 # been defined.
5233 "stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for
5234 # each key as a string.
5235 "longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's
5236 # filterable long custom field values, or min/max value requirements.
5237 #
5238 # Use this field to specify bucketing option for the histogram search response.
5239 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
5240 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
5241 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
5242 # [buckets_bound is supported.
5243 3.14,
5244 ],
5245 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
5246 # value of the numeric field.
5247 },
5248 "key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified
5249 # without `long_value_histogram_bucketing_option`, histogram on string values
5250 # of the given `key` is triggered, otherwise histogram is performed on long
5251 # values.
5252 },
5253 ],
5254 "compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.
5255 # Duplicate values of CompensationHistogramRequest.type are not allowed.
5256 { # Input only.
5257 #
5258 # Compensation based histogram request.
5259 "bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.
5260 #
5261 # Use this field to specify bucketing option for the histogram search response.
5262 "bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in
5263 # ascending order. For example, if [5, 10, 15] are provided, four buckets are
5264 # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20
5265 # [buckets_bound is supported.
5266 3.14,
5267 ],
5268 "requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum
5269 # value of the numeric field.
5270 },
5271 "type": "A String", # Required. Type of the request, representing which field the histogramming should be
5272 # performed over. A single request can only specify one histogram of each
5273 # `CompensationHistogramRequestType`.
5274 },
5275 ],
5276 },
5277 "searchMode": "A String", # Optional. Mode of a search.
5278 #
5279 # Defaults to SearchMode.JOB_SEARCH.
5280 "requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the
5281 # search quality of the service. The identifiers (such as `user_id`) are
5282 # provided by users, and must be unique and consistent.
5283 #
5284 # Meta information related to the job searcher or entity
5285 # conducting the job search. This information is used to improve the
5286 # performance of the service.
5287 "userId": "A String", # Required. A unique user identification string, as determined by the client.
5288 # To have the strongest positive impact on search quality
5289 # make sure the client-level is unique.
5290 # Obfuscate this field for privacy concerns before
5291 # providing it to the service.
5292 #
5293 # If this field is not available for some reason, send "UNKNOWN". Note
5294 # that any improvements to the model for a particular tenant
5295 # site, rely on this field being set correctly to a unique user_id.
5296 #
5297 # The maximum number of allowed characters is 255.
5298 "sessionId": "A String", # Required. A unique session identification string. A session is defined as the
5299 # duration of an end user's interaction with the service over a certain
5300 # period.
5301 # Obfuscate this field for privacy concerns before
5302 # providing it to the service.
5303 #
5304 # If this field is not available for some reason, send "UNKNOWN". Note
5305 # that any improvements to the model for a particular tenant
5306 # site, rely on this field being set correctly to some unique session_id.
5307 #
5308 # The maximum number of allowed characters is 255.
5309 "deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the
5310 # service.
5311 # other entity conducting the job search. Providing this information improves
5312 # the quality of the search results across devices.
5313 "deviceType": "A String", # Optional. Type of the device.
5314 "id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that
5315 # distinguishes the device from other devices.
5316 },
5317 "domain": "A String", # Required. The client-defined scope or source of the service call, which typically
5318 # is the domain on
5319 # which the service has been implemented and is currently being run.
5320 #
5321 # For example, if the service is being run by client &lt;em&gt;Foo, Inc.&lt;/em&gt;, on
5322 # job board www.foo.com and career site www.bar.com, then this field is
5323 # set to "foo.com" for use on the job board, and "bar.com" for use on the
5324 # career site.
5325 #
5326 # If this field isn't available for some reason, send "UNKNOWN".
5327 # Any improvements to the model for a particular tenant site rely on this
5328 # field being set correctly to a domain.
5329 #
5330 # The maximum number of allowed characters is 255.
5331 },
5332 "pageToken": "A String", # Optional. The token specifying the current offset within
5333 # search results. See SearchJobsResponse.next_page_token for
5334 # an explanation of how to obtain the next set of query results.
5335 "disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5336 # Job.description, Job.company_display_name, Job.locations,
5337 # Job.qualifications. When disable keyword match is turned off, a
5338 # keyword match returns jobs that do not match given category filters when
5339 # there are matching keywords. For example, the query "program manager," a
5340 # result is returned even if the job posting has the title "software
5341 # developer," which does not fall into "program manager" ontology, but does
5342 # have "program manager" appearing in its description.
5343 #
5344 # For queries like "cloud" that does not contain title or
5345 # location specific ontology, jobs with "cloud" keyword matches are returned
5346 # regardless of this flag's value.
5347 #
5348 # Please use Company.keyword_searchable_custom_fields or
5349 # Company.keyword_searchable_custom_attributes if company specific
5350 # globally matched custom field/attribute string values is needed. Enabling
5351 # keyword match improves recall of subsequent search requests.
5352 #
5353 # Defaults to false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5354 "requirePreciseResultSize": 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]5355 # count of the first 300 results. Setting this to `true` ensures
5356 # consistency in the number of results per page. Best practice is to set this
5357 # value to true if a client allows users to jump directly to a
5358 # non-sequential search results page.
5359 #
5360 # Enabling this flag may adversely impact performance.
5361 #
5362 # Defaults to false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5363 "jobView": "A String", # Optional. The desired job attributes returned for jobs in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5364 # search response. Defaults to JobView.SMALL if no value is specified.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5365 "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]5366 # location, amongst the jobs deemed by the API as relevant) in search
5367 # results. This field is only considered if page_token is unset.
5368 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5369 # The maximum allowed value is 5000. Otherwise an error is thrown.
5370 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5371 # For example, 0 means to return results starting from the first matching
5372 # job, and 10 means to return from the 11th job. This can be used for
5373 # pagination, (for example, pageSize = 10 and offset = 10 means to return
5374 # from the second page).
5375 }
5376
5377 x__xgafv: string, V1 error format.
5378 Allowed values
5379 1 - v1 error format
5380 2 - v2 error format
5381
5382Returns:
5383 An object of the form:
5384
5385 { # Output only.
5386 #
5387 # Response for SearchJob method.
5388 "nextPageToken": "A String", # The token that specifies the starting position of the next page of results.
5389 # This field is empty if there are no more results.
5390 "spellCorrection": { # Output only. # The spell checking result, and correction.
5391 #
5392 # Spell check result.
5393 "corrected": True or False, # Indicates if the query was corrected by the spell checker.
5394 "correctedText": "A String", # Correction output consisting of the corrected keyword string.
5395 },
5396 "totalSize": 42, # The precise result count, which is available only if the client set
5397 # enable_precise_result_size to `true`, or if the response
5398 # is the last page of results. Otherwise, the value is `-1`.
5399 "matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.
5400 { # Output only.
5401 #
5402 # Job entry with metadata inside SearchJobsResponse.
5403 "searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar
5404 # fields that most closely match a search query's keywords, if available.
5405 # All HTML tags in the original fields are stripped when returned in this
5406 # field, and matching query keywords are enclosed in HTML bold tags.
5407 "job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.
5408 # or "job requisition"). A job belongs to a Company, which is the hiring
5409 # entity responsible for the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5410 "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]5411 # any requirements for fluency that are associated with the job.
5412 #
5413 # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
5414 # For more information, see
5415 # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
5416 # class="external" target="_blank" }.
5417 #
5418 # If this field is unspecified and Job.description is present, detected
5419 # language code based on Job.description is assigned, otherwise
5420 # defaults to 'en_US'.
5421 "addresses": [ # Optional but strongly recommended for the best service experience.
5422 #
5423 # Location(s) where the employer is looking to hire for this job posting.
5424 #
5425 # Specifying the full street address(es) of the hiring location enables
5426 # better API results, especially job searches by commute time.
5427 #
5428 # At most 50 locations are allowed for best search performance. If a job has
5429 # more locations, it is suggested to split it into multiple jobs with unique
5430 # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as
5431 # multiple jobs with the same company_name, language_code and
5432 # requisition_id are not allowed. If the original requisition_id must
5433 # be preserved, a custom field should be used for storage. It is also
5434 # suggested to group the locations that close to each other in the same job
5435 # for better search experience.
5436 #
5437 # The maximum number of allowed characters is 500.
5438 "A String",
5439 ],
5440 "companyDisplayName": "A String", # Output only. Display name of the company listing the job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5441 "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]5442 # The value determines the sort order of the jobs returned when searching for
5443 # jobs using the featured jobs search call, with higher promotional values
5444 # being returned first and ties being resolved by relevance sort. Only the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5445 # jobs with a promotionValue &gt;0 are returned in a FEATURED_JOB_SEARCH.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5446 #
5447 # Default value is 0, and negative values are treated as 0.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5448 "employmentTypes": [ # Optional. The employment type(s) of a job, for example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5449 # full time or
5450 # part time.
5451 "A String",
5452 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5453 "jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5454 # engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5455 "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5456 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5457 # Job application information.
5458 "instruction": "A String", # Optional but at least one of uris,
5459 # emails or instruction must be
5460 # specified.
5461 #
5462 # Use this field to provide instructions, such as "Mail your application
5463 # to ...", that a candidate can follow to apply for the job.
5464 #
5465 # This field accepts and sanitizes HTML input, and also accepts
5466 # bold, italic, ordered list, and unordered list markup tags.
5467 #
5468 # The maximum number of allowed characters is 3,000.
5469 "uris": [ # Optional but at least one of uris,
5470 # emails or instruction must be
5471 # specified.
5472 #
5473 # Use this URI field to direct an applicant to a website, for example to
5474 # link to an online application form.
5475 #
5476 # The maximum number of allowed characters for each entry is 2,000.
5477 "A String",
5478 ],
5479 "emails": [ # Optional but at least one of uris,
5480 # emails or instruction must be
5481 # specified.
5482 #
5483 # Use this field to specify email address(es) to which resumes or
5484 # applications can be sent.
5485 #
5486 # The maximum number of allowed characters for each entry is 255.
5487 "A String",
5488 ],
5489 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5490 "postingExpireTime": "A String", # Optional but strongly recommended for the best service
5491 # experience.
5492 #
5493 # The expiration timestamp of the job. After this timestamp, the
5494 # job is marked as expired, and it no longer appears in search results. The
5495 # expired job can't be deleted or listed by the DeleteJob and
5496 # ListJobs APIs, but it can be retrieved with the GetJob API or
5497 # updated with the UpdateJob API. An expired job can be updated and
5498 # opened again by using a future expiration timestamp. Updating an expired
5499 # job fails if there is another existing open job with same company_name,
5500 # language_code and requisition_id.
5501 #
5502 # The expired jobs are retained in our system for 90 days. However, the
5503 # overall expired job count cannot exceed 3 times the maximum of open jobs
5504 # count over the past week, otherwise jobs with earlier expire time are
5505 # cleaned first. Expired jobs are no longer accessible after they are cleaned
5506 # out.
5507 #
5508 # Invalid timestamps are ignored, and treated as expire time not provided.
5509 #
5510 # Timestamp before the instant request is made is considered valid, the job
5511 # will be treated as expired immediately.
5512 #
5513 # If this value is not provided at the time of job creation or is invalid,
5514 # the job posting expires after 30 days from the job's creation time. For
5515 # example, if the job was created on 2017/01/01 13:00AM UTC with an
5516 # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
5517 #
5518 # If this value is not provided on job update, it depends on the field masks
5519 # set by UpdateJobRequest.update_mask. If the field masks include
5520 # expiry_time, or the masks are empty meaning that every field is
5521 # updated, the job posting expires after 30 days from the job's last
5522 # update time. Otherwise the expiration date isn't updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5523 "title": "A String", # Required. The title of the job, such as "Software Engineer"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5524 #
5525 # The maximum number of allowed characters is 500.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5526 "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]5527 # recommended as an alternative to using the more general description
5528 # field.
5529 #
5530 # This field accepts and sanitizes HTML input, and also accepts
5531 # bold, italic, ordered list, and unordered list markup tags.
5532 #
5533 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5534 "jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5535 # is used for contracting engagements. Invalid timestamps are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5536 "compensationInfo": { # Job compensation details. # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5537 "annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as
5538 # all compensation entries' CompensationEntry.compensation times
5539 # CompensationEntry.expected_units_per_year.
5540 #
5541 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5542 "minCompensation": { # 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]5543 # to zero and the currency code is set to match the
5544 # currency code of max_compensation.
5545 "nanos": 42, # Number of nano (10^-9) units of the amount.
5546 # The value must be between -999,999,999 and +999,999,999 inclusive.
5547 # If `units` is positive, `nanos` must be positive or zero.
5548 # If `units` is zero, `nanos` can be positive, zero, or negative.
5549 # If `units` is negative, `nanos` must be negative or zero.
5550 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5551 "units": "A String", # The whole units of the amount.
5552 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5553 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5554 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5555 "maxCompensation": { # 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]5556 # to a maximal compensation value and the currency code is set to
5557 # match the currency code of
5558 # min_compensation.
5559 "nanos": 42, # Number of nano (10^-9) units of the amount.
5560 # The value must be between -999,999,999 and +999,999,999 inclusive.
5561 # If `units` is positive, `nanos` must be positive or zero.
5562 # If `units` is zero, `nanos` can be positive, zero, or negative.
5563 # If `units` is negative, `nanos` must be negative or zero.
5564 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5565 "units": "A String", # The whole units of the amount.
5566 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5567 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5568 },
5569 },
5570 "annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as
5571 # base compensation entry's CompensationEntry.compensation times
5572 # CompensationEntry.expected_units_per_year.
5573 #
5574 # See CompensationEntry for explanation on compensation annualization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5575 "minCompensation": { # 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]5576 # to zero and the currency code is set to match the
5577 # currency code of max_compensation.
5578 "nanos": 42, # Number of nano (10^-9) units of the amount.
5579 # The value must be between -999,999,999 and +999,999,999 inclusive.
5580 # If `units` is positive, `nanos` must be positive or zero.
5581 # If `units` is zero, `nanos` can be positive, zero, or negative.
5582 # If `units` is negative, `nanos` must be negative or zero.
5583 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5584 "units": "A String", # The whole units of the amount.
5585 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5586 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5587 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5588 "maxCompensation": { # 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]5589 # to a maximal compensation value and the currency code is set to
5590 # match the currency code of
5591 # min_compensation.
5592 "nanos": 42, # Number of nano (10^-9) units of the amount.
5593 # The value must be between -999,999,999 and +999,999,999 inclusive.
5594 # If `units` is positive, `nanos` must be positive or zero.
5595 # If `units` is zero, `nanos` can be positive, zero, or negative.
5596 # If `units` is negative, `nanos` must be negative or zero.
5597 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5598 "units": "A String", # The whole units of the amount.
5599 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5600 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5601 },
5602 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5603 "entries": [ # Optional. Job compensation information.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5604 #
5605 # At most one entry can be of type
5606 # CompensationInfo.CompensationType.BASE, which is
5607 # referred as ** base compensation entry ** for the job.
5608 { # A compensation entry that represents one component of compensation, such
5609 # as base pay, bonus, or other compensation type.
5610 #
5611 # Annualization: One compensation entry can be annualized if
5612 # - it contains valid amount or range.
5613 # - and its expected_units_per_year is set or can be derived.
5614 # Its annualized range is determined as (amount or range) times
5615 # expected_units_per_year.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5616 "description": "A String", # Optional. Compensation description. For example, could
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5617 # indicate equity terms or provide additional context to an estimated
5618 # bonus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5619 "range": { # Compensation range. # Optional. Compensation range.
5620 "minCompensation": { # 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]5621 # to zero and the currency code is set to match the
5622 # currency code of max_compensation.
5623 "nanos": 42, # Number of nano (10^-9) units of the amount.
5624 # The value must be between -999,999,999 and +999,999,999 inclusive.
5625 # If `units` is positive, `nanos` must be positive or zero.
5626 # If `units` is zero, `nanos` can be positive, zero, or negative.
5627 # If `units` is negative, `nanos` must be negative or zero.
5628 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5629 "units": "A String", # The whole units of the amount.
5630 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5631 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5632 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5633 "maxCompensation": { # 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]5634 # to a maximal compensation value and the currency code is set to
5635 # match the currency code of
5636 # min_compensation.
5637 "nanos": 42, # Number of nano (10^-9) units of the amount.
5638 # The value must be between -999,999,999 and +999,999,999 inclusive.
5639 # If `units` is positive, `nanos` must be positive or zero.
5640 # If `units` is zero, `nanos` can be positive, zero, or negative.
5641 # If `units` is negative, `nanos` must be negative or zero.
5642 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5643 "units": "A String", # The whole units of the amount.
5644 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5645 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5646 },
5647 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5648 "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]5649 # Job.employment_types is FULLTIME, a default value is inferred
5650 # based on unit. Default values:
5651 # - HOURLY: 2080
5652 # - DAILY: 260
5653 # - WEEKLY: 52
5654 # - MONTHLY: 12
5655 # - ANNUAL: 1
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5656 "amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5657 "nanos": 42, # Number of nano (10^-9) units of the amount.
5658 # The value must be between -999,999,999 and +999,999,999 inclusive.
5659 # If `units` is positive, `nanos` must be positive or zero.
5660 # If `units` is zero, `nanos` can be positive, zero, or negative.
5661 # If `units` is negative, `nanos` must be negative or zero.
5662 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5663 "units": "A String", # The whole units of the amount.
5664 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5665 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5666 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5667 "type": "A String", # Optional. Compensation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5668 #
5669 # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5670 "unit": "A String", # Optional. Frequency of the specified amount.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5671 #
5672 # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
5673 },
5674 ],
5675 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5676 "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]5677 # position.
5678 #
5679 # The maximum number of allowed characters is 255.
5680 "postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5681 "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]5682 # client to identify a job. This field is intended to be used by clients
5683 # for client identification and tracking of postings. A job is not allowed
5684 # to be created if there is another job with the same [company_name],
5685 # language_code and requisition_id.
5686 #
5687 # The maximum number of allowed characters is 255.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5688 "postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5689 # value is the time the request arrives at the server. Invalid timestamps are
5690 # ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5691 "description": "A String", # Required. The description of the job, which typically includes a multi-paragraph
5692 # description of the company and related information. Separate fields are
5693 # provided on the job object for responsibilities,
5694 # qualifications, and other job characteristics. Use of
5695 # these separate job fields is recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5696 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5697 # This field accepts and sanitizes HTML input, and also accepts
5698 # bold, italic, ordered list, and unordered list markup tags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5699 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5700 # The maximum number of allowed characters is 100,000.
5701 "companyName": "A String", # Required. The resource name of the company listing the job, such as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5702 # "projects/api-test-project/companies/foo".
5703 "derivedInfo": { # Output only. # Output only. Derived details about the job posting.
5704 #
5705 # Derived details about the job posting.
5706 "jobCategories": [ # Job categories derived from Job.title and Job.description.
5707 "A String",
5708 ],
5709 "locations": [ # Structured locations of the job, resolved from Job.addresses.
5710 #
5711 # locations are exactly matched to Job.addresses in the same
5712 # order.
5713 { # Output only.
5714 #
5715 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5716 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
5717 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
5718 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
5719 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5720 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
5721 # location bounding box in which a circle with the specified radius
5722 # centered from LatLng covers the area associated with the job location.
5723 # For example, currently, "Mountain View, CA, USA" has a radius of
5724 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5725 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
5726 # of doubles representing degrees latitude and degrees longitude. Unless
5727 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5728 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
5729 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5730 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
5731 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
5732 },
5733 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
5734 # such as postal delivery and payments addresses. Given a postal address,
5735 # a postal service can deliver items to a premises, P.O. Box, or other
5736 # delivery location.
5737 # Given a postal address, a postal service can deliver items to a premise, P.O.
5738 # Box or similar.
5739 # It is not intended to model geographical locations (roads, towns,
5740 # mountains).
5741 #
5742 # In typical usage an address would be created via user input or from importing
5743 # existing data, depending on the type of process.
5744 #
5745 # Advice on address input / editing:
5746 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5747 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5748 # - Users should not be presented with UI elements for input or editing of
5749 # fields outside countries where that field is used.
5750 #
5751 # For more guidance on how to use this schema, please see:
5752 # https://support.google.com/business/answer/6397478
5753 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
5754 # known). This is often the UI language of the input form or is expected
5755 # to match one of the languages used in the address' country/region, or their
5756 # transliterated equivalents.
5757 # This can affect formatting in certain countries, but is not critical
5758 # to the correctness of the data and will never affect any validation or
5759 # other non-formatting related operations.
5760 #
5761 # If this value is not known, it should be omitted (rather than specifying a
5762 # possibly incorrect default).
5763 #
5764 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
5765 "recipients": [ # Optional. The recipient at the address.
5766 # This field may, under certain circumstances, contain multiline information.
5767 # For example, it might contain "care of" information.
5768 "A String",
5769 ],
5770 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
5771 # Examples: US city, IT comune, UK post town.
5772 # In regions of the world where localities are not well defined or do not fit
5773 # into this structure well, leave locality empty and use address_lines.
5774 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
5775 # in most regions. Where it is used, the value is either a string like
5776 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
5777 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
5778 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
5779 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
5780 # is never inferred and it is up to the user to ensure the value is
5781 # correct. See http://cldr.unicode.org/ and
5782 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
5783 # for details. Example: "CH" for Switzerland.
5784 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
5785 # addresses of a country or region.
5786 # For example, this can be a state, a province, an oblast, or a prefecture.
5787 # Specifically, for Spain this is the province and not the autonomous
5788 # community (e.g. "Barcelona" and not "Catalonia").
5789 # Many countries don't use an administrative area in postal addresses. E.g.
5790 # in Switzerland this should be left unpopulated.
5791 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
5792 #
5793 # Because values in address_lines do not have type information and may
5794 # sometimes contain multiple values in a single field (e.g.
5795 # "Austin, TX"), it is important that the line order is clear. The order of
5796 # address lines should be "envelope order" for the country/region of the
5797 # address. In places where this can vary (e.g. Japan), address_language is
5798 # used to make it explicit (e.g. "ja" for large-to-small ordering and
5799 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
5800 # an address can be selected based on the language.
5801 #
5802 # The minimum permitted structural representation of an address consists
5803 # of a region_code with all remaining information placed in the
5804 # address_lines. It would be possible to format such an address very
5805 # approximately without geocoding, but no semantic reasoning could be
5806 # made about any of the address components until it was at least
5807 # partially resolved.
5808 #
5809 # Creating an address only containing a region_code and address_lines, and
5810 # then geocoding is the recommended way to handle completely unstructured
5811 # addresses (as opposed to guessing which parts of the address should be
5812 # localities or administrative areas).
5813 "A String",
5814 ],
5815 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
5816 # postal codes to be present, but where they are used, they may trigger
5817 # additional validation with other parts of the address (e.g. state/zip
5818 # validation in the U.S.A.).
5819 "organization": "A String", # Optional. The name of the organization at the address.
5820 "sublocality": "A String", # Optional. Sublocality of the address.
5821 # For example, this can be neighborhoods, boroughs, districts.
5822 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
5823 # the latest revision.
5824 #
5825 # All new revisions **must** be backward compatible with old revisions.
5826 },
5827 },
5828 ],
5829 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5830 "qualifications": "A String", # Optional. A description of the qualifications required to perform the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5831 # job. The use of this field is recommended
5832 # as an alternative to using the more general description field.
5833 #
5834 # This field accepts and sanitizes HTML input, and also accepts
5835 # bold, italic, ordered list, and unordered list markup tags.
5836 #
5837 # The maximum number of allowed characters is 10,000.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5838 "jobBenefits": [ # Optional. The benefits included with the job.
5839 "A String",
5840 ],
5841 "incentives": "A String", # Optional. A description of bonus, commission, and other compensation
5842 # incentives associated with the job not including salary or pay.
5843 #
5844 # The maximum number of allowed characters is 10,000.
5845 "visibility": "A String", # Deprecated. The job is only visible to the owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5846 #
5847 # The visibility of the job.
5848 #
5849 # Defaults to Visibility.ACCOUNT_ONLY if not specified.
5850 "postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5851 "postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5852 # the job is available. If this field is set, a
5853 # LocationFilter in a search query within the job region
5854 # finds this job posting if an exact location match isn't specified.
5855 # If this field is set to PostingRegion.NATION or
5856 # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses
5857 # to the same location level as this field is strongly recommended.
5858 "name": "A String", # Required during job update.
5859 #
5860 # The resource name for the job. This is generated by the service when a
5861 # job is created.
5862 #
5863 # The format is "projects/{project_id}/jobs/{job_id}",
5864 # for example, "projects/api-test-project/jobs/1234".
5865 #
5866 # Use of this field in job queries and API calls is preferred over the use of
5867 # requisition_id since this value is unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5868 "processingOptions": { # Input only. # Optional. Options for job processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5869 #
5870 # Options for job processing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5871 "htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5872 #
5873 # * description
5874 # * applicationInfo.instruction
5875 # * incentives
5876 # * qualifications
5877 # * responsibilities
5878 #
5879 # HTML tags in these fields may be stripped if sanitiazation is not
5880 # disabled.
5881 #
5882 # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5883 "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]5884 # more precise address for the job.
5885 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5886 "degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5887 "A String",
5888 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5889 "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]5890 # attributes that are not covered by the provided structured fields.
5891 #
5892 # The keys of the map are strings up to 64 bytes and must match the
5893 # pattern: a-zA-Z*. For example, key0LikeThis or
5894 # KEY_1_LIKE_THIS.
5895 #
5896 # At most 100 filterable and at most 100 unfilterable keys are supported.
5897 # For filterable `string_values`, across all keys at most 200 values are
5898 # allowed, with each string no more than 255 characters. For unfilterable
5899 # `string_values`, the maximum total size of `string_values` across all keys
5900 # is 50KB.
5901 "a_key": { # Custom attribute values that are either filterable or non-filterable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5902 "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]5903 # If false, values are not searchable.
5904 #
5905 # Default is false.
5906 "stringValues": [ # Optional but exactly one of string_values or long_values must
5907 # be specified.
5908 #
5909 # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
5910 # `CASE_INSENSITIVE_MATCH`) search.
5911 # For filterable `string_value`s, a maximum total number of 200 values
5912 # is allowed, with each `string_value` has a byte size of no more than
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5913 # 500B. For unfilterable `string_values`, the maximum total byte size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5914 # unfilterable `string_values` is 50KB.
5915 #
5916 # Empty string is not allowed.
5917 "A String",
5918 ],
5919 "longValues": [ # Optional but exactly one of string_values or long_values must
5920 # be specified.
5921 #
5922 # This field is used to perform number range search.
5923 # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
5924 #
5925 # Currently at most 1 long_values is supported.
5926 "A String",
5927 ],
5928 },
5929 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5930 "jobLevel": "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]5931 },
5932 "commuteInfo": { # Output only. # Commute information which is generated based on specified
5933 # CommuteFilter.
5934 #
5935 # Commute details related to this job.
5936 "travelDuration": "A String", # The number of seconds required to travel to the job location from the
5937 # query location. A duration of 0 seconds indicates that the job is not
5938 # reachable within the requested duration, but was returned as part of an
5939 # expanded query.
5940 "jobLocation": { # Output only. # Location used as the destination in the commute calculation.
5941 #
5942 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5943 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
5944 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
5945 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
5946 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5947 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
5948 # location bounding box in which a circle with the specified radius
5949 # centered from LatLng covers the area associated with the job location.
5950 # For example, currently, "Mountain View, CA, USA" has a radius of
5951 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5952 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
5953 # of doubles representing degrees latitude and degrees longitude. Unless
5954 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5955 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
5956 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5957 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
5958 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
5959 },
5960 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
5961 # such as postal delivery and payments addresses. Given a postal address,
5962 # a postal service can deliver items to a premises, P.O. Box, or other
5963 # delivery location.
5964 # Given a postal address, a postal service can deliver items to a premise, P.O.
5965 # Box or similar.
5966 # It is not intended to model geographical locations (roads, towns,
5967 # mountains).
5968 #
5969 # In typical usage an address would be created via user input or from importing
5970 # existing data, depending on the type of process.
5971 #
5972 # Advice on address input / editing:
5973 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5974 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5975 # - Users should not be presented with UI elements for input or editing of
5976 # fields outside countries where that field is used.
5977 #
5978 # For more guidance on how to use this schema, please see:
5979 # https://support.google.com/business/answer/6397478
5980 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
5981 # known). This is often the UI language of the input form or is expected
5982 # to match one of the languages used in the address' country/region, or their
5983 # transliterated equivalents.
5984 # This can affect formatting in certain countries, but is not critical
5985 # to the correctness of the data and will never affect any validation or
5986 # other non-formatting related operations.
5987 #
5988 # If this value is not known, it should be omitted (rather than specifying a
5989 # possibly incorrect default).
5990 #
5991 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
5992 "recipients": [ # Optional. The recipient at the address.
5993 # This field may, under certain circumstances, contain multiline information.
5994 # For example, it might contain "care of" information.
5995 "A String",
5996 ],
5997 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
5998 # Examples: US city, IT comune, UK post town.
5999 # In regions of the world where localities are not well defined or do not fit
6000 # into this structure well, leave locality empty and use address_lines.
6001 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
6002 # in most regions. Where it is used, the value is either a string like
6003 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
6004 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
6005 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
6006 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
6007 # is never inferred and it is up to the user to ensure the value is
6008 # correct. See http://cldr.unicode.org/ and
6009 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
6010 # for details. Example: "CH" for Switzerland.
6011 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
6012 # addresses of a country or region.
6013 # For example, this can be a state, a province, an oblast, or a prefecture.
6014 # Specifically, for Spain this is the province and not the autonomous
6015 # community (e.g. "Barcelona" and not "Catalonia").
6016 # Many countries don't use an administrative area in postal addresses. E.g.
6017 # in Switzerland this should be left unpopulated.
6018 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
6019 #
6020 # Because values in address_lines do not have type information and may
6021 # sometimes contain multiple values in a single field (e.g.
6022 # "Austin, TX"), it is important that the line order is clear. The order of
6023 # address lines should be "envelope order" for the country/region of the
6024 # address. In places where this can vary (e.g. Japan), address_language is
6025 # used to make it explicit (e.g. "ja" for large-to-small ordering and
6026 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
6027 # an address can be selected based on the language.
6028 #
6029 # The minimum permitted structural representation of an address consists
6030 # of a region_code with all remaining information placed in the
6031 # address_lines. It would be possible to format such an address very
6032 # approximately without geocoding, but no semantic reasoning could be
6033 # made about any of the address components until it was at least
6034 # partially resolved.
6035 #
6036 # Creating an address only containing a region_code and address_lines, and
6037 # then geocoding is the recommended way to handle completely unstructured
6038 # addresses (as opposed to guessing which parts of the address should be
6039 # localities or administrative areas).
6040 "A String",
6041 ],
6042 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
6043 # postal codes to be present, but where they are used, they may trigger
6044 # additional validation with other parts of the address (e.g. state/zip
6045 # validation in the U.S.A.).
6046 "organization": "A String", # Optional. The name of the organization at the address.
6047 "sublocality": "A String", # Optional. Sublocality of the address.
6048 # For example, this can be neighborhoods, boroughs, districts.
6049 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
6050 # the latest revision.
6051 #
6052 # All new revisions **must** be backward compatible with old revisions.
6053 },
6054 },
6055 },
6056 "jobSummary": "A String", # A summary of the job with core information that's displayed on the search
6057 # results listing page.
6058 "jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most
6059 # closely matching a search query's keywords, if available. The matching
6060 # query keywords are enclosed in HTML bold tags.
6061 },
6062 ],
6063 "histogramResults": { # Output only. # The histogram results that match specified
6064 # SearchJobsRequest.histogram_facets.
6065 #
6066 # Histogram results that match HistogramFacets specified in
6067 # SearchJobsRequest.
6068 "customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match
6069 # HistogramFacets.custom_attribute_histogram_facets.
6070 { # Output only.
6071 #
6072 # Custom attribute histogram result.
6073 "longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for
6074 # custom attribute long values associated with `key`.
6075 #
6076 # Custom numeric bucketing result.
6077 "counts": [ # Count within each bucket. Its size is the length of
6078 # NumericBucketingOption.bucket_bounds plus 1.
6079 { # Represents count of jobs within one bucket.
6080 "count": 42, # Number of jobs whose numeric field value fall into `range`.
6081 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
6082 # that is, the count represents number of jobs in this range.
6083 "to": 3.14, # Ending value of the bucket range.
6084 "from": 3.14, # Starting value of the bucket range.
6085 },
6086 },
6087 ],
6088 "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if
6089 # [NumericBucketingOption.requires_min_max] is set to true.
6090 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
6091 # [NumericBucketingOption.requires_min_max] is set to true.
6092 },
6093 "stringValueHistogramResult": { # Stores a map from the values of string custom field associated
6094 # with `key` to the number of jobs with that value in this histogram result.
6095 "a_key": 42,
6096 },
6097 "key": "A String", # Stores the key of custom attribute the histogram is performed on.
6098 },
6099 ],
6100 "simpleHistogramResults": [ # Specifies histogram results that matches
6101 # HistogramFacets.simple_histogram_facets.
6102 { # Output only.
6103 #
6104 # Result of a histogram call. The response contains the histogram map for the
6105 # search type specified by HistogramResult.field.
6106 # The response is a map of each filter value to the corresponding count of
6107 # jobs for that filter.
6108 "values": { # A map from the values of field to the number of jobs with that value
6109 # in this search result.
6110 #
6111 # Key: search type (filter names, such as the companyName).
6112 #
6113 # Values: the count of jobs that match the filter for this search.
6114 "a_key": 42,
6115 },
6116 "searchType": "A String", # The Histogram search filters.
6117 },
6118 ],
6119 "compensationHistogramResults": [ # Specifies compensation field-based histogram results that match
6120 # HistogramFacets.compensation_histogram_requests.
6121 { # Output only.
6122 #
6123 # Compensation based histogram result.
6124 "type": "A String", # Type of the request, corresponding to
6125 # CompensationHistogramRequest.type.
6126 "result": { # Output only. # Histogram result.
6127 #
6128 # Custom numeric bucketing result.
6129 "counts": [ # Count within each bucket. Its size is the length of
6130 # NumericBucketingOption.bucket_bounds plus 1.
6131 { # Represents count of jobs within one bucket.
6132 "count": 42, # Number of jobs whose numeric field value fall into `range`.
6133 "range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,
6134 # that is, the count represents number of jobs in this range.
6135 "to": 3.14, # Ending value of the bucket range.
6136 "from": 3.14, # Starting value of the bucket range.
6137 },
6138 },
6139 ],
6140 "maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if
6141 # [NumericBucketingOption.requires_min_max] is set to true.
6142 "minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if
6143 # [NumericBucketingOption.requires_min_max] is set to true.
6144 },
6145 },
6146 ],
6147 },
6148 "estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.
6149 #
6150 # This number is not guaranteed to be accurate. For accurate results,
6151 # see enable_precise_result_size.
6152 "broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the
6153 # broadened query. This number indicates how many of the jobs returned in the
6154 # jobs field are from the broadened query. These results are always at the
6155 # end of the jobs list. In particular, a value of 0, or if the field isn't
6156 # set, all the jobs in the jobs list are from the original
6157 # (without broadening) query. If this field is non-zero, subsequent requests
6158 # with offset after this result set should contain all broadened results.
6159 "locationFilters": [ # The location filters that the service applied to the specified query. If
6160 # any filters are lat-lng based, the JobLocation.location_type is
6161 # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.
6162 { # Output only.
6163 #
6164 # A resource that represents a location with full geographic information.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6165 "locationType": "A String", # The type of a location, which corresponds to the address lines field of
6166 # PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of
6167 # LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of
6168 # LocationType#LOCALITY.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6169 "radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the
6170 # location bounding box in which a circle with the specified radius
6171 # centered from LatLng covers the area associated with the job location.
6172 # For example, currently, "Mountain View, CA, USA" has a radius of
6173 # 6.17 miles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6174 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.
6175 # of doubles representing degrees latitude and degrees longitude. Unless
6176 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6177 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
6178 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6179 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
6180 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
6181 },
6182 "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,
6183 # such as postal delivery and payments addresses. Given a postal address,
6184 # a postal service can deliver items to a premises, P.O. Box, or other
6185 # delivery location.
6186 # Given a postal address, a postal service can deliver items to a premise, P.O.
6187 # Box or similar.
6188 # It is not intended to model geographical locations (roads, towns,
6189 # mountains).
6190 #
6191 # In typical usage an address would be created via user input or from importing
6192 # existing data, depending on the type of process.
6193 #
6194 # Advice on address input / editing:
6195 # - Use an i18n-ready address widget such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6196 # https://github.com/google/libaddressinput)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6197 # - Users should not be presented with UI elements for input or editing of
6198 # fields outside countries where that field is used.
6199 #
6200 # For more guidance on how to use this schema, please see:
6201 # https://support.google.com/business/answer/6397478
6202 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if
6203 # known). This is often the UI language of the input form or is expected
6204 # to match one of the languages used in the address' country/region, or their
6205 # transliterated equivalents.
6206 # This can affect formatting in certain countries, but is not critical
6207 # to the correctness of the data and will never affect any validation or
6208 # other non-formatting related operations.
6209 #
6210 # If this value is not known, it should be omitted (rather than specifying a
6211 # possibly incorrect default).
6212 #
6213 # Examples: "zh-Hant", "ja", "ja-Latn", "en".
6214 "recipients": [ # Optional. The recipient at the address.
6215 # This field may, under certain circumstances, contain multiline information.
6216 # For example, it might contain "care of" information.
6217 "A String",
6218 ],
6219 "locality": "A String", # Optional. Generally refers to the city/town portion of the address.
6220 # Examples: US city, IT comune, UK post town.
6221 # In regions of the world where localities are not well defined or do not fit
6222 # into this structure well, leave locality empty and use address_lines.
6223 "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used
6224 # in most regions. Where it is used, the value is either a string like
6225 # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
6226 # alone, representing the "sector code" (Jamaica), "delivery area indicator"
6227 # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
6228 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This
6229 # is never inferred and it is up to the user to ensure the value is
6230 # correct. See http://cldr.unicode.org/ and
6231 # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
6232 # for details. Example: "CH" for Switzerland.
6233 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal
6234 # addresses of a country or region.
6235 # For example, this can be a state, a province, an oblast, or a prefecture.
6236 # Specifically, for Spain this is the province and not the autonomous
6237 # community (e.g. "Barcelona" and not "Catalonia").
6238 # Many countries don't use an administrative area in postal addresses. E.g.
6239 # in Switzerland this should be left unpopulated.
6240 "addressLines": [ # Unstructured address lines describing the lower levels of an address.
6241 #
6242 # Because values in address_lines do not have type information and may
6243 # sometimes contain multiple values in a single field (e.g.
6244 # "Austin, TX"), it is important that the line order is clear. The order of
6245 # address lines should be "envelope order" for the country/region of the
6246 # address. In places where this can vary (e.g. Japan), address_language is
6247 # used to make it explicit (e.g. "ja" for large-to-small ordering and
6248 # "ja-Latn" or "en" for small-to-large). This way, the most specific line of
6249 # an address can be selected based on the language.
6250 #
6251 # The minimum permitted structural representation of an address consists
6252 # of a region_code with all remaining information placed in the
6253 # address_lines. It would be possible to format such an address very
6254 # approximately without geocoding, but no semantic reasoning could be
6255 # made about any of the address components until it was at least
6256 # partially resolved.
6257 #
6258 # Creating an address only containing a region_code and address_lines, and
6259 # then geocoding is the recommended way to handle completely unstructured
6260 # addresses (as opposed to guessing which parts of the address should be
6261 # localities or administrative areas).
6262 "A String",
6263 ],
6264 "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require
6265 # postal codes to be present, but where they are used, they may trigger
6266 # additional validation with other parts of the address (e.g. state/zip
6267 # validation in the U.S.A.).
6268 "organization": "A String", # Optional. The name of the organization at the address.
6269 "sublocality": "A String", # Optional. Sublocality of the address.
6270 # For example, this can be neighborhoods, boroughs, districts.
6271 "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is
6272 # the latest revision.
6273 #
6274 # All new revisions **must** be backward compatible with old revisions.
6275 },
6276 },
6277 ],
6278 "metadata": { # Output only. # Additional information for the API invocation, such as the request
6279 # tracking id.
6280 #
6281 # Additional information returned to client, such as debugging information.
6282 "requestId": "A String", # A unique id associated with this call.
6283 # This id is logged for tracking purposes.
6284 },
6285 }</pre>
6286</div>
6287
6288<div class="method">
6289 <code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code>
6290 <pre>Retrieves the next page of results.
6291
6292Args:
6293 previous_request: The request for the previous page. (required)
6294 previous_response: The response from the request for the previous page. (required)
6295
6296Returns:
6297 A request object that you can call 'execute()' on to request the next
6298 page. Returns None if there are no more items in the collection.
6299 </pre>
6300</div>
6301
6302<div class="method">
6303 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
6304 <pre>Retrieves the next page of results.
6305
6306Args:
6307 previous_request: The request for the previous page. (required)
6308 previous_response: The response from the request for the previous page. (required)
6309
6310Returns:
6311 A request object that you can call 'execute()' on to request the next
6312 page. Returns None if there are no more items in the collection.
6313 </pre>
6314</div>
6315
6316</body></html>