Blame - docs/dyn/jobs_v3.projects.jobs.html - platform/external/python/google-api-python-client

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Deletes a list of Jobs by filter.</p>

80

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Creates a new job.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes the specified job.</p>

86

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

90

<code><a href="#list">list(parent, filter=None, pageToken=None, jobView=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Lists jobs by filter.</p>

92

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

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Updates specified job.</p>

98

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>

101

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Searches for jobs using the provided SearchJobsRequest.</p>

104

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

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

<code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

<pre>Deletes a list of Jobs by filter.

114

115

Args:

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

117

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

118

The format is "projects/{project_id}", for example,

119

"projects/api-test-project". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

120

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

121

The object takes the form of:

{ # Input only.

#

# Batch delete jobs request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

126

"filter": "A String", # Required. The filter string specifies the jobs to be deleted.

Bu Sun Kim

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

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

135

# Sample Query: companyName = "projects/api-test-project/companies/123" AND

136

# requisitionId = "req-1"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

137

}

138

139

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

160

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

161

<pre>Creates a new job.

162

163

Typically, the job becomes searchable within 10 seconds, but it may take

164

up to 5 minutes.

165

166

Args:

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

168

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

169

The format is "projects/{project_id}", for example,

170

"projects/api-test-project". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

171

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

172

The object takes the form of:

{ # Input only.

#

# Create job request.

Bu Sun Kim

2020-05-20 12:08:20 -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.

178

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

179

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

180

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

181

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

182

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

183

"instruction": "A String", # Optional but at least one of uris,

184

# emails or instruction must be

185

# specified.

186

#

187

# Use this field to provide instructions, such as "Mail your application

188

# to ...", that a candidate can follow to apply for the job.

189

#

190

# This field accepts and sanitizes HTML input, and also accepts

191

# bold, italic, ordered list, and unordered list markup tags.

192

#

193

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

194

"uris": [ # Optional but at least one of uris,

195

# emails or instruction must be

196

# specified.

197

#

198

# Use this URI field to direct an applicant to a website, for example to

199

# link to an online application form.

200

#

201

# The maximum number of allowed characters for each entry is 2,000.

202

"A String",

203

],

204

"emails": [ # Optional but at least one of uris,

205

# emails or instruction must be

206

# specified.

207

#

208

# Use this field to specify email address(es) to which resumes or

209

# applications can be sent.

210

#

211

# The maximum number of allowed characters for each entry is 255.

212

"A String",

213

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

214

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

215

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

216

# recommended as an alternative to using the more general description

217

# field.

218

#

219

# This field accepts and sanitizes HTML input, and also accepts

220

# bold, italic, ordered list, and unordered list markup tags.

221

#

222

# The maximum number of allowed characters is 10,000.

223

"companyName": "A String", # Required. The resource name of the company listing the job, such as

224

# "projects/api-test-project/companies/foo".

225

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

226

# The value determines the sort order of the jobs returned when searching for

227

# jobs using the featured jobs search call, with higher promotional values

228

# being returned first and ties being resolved by relevance sort. Only the

229

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

230

#

231

# Default value is 0, and negative values are treated as 0.

232

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

233

"A String",

234

],

235

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

236

# description of the company and related information. Separate fields are

237

# provided on the job object for responsibilities,

238

# qualifications, and other job characteristics. Use of

239

# these separate job fields is recommended.

240

#

241

# This field accepts and sanitizes HTML input, and also accepts

242

# bold, italic, ordered list, and unordered list markup tags.

243

#

244

# The maximum number of allowed characters is 100,000.

245

"title": "A String", # Required. The title of the job, such as "Software Engineer"

246

#

247

# The maximum number of allowed characters is 500.

248

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

249

# value is the time the request arrives at the server. Invalid timestamps are

250

# ignored.

251

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

252

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

253

# incentives associated with the job not including salary or pay.

254

#

255

# The maximum number of allowed characters is 10,000.

256

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

257

# engagements. Invalid timestamps are ignored.

258

"addresses": [ # Optional but strongly recommended for the best service experience.

259

#

260

# Location(s) where the employer is looking to hire for this job posting.

261

#

262

# Specifying the full street address(es) of the hiring location enables

263

# better API results, especially job searches by commute time.

264

#

265

# At most 50 locations are allowed for best search performance. If a job has

266

# more locations, it is suggested to split it into multiple jobs with unique

267

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

268

# multiple jobs with the same company_name, language_code and

269

# requisition_id are not allowed. If the original requisition_id must

270

# be preserved, a custom field should be used for storage. It is also

271

# suggested to group the locations that close to each other in the same job

272

# for better search experience.

273

#

274

# The maximum number of allowed characters is 500.

275

"A String",

276

],

277

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

278

"jobBenefits": [ # Optional. The benefits included with the job.

279

"A String",

280

],

281

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

282

# job. The use of this field is recommended

283

# as an alternative to using the more general description field.

284

#

285

# This field accepts and sanitizes HTML input, and also accepts

286

# bold, italic, ordered list, and unordered list markup tags.

287

#

288

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

289

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

290

# the job is available. If this field is set, a

291

# LocationFilter in a search query within the job region

292

# finds this job posting if an exact location match isn't specified.

293

# If this field is set to PostingRegion.NATION or

294

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

295

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

296

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

297

# attributes that are not covered by the provided structured fields.

298

#

299

# The keys of the map are strings up to 64 bytes and must match the

300

# pattern: a-zA-Z*. For example, key0LikeThis or

301

# KEY_1_LIKE_THIS.

302

#

303

# At most 100 filterable and at most 100 unfilterable keys are supported.

304

# For filterable `string_values`, across all keys at most 200 values are

305

# allowed, with each string no more than 255 characters. For unfilterable

306

# `string_values`, the maximum total size of `string_values` across all keys

307

# is 50KB.

308

"a_key": { # Custom attribute values that are either filterable or non-filterable.

309

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

310

# custom attribute filters JobQuery.custom_attribute_filter.

311

# If false, these values may not be used for custom attribute filters.

312

#

313

# Default is false.

314

"stringValues": [ # Optional but exactly one of string_values or long_values must

315

# be specified.

316

#

317

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

318

# `CASE_INSENSITIVE_MATCH`) search.

319

# For filterable `string_value`s, a maximum total number of 200 values

320

# is allowed, with each `string_value` has a byte size of no more than

321

# 500B. For unfilterable `string_values`, the maximum total byte size of

322

# unfilterable `string_values` is 50KB.

323

#

324

# Empty string is not allowed.

325

"A String",

326

],

327

"longValues": [ # Optional but exactly one of string_values or long_values must

328

# be specified.

329

#

330

# This field is used to perform number range search.

331

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

332

#

333

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

339

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

344

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

345

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

346

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

347

# The expiration timestamp of the job. After this timestamp, the

348

# job is marked as expired, and it no longer appears in search results. The

349

# expired job can't be deleted or listed by the DeleteJob and

350

# ListJobs APIs, but it can be retrieved with the GetJob API or

351

# updated with the UpdateJob API. An expired job can be updated and

352

# opened again by using a future expiration timestamp. Updating an expired

353

# job fails if there is another existing open job with same company_name,

354

# language_code and requisition_id.

355

#

356

# The expired jobs are retained in our system for 90 days. However, the

357

# overall expired job count cannot exceed 3 times the maximum of open jobs

358

# count over the past week, otherwise jobs with earlier expire time are

359

# cleaned first. Expired jobs are no longer accessible after they are cleaned

360

# out.

361

#

362

# Invalid timestamps are ignored, and treated as expire time not provided.

363

#

364

# Timestamp before the instant request is made is considered valid, the job

365

# will be treated as expired immediately.

366

#

367

# If this value is not provided at the time of job creation or is invalid,

368

# the job posting expires after 30 days from the job's creation time. For

369

# example, if the job was created on 2017/01/01 13:00AM UTC with an

370

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

371

#

372

# If this value is not provided on job update, it depends on the field masks

373

# set by UpdateJobRequest.update_mask. If the field masks include

374

# expiry_time, or the masks are empty meaning that every field is

375

# updated, the job posting expires after 30 days from the job's last

376

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

377

"department": "A String", # Optional. The department or functional area within the company with the open

378

# position.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

379

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

380

# The maximum number of allowed characters is 255.

381

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

382

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

383

# Derived details about the job posting.

384

"locations": [ # Structured locations of the job, resolved from Job.addresses.

385

#

386

# locations are exactly matched to Job.addresses in the same

387

# order.

388

{ # Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

389

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

390

# A resource that represents a location with full geographic information.

391

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

392

# such as postal delivery and payments addresses. Given a postal address,

393

# a postal service can deliver items to a premises, P.O. Box, or other

394

# delivery location.

395

# Given a postal address, a postal service can deliver items to a premise, P.O.

396

# Box or similar.

397

# It is not intended to model geographical locations (roads, towns,

398

# mountains).

399

#

400

# In typical usage an address would be created via user input or from importing

401

# existing data, depending on the type of process.

402

#

403

# Advice on address input / editing:

404

# - Use an i18n-ready address widget such as

405

# https://github.com/google/libaddressinput)

406

# - Users should not be presented with UI elements for input or editing of

407

# fields outside countries where that field is used.

408

#

409

# For more guidance on how to use this schema, please see:

410

# https://support.google.com/business/answer/6397478

411

"organization": "A String", # Optional. The name of the organization at the address.

412

"sublocality": "A String", # Optional. Sublocality of the address.

413

# For example, this can be neighborhoods, boroughs, districts.

414

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

415

# known). This is often the UI language of the input form or is expected

416

# to match one of the languages used in the address' country/region, or their

417

# transliterated equivalents.

418

# This can affect formatting in certain countries, but is not critical

419

# to the correctness of the data and will never affect any validation or

420

# other non-formatting related operations.

421

#

422

# If this value is not known, it should be omitted (rather than specifying a

423

# possibly incorrect default).

424

#

425

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

426

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

427

# addresses of a country or region.

428

# For example, this can be a state, a province, an oblast, or a prefecture.

429

# Specifically, for Spain this is the province and not the autonomous

430

# community (e.g. "Barcelona" and not "Catalonia").

431

# Many countries don't use an administrative area in postal addresses. E.g.

432

# in Switzerland this should be left unpopulated.

433

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

434

# Examples: US city, IT comune, UK post town.

435

# In regions of the world where localities are not well defined or do not fit

436

# into this structure well, leave locality empty and use address_lines.

437

"recipients": [ # Optional. The recipient at the address.

438

# This field may, under certain circumstances, contain multiline information.

439

# For example, it might contain "care of" information.

440

"A String",

441

],

442

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

443

# the latest revision.

444

#

445

# All new revisions **must** be backward compatible with old revisions.

446

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

447

# postal codes to be present, but where they are used, they may trigger

448

# additional validation with other parts of the address (e.g. state/zip

449

# validation in the U.S.A.).

450

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

451

# in most regions. Where it is used, the value is either a string like

452

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

453

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

454

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

455

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

456

# is never inferred and it is up to the user to ensure the value is

457

# correct. See http://cldr.unicode.org/ and

458

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

459

# for details. Example: "CH" for Switzerland.

460

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

461

#

462

# Because values in address_lines do not have type information and may

463

# sometimes contain multiple values in a single field (e.g.

464

# "Austin, TX"), it is important that the line order is clear. The order of

465

# address lines should be "envelope order" for the country/region of the

466

# address. In places where this can vary (e.g. Japan), address_language is

467

# used to make it explicit (e.g. "ja" for large-to-small ordering and

468

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

469

# an address can be selected based on the language.

470

#

471

# The minimum permitted structural representation of an address consists

472

# of a region_code with all remaining information placed in the

473

# address_lines. It would be possible to format such an address very

474

# approximately without geocoding, but no semantic reasoning could be

475

# made about any of the address components until it was at least

476

# partially resolved.

477

#

478

# Creating an address only containing a region_code and address_lines, and

479

# then geocoding is the recommended way to handle completely unstructured

480

# addresses (as opposed to guessing which parts of the address should be

481

# localities or administrative areas).

"A String",

],

},

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

486

# location bounding box in which a circle with the specified radius

487

# centered from LatLng covers the area associated with the job location.

488

# For example, currently, "Mountain View, CA, USA" has a radius of

489

# 6.17 miles.

490

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

491

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

492

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

493

# LocationType#LOCALITY.

494

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

495

# of doubles representing degrees latitude and degrees longitude. Unless

496

# specified otherwise, this must conform to the

497

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

498

# standard</a>. Values must be within normalized ranges.

499

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

500

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

505

"A String",

506

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

507

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

508

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

509

# is used for contracting engagements. Invalid timestamps are ignored.

510

"visibility": "A String", # Deprecated. The job is only visible to the owner.

511

#

512

# The visibility of the job.

513

#

514

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

515

"processingOptions": { # Input only. # Optional. Options for job processing.

516

#

517

# Options for job processing.

518

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

519

# more precise address for the job.

520

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

521

#

522

# * description

523

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

529

# disabled.

530

#

531

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

532

},

533

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

534

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

535

# any requirements for fluency that are associated with the job.

536

#

537

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

538

# For more information, see

539

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

540

# class="external" target="_blank" }.

541

#

542

# If this field is unspecified and Job.description is present, detected

543

# language code based on Job.description is assigned, otherwise

544

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

545

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

546

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

547

# base compensation entry's CompensationEntry.compensation times

548

# CompensationEntry.expected_units_per_year.

549

#

550

# See CompensationEntry for explanation on compensation annualization.

551

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

552

# to a maximal compensation value and the currency code is set to

553

# match the currency code of

554

# min_compensation.

555

"nanos": 42, # Number of nano (10^-9) units of the amount.

556

# The value must be between -999,999,999 and +999,999,999 inclusive.

557

# If `units` is positive, `nanos` must be positive or zero.

558

# If `units` is zero, `nanos` can be positive, zero, or negative.

559

# If `units` is negative, `nanos` must be negative or zero.

560

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

561

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

562

"units": "A String", # The whole units of the amount.

563

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

564

},

565

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

566

# to zero and the currency code is set to match the

567

# currency code of max_compensation.

568

"nanos": 42, # Number of nano (10^-9) units of the amount.

569

# The value must be between -999,999,999 and +999,999,999 inclusive.

570

# If `units` is positive, `nanos` must be positive or zero.

571

# If `units` is zero, `nanos` can be positive, zero, or negative.

572

# If `units` is negative, `nanos` must be negative or zero.

573

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

574

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

575

"units": "A String", # The whole units of the amount.

576

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

577

},

578

},

579

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

580

# all compensation entries' CompensationEntry.compensation times

581

# CompensationEntry.expected_units_per_year.

582

#

583

# See CompensationEntry for explanation on compensation annualization.

584

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

585

# to a maximal compensation value and the currency code is set to

586

# match the currency code of

587

# min_compensation.

588

"nanos": 42, # Number of nano (10^-9) units of the amount.

589

# The value must be between -999,999,999 and +999,999,999 inclusive.

590

# If `units` is positive, `nanos` must be positive or zero.

591

# If `units` is zero, `nanos` can be positive, zero, or negative.

592

# If `units` is negative, `nanos` must be negative or zero.

593

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

594

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

595

"units": "A String", # The whole units of the amount.

596

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

597

},

598

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

599

# to zero and the currency code is set to match the

600

# currency code of max_compensation.

601

"nanos": 42, # Number of nano (10^-9) units of the amount.

602

# The value must be between -999,999,999 and +999,999,999 inclusive.

603

# If `units` is positive, `nanos` must be positive or zero.

604

# If `units` is zero, `nanos` can be positive, zero, or negative.

605

# If `units` is negative, `nanos` must be negative or zero.

606

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

607

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

608

"units": "A String", # The whole units of the amount.

609

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

610

},

611

},

612

"entries": [ # Optional. Job compensation information.

613

#

614

# At most one entry can be of type

615

# CompensationInfo.CompensationType.BASE, which is

616

# referred as ** base compensation entry ** for the job.

617

{ # A compensation entry that represents one component of compensation, such

618

# as base pay, bonus, or other compensation type.

619

#

620

# Annualization: One compensation entry can be annualized if

621

# - it contains valid amount or range.

622

# - and its expected_units_per_year is set or can be derived.

623

# Its annualized range is determined as (amount or range) times

624

# expected_units_per_year.

625

"unit": "A String", # Optional. Frequency of the specified amount.

626

#

627

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

628

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

629

# Job.employment_types is FULLTIME, a default value is inferred

630

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

637

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

638

# to a maximal compensation value and the currency code is set to

639

# match the currency code of

640

# min_compensation.

641

"nanos": 42, # Number of nano (10^-9) units of the amount.

642

# The value must be between -999,999,999 and +999,999,999 inclusive.

643

# If `units` is positive, `nanos` must be positive or zero.

644

# If `units` is zero, `nanos` can be positive, zero, or negative.

645

# If `units` is negative, `nanos` must be negative or zero.

646

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

647

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

648

"units": "A String", # The whole units of the amount.

649

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

650

},

651

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

652

# to zero and the currency code is set to match the

653

# currency code of max_compensation.

654

"nanos": 42, # Number of nano (10^-9) units of the amount.

655

# The value must be between -999,999,999 and +999,999,999 inclusive.

656

# If `units` is positive, `nanos` must be positive or zero.

657

# If `units` is zero, `nanos` can be positive, zero, or negative.

658

# If `units` is negative, `nanos` must be negative or zero.

659

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

660

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

661

"units": "A String", # The whole units of the amount.

662

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

663

},

664

},

665

"description": "A String", # Optional. Compensation description. For example, could

666

# indicate equity terms or provide additional context to an estimated

667

# bonus.

668

"type": "A String", # Optional. Compensation type.

669

#

670

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

671

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

672

"nanos": 42, # Number of nano (10^-9) units of the amount.

673

# The value must be between -999,999,999 and +999,999,999 inclusive.

674

# If `units` is positive, `nanos` must be positive or zero.

675

# If `units` is zero, `nanos` can be positive, zero, or negative.

676

# If `units` is negative, `nanos` must be negative or zero.

677

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

678

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

679

"units": "A String", # The whole units of the amount.

680

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

686

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

687

# The resource name for the job. This is generated by the service when a

688

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

689

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

690

# The format is "projects/{project_id}/jobs/{job_id}",

691

# for example, "projects/api-test-project/jobs/1234".

692

#

693

# Use of this field in job queries and API calls is preferred over the use of

694

# requisition_id since this value is unique.

695

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

696

# client to identify a job. This field is intended to be used by clients

697

# for client identification and tracking of postings. A job is not allowed

698

# to be created if there is another job with the same [company_name],

699

# language_code and requisition_id.

700

#

701

# The maximum number of allowed characters is 255.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

712

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

713

{ # A Job resource represents a job posting (also referred to as a "job listing"

714

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

715

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

716

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

717

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

718

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

719

"instruction": "A String", # Optional but at least one of uris,

720

# emails or instruction must be

721

# specified.

722

#

723

# Use this field to provide instructions, such as "Mail your application

724

# to ...", that a candidate can follow to apply for the job.

725

#

726

# This field accepts and sanitizes HTML input, and also accepts

727

# bold, italic, ordered list, and unordered list markup tags.

728

#

729

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

730

"uris": [ # Optional but at least one of uris,

731

# emails or instruction must be

732

# specified.

733

#

734

# Use this URI field to direct an applicant to a website, for example to

735

# link to an online application form.

736

#

737

# The maximum number of allowed characters for each entry is 2,000.

738

"A String",

739

],

740

"emails": [ # Optional but at least one of uris,

741

# emails or instruction must be

742

# specified.

743

#

744

# Use this field to specify email address(es) to which resumes or

745

# applications can be sent.

746

#

747

# The maximum number of allowed characters for each entry is 255.

748

"A String",

749

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

750

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

751

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

752

# recommended as an alternative to using the more general description

753

# field.

754

#

755

# This field accepts and sanitizes HTML input, and also accepts

756

# bold, italic, ordered list, and unordered list markup tags.

757

#

758

# The maximum number of allowed characters is 10,000.

759

"companyName": "A String", # Required. The resource name of the company listing the job, such as

760

# "projects/api-test-project/companies/foo".

761

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

762

# The value determines the sort order of the jobs returned when searching for

763

# jobs using the featured jobs search call, with higher promotional values

764

# being returned first and ties being resolved by relevance sort. Only the

765

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

766

#

767

# Default value is 0, and negative values are treated as 0.

768

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

769

"A String",

770

],

771

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

772

# description of the company and related information. Separate fields are

773

# provided on the job object for responsibilities,

774

# qualifications, and other job characteristics. Use of

775

# these separate job fields is recommended.

776

#

777

# This field accepts and sanitizes HTML input, and also accepts

778

# bold, italic, ordered list, and unordered list markup tags.

779

#

780

# The maximum number of allowed characters is 100,000.

781

"title": "A String", # Required. The title of the job, such as "Software Engineer"

782

#

783

# The maximum number of allowed characters is 500.

784

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

785

# value is the time the request arrives at the server. Invalid timestamps are

786

# ignored.

787

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

788

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

789

# incentives associated with the job not including salary or pay.

790

#

791

# The maximum number of allowed characters is 10,000.

792

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

793

# engagements. Invalid timestamps are ignored.

794

"addresses": [ # Optional but strongly recommended for the best service experience.

795

#

796

# Location(s) where the employer is looking to hire for this job posting.

797

#

798

# Specifying the full street address(es) of the hiring location enables

799

# better API results, especially job searches by commute time.

800

#

801

# At most 50 locations are allowed for best search performance. If a job has

802

# more locations, it is suggested to split it into multiple jobs with unique

803

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

804

# multiple jobs with the same company_name, language_code and

805

# requisition_id are not allowed. If the original requisition_id must

806

# be preserved, a custom field should be used for storage. It is also

807

# suggested to group the locations that close to each other in the same job

808

# for better search experience.

809

#

810

# The maximum number of allowed characters is 500.

811

"A String",

812

],

813

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

814

"jobBenefits": [ # Optional. The benefits included with the job.

815

"A String",

816

],

817

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

818

# job. The use of this field is recommended

819

# as an alternative to using the more general description field.

820

#

821

# This field accepts and sanitizes HTML input, and also accepts

822

# bold, italic, ordered list, and unordered list markup tags.

823

#

824

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

825

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

826

# the job is available. If this field is set, a

827

# LocationFilter in a search query within the job region

828

# finds this job posting if an exact location match isn't specified.

829

# If this field is set to PostingRegion.NATION or

830

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

831

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

832

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

833

# attributes that are not covered by the provided structured fields.

834

#

835

# The keys of the map are strings up to 64 bytes and must match the

836

# pattern: a-zA-Z*. For example, key0LikeThis or

837

# KEY_1_LIKE_THIS.

838

#

839

# At most 100 filterable and at most 100 unfilterable keys are supported.

840

# For filterable `string_values`, across all keys at most 200 values are

841

# allowed, with each string no more than 255 characters. For unfilterable

842

# `string_values`, the maximum total size of `string_values` across all keys

843

# is 50KB.

844

"a_key": { # Custom attribute values that are either filterable or non-filterable.

845

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

846

# custom attribute filters JobQuery.custom_attribute_filter.

847

# If false, these values may not be used for custom attribute filters.

848

#

849

# Default is false.

850

"stringValues": [ # Optional but exactly one of string_values or long_values must

851

# be specified.

852

#

853

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

854

# `CASE_INSENSITIVE_MATCH`) search.

855

# For filterable `string_value`s, a maximum total number of 200 values

856

# is allowed, with each `string_value` has a byte size of no more than

857

# 500B. For unfilterable `string_values`, the maximum total byte size of

858

# unfilterable `string_values` is 50KB.

859

#

860

# Empty string is not allowed.

861

"A String",

862

],

863

"longValues": [ # Optional but exactly one of string_values or long_values must

864

# be specified.

865

#

866

# This field is used to perform number range search.

867

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

868

#

869

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

875

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

880

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

881

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

882

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

883

# The expiration timestamp of the job. After this timestamp, the

884

# job is marked as expired, and it no longer appears in search results. The

885

# expired job can't be deleted or listed by the DeleteJob and

886

# ListJobs APIs, but it can be retrieved with the GetJob API or

887

# updated with the UpdateJob API. An expired job can be updated and

888

# opened again by using a future expiration timestamp. Updating an expired

889

# job fails if there is another existing open job with same company_name,

890

# language_code and requisition_id.

891

#

892

# The expired jobs are retained in our system for 90 days. However, the

893

# overall expired job count cannot exceed 3 times the maximum of open jobs

894

# count over the past week, otherwise jobs with earlier expire time are

895

# cleaned first. Expired jobs are no longer accessible after they are cleaned

896

# out.

897

#

898

# Invalid timestamps are ignored, and treated as expire time not provided.

899

#

900

# Timestamp before the instant request is made is considered valid, the job

901

# will be treated as expired immediately.

902

#

903

# If this value is not provided at the time of job creation or is invalid,

904

# the job posting expires after 30 days from the job's creation time. For

905

# example, if the job was created on 2017/01/01 13:00AM UTC with an

906

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

907

#

908

# If this value is not provided on job update, it depends on the field masks

909

# set by UpdateJobRequest.update_mask. If the field masks include

910

# expiry_time, or the masks are empty meaning that every field is

911

# updated, the job posting expires after 30 days from the job's last

912

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

913

"department": "A String", # Optional. The department or functional area within the company with the open

914

# position.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

915

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

916

# The maximum number of allowed characters is 255.

917

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

918

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

919

# Derived details about the job posting.

920

"locations": [ # Structured locations of the job, resolved from Job.addresses.

921

#

922

# locations are exactly matched to Job.addresses in the same

923

# order.

924

{ # Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

925

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

926

# A resource that represents a location with full geographic information.

927

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

928

# such as postal delivery and payments addresses. Given a postal address,

929

# a postal service can deliver items to a premises, P.O. Box, or other

930

# delivery location.

931

# Given a postal address, a postal service can deliver items to a premise, P.O.

932

# Box or similar.

933

# It is not intended to model geographical locations (roads, towns,

934

# mountains).

935

#

936

# In typical usage an address would be created via user input or from importing

937

# existing data, depending on the type of process.

938

#

939

# Advice on address input / editing:

940

# - Use an i18n-ready address widget such as

941

# https://github.com/google/libaddressinput)

942

# - Users should not be presented with UI elements for input or editing of

943

# fields outside countries where that field is used.

944

#

945

# For more guidance on how to use this schema, please see:

946

# https://support.google.com/business/answer/6397478

947

"organization": "A String", # Optional. The name of the organization at the address.

948

"sublocality": "A String", # Optional. Sublocality of the address.

949

# For example, this can be neighborhoods, boroughs, districts.

950

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

951

# known). This is often the UI language of the input form or is expected

952

# to match one of the languages used in the address' country/region, or their

953

# transliterated equivalents.

954

# This can affect formatting in certain countries, but is not critical

955

# to the correctness of the data and will never affect any validation or

956

# other non-formatting related operations.

957

#

958

# If this value is not known, it should be omitted (rather than specifying a

959

# possibly incorrect default).

960

#

961

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

962

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

963

# addresses of a country or region.

964

# For example, this can be a state, a province, an oblast, or a prefecture.

965

# Specifically, for Spain this is the province and not the autonomous

966

# community (e.g. "Barcelona" and not "Catalonia").

967

# Many countries don't use an administrative area in postal addresses. E.g.

968

# in Switzerland this should be left unpopulated.

969

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

970

# Examples: US city, IT comune, UK post town.

971

# In regions of the world where localities are not well defined or do not fit

972

# into this structure well, leave locality empty and use address_lines.

973

"recipients": [ # Optional. The recipient at the address.

974

# This field may, under certain circumstances, contain multiline information.

975

# For example, it might contain "care of" information.

976

"A String",

977

],

978

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

979

# the latest revision.

980

#

981

# All new revisions **must** be backward compatible with old revisions.

982

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

983

# postal codes to be present, but where they are used, they may trigger

984

# additional validation with other parts of the address (e.g. state/zip

985

# validation in the U.S.A.).

986

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

987

# in most regions. Where it is used, the value is either a string like

988

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

989

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

990

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

991

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

992

# is never inferred and it is up to the user to ensure the value is

993

# correct. See http://cldr.unicode.org/ and

994

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

995

# for details. Example: "CH" for Switzerland.

996

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

997

#

998

# Because values in address_lines do not have type information and may

999

# sometimes contain multiple values in a single field (e.g.

1000

# "Austin, TX"), it is important that the line order is clear. The order of

1001

# address lines should be "envelope order" for the country/region of the

1002

# address. In places where this can vary (e.g. Japan), address_language is

1003

# used to make it explicit (e.g. "ja" for large-to-small ordering and

1004

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

1005

# an address can be selected based on the language.

1006

#

1007

# The minimum permitted structural representation of an address consists

1008

# of a region_code with all remaining information placed in the

1009

# address_lines. It would be possible to format such an address very

1010

# approximately without geocoding, but no semantic reasoning could be

1011

# made about any of the address components until it was at least

1012

# partially resolved.

1013

#

1014

# Creating an address only containing a region_code and address_lines, and

1015

# then geocoding is the recommended way to handle completely unstructured

1016

# addresses (as opposed to guessing which parts of the address should be

1017

# localities or administrative areas).

"A String",

],

},

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

1022

# location bounding box in which a circle with the specified radius

1023

# centered from LatLng covers the area associated with the job location.

1024

# For example, currently, "Mountain View, CA, USA" has a radius of

1025

# 6.17 miles.

1026

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

1027

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

1028

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

1029

# LocationType#LOCALITY.

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

1033

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1034

# standard</a>. Values must be within normalized ranges.

1035

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

1036

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

1041

"A String",

1042

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1043

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1044

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

1045

# is used for contracting engagements. Invalid timestamps are ignored.

1046

"visibility": "A String", # Deprecated. The job is only visible to the owner.

1047

#

1048

# The visibility of the job.

1049

#

1050

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

1051

"processingOptions": { # Input only. # Optional. Options for job processing.

1052

#

1053

# Options for job processing.

1054

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

1055

# more precise address for the job.

1056

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

1057

#

1058

# * description

1059

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

1065

# disabled.

1066

#

1067

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

1068

},

1069

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1070

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

1071

# any requirements for fluency that are associated with the job.

1072

#

1073

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

1074

# For more information, see

1075

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

1076

# class="external" target="_blank" }.

1077

#

1078

# If this field is unspecified and Job.description is present, detected

1079

# language code based on Job.description is assigned, otherwise

1080

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1081

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

1082

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

1083

# base compensation entry's CompensationEntry.compensation times

1084

# CompensationEntry.expected_units_per_year.

1085

#

1086

# See CompensationEntry for explanation on compensation annualization.

1087

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1088

# to a maximal compensation value and the currency code is set to

1089

# match the currency code of

1090

# min_compensation.

1091

"nanos": 42, # Number of nano (10^-9) units of the amount.

1092

# The value must be between -999,999,999 and +999,999,999 inclusive.

1093

# If `units` is positive, `nanos` must be positive or zero.

1094

# If `units` is zero, `nanos` can be positive, zero, or negative.

1095

# If `units` is negative, `nanos` must be negative or zero.

1096

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1097

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1098

"units": "A String", # The whole units of the amount.

1099

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1100

},

1101

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1102

# to zero and the currency code is set to match the

1103

# currency code of max_compensation.

1104

"nanos": 42, # Number of nano (10^-9) units of the amount.

1105

# The value must be between -999,999,999 and +999,999,999 inclusive.

1106

# If `units` is positive, `nanos` must be positive or zero.

1107

# If `units` is zero, `nanos` can be positive, zero, or negative.

1108

# If `units` is negative, `nanos` must be negative or zero.

1109

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1110

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1111

"units": "A String", # The whole units of the amount.

1112

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1113

},

1114

},

1115

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

1116

# all compensation entries' CompensationEntry.compensation times

1117

# CompensationEntry.expected_units_per_year.

1118

#

1119

# See CompensationEntry for explanation on compensation annualization.

1120

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1121

# to a maximal compensation value and the currency code is set to

1122

# match the currency code of

1123

# min_compensation.

1124

"nanos": 42, # Number of nano (10^-9) units of the amount.

1125

# The value must be between -999,999,999 and +999,999,999 inclusive.

1126

# If `units` is positive, `nanos` must be positive or zero.

1127

# If `units` is zero, `nanos` can be positive, zero, or negative.

1128

# If `units` is negative, `nanos` must be negative or zero.

1129

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1130

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1131

"units": "A String", # The whole units of the amount.

1132

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1133

},

1134

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1135

# to zero and the currency code is set to match the

1136

# currency code of max_compensation.

1137

"nanos": 42, # Number of nano (10^-9) units of the amount.

1138

# The value must be between -999,999,999 and +999,999,999 inclusive.

1139

# If `units` is positive, `nanos` must be positive or zero.

1140

# If `units` is zero, `nanos` can be positive, zero, or negative.

1141

# If `units` is negative, `nanos` must be negative or zero.

1142

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1143

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1144

"units": "A String", # The whole units of the amount.

1145

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1146

},

1147

},

1148

"entries": [ # Optional. Job compensation information.

1149

#

1150

# At most one entry can be of type

1151

# CompensationInfo.CompensationType.BASE, which is

1152

# referred as ** base compensation entry ** for the job.

1153

{ # A compensation entry that represents one component of compensation, such

1154

# as base pay, bonus, or other compensation type.

1155

#

1156

# Annualization: One compensation entry can be annualized if

1157

# - it contains valid amount or range.

1158

# - and its expected_units_per_year is set or can be derived.

1159

# Its annualized range is determined as (amount or range) times

1160

# expected_units_per_year.

1161

"unit": "A String", # Optional. Frequency of the specified amount.

1162

#

1163

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

1164

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

1165

# Job.employment_types is FULLTIME, a default value is inferred

1166

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

1173

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1174

# to a maximal compensation value and the currency code is set to

1175

# match the currency code of

1176

# min_compensation.

1177

"nanos": 42, # Number of nano (10^-9) units of the amount.

1178

# The value must be between -999,999,999 and +999,999,999 inclusive.

1179

# If `units` is positive, `nanos` must be positive or zero.

1180

# If `units` is zero, `nanos` can be positive, zero, or negative.

1181

# If `units` is negative, `nanos` must be negative or zero.

1182

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1183

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1184

"units": "A String", # The whole units of the amount.

1185

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1186

},

1187

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1188

# to zero and the currency code is set to match the

1189

# currency code of max_compensation.

1190

"nanos": 42, # Number of nano (10^-9) units of the amount.

1191

# The value must be between -999,999,999 and +999,999,999 inclusive.

1192

# If `units` is positive, `nanos` must be positive or zero.

1193

# If `units` is zero, `nanos` can be positive, zero, or negative.

1194

# If `units` is negative, `nanos` must be negative or zero.

1195

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1196

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1197

"units": "A String", # The whole units of the amount.

1198

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1199

},

1200

},

1201

"description": "A String", # Optional. Compensation description. For example, could

1202

# indicate equity terms or provide additional context to an estimated

1203

# bonus.

1204

"type": "A String", # Optional. Compensation type.

1205

#

1206

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

1207

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

1208

"nanos": 42, # Number of nano (10^-9) units of the amount.

1209

# The value must be between -999,999,999 and +999,999,999 inclusive.

1210

# If `units` is positive, `nanos` must be positive or zero.

1211

# If `units` is zero, `nanos` can be positive, zero, or negative.

1212

# If `units` is negative, `nanos` must be negative or zero.

1213

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1214

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1215

"units": "A String", # The whole units of the amount.

1216

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1222

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1223

# The resource name for the job. This is generated by the service when a

1224

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1225

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1226

# The format is "projects/{project_id}/jobs/{job_id}",

1227

# for example, "projects/api-test-project/jobs/1234".

1228

#

1229

# Use of this field in job queries and API calls is preferred over the use of

1230

# requisition_id since this value is unique.

1231

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

1232

# client to identify a job. This field is intended to be used by clients

1233

# for client identification and tracking of postings. A job is not allowed

1234

# to be created if there is another job with the same [company_name],

1235

# language_code and requisition_id.

1236

#

1237

# The maximum number of allowed characters is 255.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

1243

<pre>Deletes the specified job.

1244

1245

Typically, the job becomes unsearchable within 10 seconds, but it may take

1246

up to 5 minutes.

1247

1248

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1249

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1250

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1251

The format is "projects/{project_id}/jobs/{job_id}",

1252

for example, "projects/api-test-project/jobs/1234". (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1253

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1260

1261

{ # A generic empty message that you can re-use to avoid defining duplicated

1262

# empty messages in your APIs. A typical example is to use it as the request

1263

# or the response type of an API method. For instance:

1264

#

1265

# service Foo {

1266

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1267

# }

1268

#

1269

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

1275

<pre>Retrieves the specified job, whose status is OPEN or recently EXPIRED

1276

within the last 90 days.

1277

1278

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1279

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1280

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1281

The format is "projects/{project_id}/jobs/{job_id}",

1282

for example, "projects/api-test-project/jobs/1234". (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1283

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1290

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1291

{ # A Job resource represents a job posting (also referred to as a "job listing"

1292

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1293

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1294

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1295

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1296

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1297

"instruction": "A String", # Optional but at least one of uris,

1298

# emails or instruction must be

1299

# specified.

1300

#

1301

# Use this field to provide instructions, such as "Mail your application

1302

# to ...", that a candidate can follow to apply for the job.

1303

#

1304

# This field accepts and sanitizes HTML input, and also accepts

1305

# bold, italic, ordered list, and unordered list markup tags.

1306

#

1307

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1308

"uris": [ # Optional but at least one of uris,

1309

# emails or instruction must be

1310

# specified.

1311

#

1312

# Use this URI field to direct an applicant to a website, for example to

1313

# link to an online application form.

1314

#

1315

# The maximum number of allowed characters for each entry is 2,000.

1316

"A String",

1317

],

1318

"emails": [ # Optional but at least one of uris,

1319

# emails or instruction must be

1320

# specified.

1321

#

1322

# Use this field to specify email address(es) to which resumes or

1323

# applications can be sent.

1324

#

1325

# The maximum number of allowed characters for each entry is 255.

1326

"A String",

1327

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1328

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1329

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

1330

# recommended as an alternative to using the more general description

1331

# field.

1332

#

1333

# This field accepts and sanitizes HTML input, and also accepts

1334

# bold, italic, ordered list, and unordered list markup tags.

1335

#

1336

# The maximum number of allowed characters is 10,000.

1337

"companyName": "A String", # Required. The resource name of the company listing the job, such as

1338

# "projects/api-test-project/companies/foo".

1339

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

1340

# The value determines the sort order of the jobs returned when searching for

1341

# jobs using the featured jobs search call, with higher promotional values

1342

# being returned first and ties being resolved by relevance sort. Only the

1343

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

1344

#

1345

# Default value is 0, and negative values are treated as 0.

1346

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

1347

"A String",

1348

],

1349

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

1350

# description of the company and related information. Separate fields are

1351

# provided on the job object for responsibilities,

1352

# qualifications, and other job characteristics. Use of

1353

# these separate job fields is recommended.

1354

#

1355

# This field accepts and sanitizes HTML input, and also accepts

1356

# bold, italic, ordered list, and unordered list markup tags.

1357

#

1358

# The maximum number of allowed characters is 100,000.

1359

"title": "A String", # Required. The title of the job, such as "Software Engineer"

1360

#

1361

# The maximum number of allowed characters is 500.

1362

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

1363

# value is the time the request arrives at the server. Invalid timestamps are

1364

# ignored.

1365

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

1366

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

1367

# incentives associated with the job not including salary or pay.

1368

#

1369

# The maximum number of allowed characters is 10,000.

1370

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

1371

# engagements. Invalid timestamps are ignored.

1372

"addresses": [ # Optional but strongly recommended for the best service experience.

1373

#

1374

# Location(s) where the employer is looking to hire for this job posting.

1375

#

1376

# Specifying the full street address(es) of the hiring location enables

1377

# better API results, especially job searches by commute time.

1378

#

1379

# At most 50 locations are allowed for best search performance. If a job has

1380

# more locations, it is suggested to split it into multiple jobs with unique

1381

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

1382

# multiple jobs with the same company_name, language_code and

1383

# requisition_id are not allowed. If the original requisition_id must

1384

# be preserved, a custom field should be used for storage. It is also

1385

# suggested to group the locations that close to each other in the same job

1386

# for better search experience.

1387

#

1388

# The maximum number of allowed characters is 500.

1389

"A String",

1390

],

1391

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

1392

"jobBenefits": [ # Optional. The benefits included with the job.

1393

"A String",

1394

],

1395

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

1396

# job. The use of this field is recommended

1397

# as an alternative to using the more general description field.

1398

#

1399

# This field accepts and sanitizes HTML input, and also accepts

1400

# bold, italic, ordered list, and unordered list markup tags.

1401

#

1402

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1403

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

1404

# the job is available. If this field is set, a

1405

# LocationFilter in a search query within the job region

1406

# finds this job posting if an exact location match isn't specified.

1407

# If this field is set to PostingRegion.NATION or

1408

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

1409

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1410

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

1411

# attributes that are not covered by the provided structured fields.

1412

#

1413

# The keys of the map are strings up to 64 bytes and must match the

1414

# pattern: a-zA-Z*. For example, key0LikeThis or

1415

# KEY_1_LIKE_THIS.

1416

#

1417

# At most 100 filterable and at most 100 unfilterable keys are supported.

1418

# For filterable `string_values`, across all keys at most 200 values are

1419

# allowed, with each string no more than 255 characters. For unfilterable

1420

# `string_values`, the maximum total size of `string_values` across all keys

1421

# is 50KB.

1422

"a_key": { # Custom attribute values that are either filterable or non-filterable.

1423

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

1424

# custom attribute filters JobQuery.custom_attribute_filter.

1425

# If false, these values may not be used for custom attribute filters.

1426

#

1427

# Default is false.

1428

"stringValues": [ # Optional but exactly one of string_values or long_values must

1429

# be specified.

1430

#

1431

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

1432

# `CASE_INSENSITIVE_MATCH`) search.

1433

# For filterable `string_value`s, a maximum total number of 200 values

1434

# is allowed, with each `string_value` has a byte size of no more than

1435

# 500B. For unfilterable `string_values`, the maximum total byte size of

1436

# unfilterable `string_values` is 50KB.

1437

#

1438

# Empty string is not allowed.

1439

"A String",

1440

],

1441

"longValues": [ # Optional but exactly one of string_values or long_values must

1442

# be specified.

1443

#

1444

# This field is used to perform number range search.

1445

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

1446

#

1447

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

1453

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1458

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

1459

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1460

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1461

# The expiration timestamp of the job. After this timestamp, the

1462

# job is marked as expired, and it no longer appears in search results. The

1463

# expired job can't be deleted or listed by the DeleteJob and

1464

# ListJobs APIs, but it can be retrieved with the GetJob API or

1465

# updated with the UpdateJob API. An expired job can be updated and

1466

# opened again by using a future expiration timestamp. Updating an expired

1467

# job fails if there is another existing open job with same company_name,

1468

# language_code and requisition_id.

1469

#

1470

# The expired jobs are retained in our system for 90 days. However, the

1471

# overall expired job count cannot exceed 3 times the maximum of open jobs

1472

# count over the past week, otherwise jobs with earlier expire time are

1473

# cleaned first. Expired jobs are no longer accessible after they are cleaned

1474

# out.

1475

#

1476

# Invalid timestamps are ignored, and treated as expire time not provided.

1477

#

1478

# Timestamp before the instant request is made is considered valid, the job

1479

# will be treated as expired immediately.

1480

#

1481

# If this value is not provided at the time of job creation or is invalid,

1482

# the job posting expires after 30 days from the job's creation time. For

1483

# example, if the job was created on 2017/01/01 13:00AM UTC with an

1484

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

1485

#

1486

# If this value is not provided on job update, it depends on the field masks

1487

# set by UpdateJobRequest.update_mask. If the field masks include

1488

# expiry_time, or the masks are empty meaning that every field is

1489

# updated, the job posting expires after 30 days from the job's last

1490

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1491

"department": "A String", # Optional. The department or functional area within the company with the open

1492

# position.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1493

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1494

# The maximum number of allowed characters is 255.

1495

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1496

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1497

# Derived details about the job posting.

1498

"locations": [ # Structured locations of the job, resolved from Job.addresses.

1499

#

1500

# locations are exactly matched to Job.addresses in the same

1501

# order.

1502

{ # Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1503

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1504

# A resource that represents a location with full geographic information.

1505

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

1506

# such as postal delivery and payments addresses. Given a postal address,

1507

# a postal service can deliver items to a premises, P.O. Box, or other

1508

# delivery location.

1509

# Given a postal address, a postal service can deliver items to a premise, P.O.

1510

# Box or similar.

1511

# It is not intended to model geographical locations (roads, towns,

1512

# mountains).

1513

#

1514

# In typical usage an address would be created via user input or from importing

1515

# existing data, depending on the type of process.

1516

#

1517

# Advice on address input / editing:

1518

# - Use an i18n-ready address widget such as

1519

# https://github.com/google/libaddressinput)

1520

# - Users should not be presented with UI elements for input or editing of

1521

# fields outside countries where that field is used.

1522

#

1523

# For more guidance on how to use this schema, please see:

1524

# https://support.google.com/business/answer/6397478

1525

"organization": "A String", # Optional. The name of the organization at the address.

1526

"sublocality": "A String", # Optional. Sublocality of the address.

1527

# For example, this can be neighborhoods, boroughs, districts.

1528

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

1529

# known). This is often the UI language of the input form or is expected

1530

# to match one of the languages used in the address' country/region, or their

1531

# transliterated equivalents.

1532

# This can affect formatting in certain countries, but is not critical

1533

# to the correctness of the data and will never affect any validation or

1534

# other non-formatting related operations.

1535

#

1536

# If this value is not known, it should be omitted (rather than specifying a

1537

# possibly incorrect default).

1538

#

1539

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

1540

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

1541

# addresses of a country or region.

1542

# For example, this can be a state, a province, an oblast, or a prefecture.

1543

# Specifically, for Spain this is the province and not the autonomous

1544

# community (e.g. "Barcelona" and not "Catalonia").

1545

# Many countries don't use an administrative area in postal addresses. E.g.

1546

# in Switzerland this should be left unpopulated.

1547

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

1548

# Examples: US city, IT comune, UK post town.

1549

# In regions of the world where localities are not well defined or do not fit

1550

# into this structure well, leave locality empty and use address_lines.

1551

"recipients": [ # Optional. The recipient at the address.

1552

# This field may, under certain circumstances, contain multiline information.

1553

# For example, it might contain "care of" information.

1554

"A String",

1555

],

1556

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

1557

# the latest revision.

1558

#

1559

# All new revisions **must** be backward compatible with old revisions.

1560

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

1561

# postal codes to be present, but where they are used, they may trigger

1562

# additional validation with other parts of the address (e.g. state/zip

1563

# validation in the U.S.A.).

1564

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

1565

# in most regions. Where it is used, the value is either a string like

1566

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

1567

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

1568

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

1569

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

1570

# is never inferred and it is up to the user to ensure the value is

1571

# correct. See http://cldr.unicode.org/ and

1572

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

1573

# for details. Example: "CH" for Switzerland.

1574

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

1575

#

1576

# Because values in address_lines do not have type information and may

1577

# sometimes contain multiple values in a single field (e.g.

1578

# "Austin, TX"), it is important that the line order is clear. The order of

1579

# address lines should be "envelope order" for the country/region of the

1580

# address. In places where this can vary (e.g. Japan), address_language is

1581

# used to make it explicit (e.g. "ja" for large-to-small ordering and

1582

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

1583

# an address can be selected based on the language.

1584

#

1585

# The minimum permitted structural representation of an address consists

1586

# of a region_code with all remaining information placed in the

1587

# address_lines. It would be possible to format such an address very

1588

# approximately without geocoding, but no semantic reasoning could be

1589

# made about any of the address components until it was at least

1590

# partially resolved.

1591

#

1592

# Creating an address only containing a region_code and address_lines, and

1593

# then geocoding is the recommended way to handle completely unstructured

1594

# addresses (as opposed to guessing which parts of the address should be

1595

# localities or administrative areas).

"A String",

],

},

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

1600

# location bounding box in which a circle with the specified radius

1601

# centered from LatLng covers the area associated with the job location.

1602

# For example, currently, "Mountain View, CA, USA" has a radius of

1603

# 6.17 miles.

1604

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

1605

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

1606

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

1607

# LocationType#LOCALITY.

1608

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

1609

# of doubles representing degrees latitude and degrees longitude. Unless

1610

# specified otherwise, this must conform to the

1611

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1612

# standard</a>. Values must be within normalized ranges.

1613

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

1614

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

1619

"A String",

1620

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1621

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1622

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

1623

# is used for contracting engagements. Invalid timestamps are ignored.

1624

"visibility": "A String", # Deprecated. The job is only visible to the owner.

1625

#

1626

# The visibility of the job.

1627

#

1628

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

1629

"processingOptions": { # Input only. # Optional. Options for job processing.

1630

#

1631

# Options for job processing.

1632

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

1633

# more precise address for the job.

1634

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

1635

#

1636

# * description

1637

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

1643

# disabled.

1644

#

1645

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

1646

},

1647

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1648

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

1649

# any requirements for fluency that are associated with the job.

1650

#

1651

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

1652

# For more information, see

1653

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

1654

# class="external" target="_blank" }.

1655

#

1656

# If this field is unspecified and Job.description is present, detected

1657

# language code based on Job.description is assigned, otherwise

1658

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1659

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

1660

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

1661

# base compensation entry's CompensationEntry.compensation times

1662

# CompensationEntry.expected_units_per_year.

1663

#

1664

# See CompensationEntry for explanation on compensation annualization.

1665

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1666

# to a maximal compensation value and the currency code is set to

1667

# match the currency code of

1668

# min_compensation.

1669

"nanos": 42, # Number of nano (10^-9) units of the amount.

1670

# The value must be between -999,999,999 and +999,999,999 inclusive.

1671

# If `units` is positive, `nanos` must be positive or zero.

1672

# If `units` is zero, `nanos` can be positive, zero, or negative.

1673

# If `units` is negative, `nanos` must be negative or zero.

1674

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1675

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1676

"units": "A String", # The whole units of the amount.

1677

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1678

},

1679

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1680

# to zero and the currency code is set to match the

1681

# currency code of max_compensation.

1682

"nanos": 42, # Number of nano (10^-9) units of the amount.

1683

# The value must be between -999,999,999 and +999,999,999 inclusive.

1684

# If `units` is positive, `nanos` must be positive or zero.

1685

# If `units` is zero, `nanos` can be positive, zero, or negative.

1686

# If `units` is negative, `nanos` must be negative or zero.

1687

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1688

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1689

"units": "A String", # The whole units of the amount.

1690

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1691

},

1692

},

1693

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

1694

# all compensation entries' CompensationEntry.compensation times

1695

# CompensationEntry.expected_units_per_year.

1696

#

1697

# See CompensationEntry for explanation on compensation annualization.

1698

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1699

# to a maximal compensation value and the currency code is set to

1700

# match the currency code of

1701

# min_compensation.

1702

"nanos": 42, # Number of nano (10^-9) units of the amount.

1703

# The value must be between -999,999,999 and +999,999,999 inclusive.

1704

# If `units` is positive, `nanos` must be positive or zero.

1705

# If `units` is zero, `nanos` can be positive, zero, or negative.

1706

# If `units` is negative, `nanos` must be negative or zero.

1707

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1708

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1709

"units": "A String", # The whole units of the amount.

1710

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1711

},

1712

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1713

# to zero and the currency code is set to match the

1714

# currency code of max_compensation.

1715

"nanos": 42, # Number of nano (10^-9) units of the amount.

1716

# The value must be between -999,999,999 and +999,999,999 inclusive.

1717

# If `units` is positive, `nanos` must be positive or zero.

1718

# If `units` is zero, `nanos` can be positive, zero, or negative.

1719

# If `units` is negative, `nanos` must be negative or zero.

1720

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1721

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1722

"units": "A String", # The whole units of the amount.

1723

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1724

},

1725

},

1726

"entries": [ # Optional. Job compensation information.

1727

#

1728

# At most one entry can be of type

1729

# CompensationInfo.CompensationType.BASE, which is

1730

# referred as ** base compensation entry ** for the job.

1731

{ # A compensation entry that represents one component of compensation, such

1732

# as base pay, bonus, or other compensation type.

1733

#

1734

# Annualization: One compensation entry can be annualized if

1735

# - it contains valid amount or range.

1736

# - and its expected_units_per_year is set or can be derived.

1737

# Its annualized range is determined as (amount or range) times

1738

# expected_units_per_year.

1739

"unit": "A String", # Optional. Frequency of the specified amount.

1740

#

1741

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

1742

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

1743

# Job.employment_types is FULLTIME, a default value is inferred

1744

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

1751

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1752

# to a maximal compensation value and the currency code is set to

1753

# match the currency code of

1754

# min_compensation.

1755

"nanos": 42, # Number of nano (10^-9) units of the amount.

1756

# The value must be between -999,999,999 and +999,999,999 inclusive.

1757

# If `units` is positive, `nanos` must be positive or zero.

1758

# If `units` is zero, `nanos` can be positive, zero, or negative.

1759

# If `units` is negative, `nanos` must be negative or zero.

1760

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1761

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1762

"units": "A String", # The whole units of the amount.

1763

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1764

},

1765

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1766

# to zero and the currency code is set to match the

1767

# currency code of max_compensation.

1768

"nanos": 42, # Number of nano (10^-9) units of the amount.

1769

# The value must be between -999,999,999 and +999,999,999 inclusive.

1770

# If `units` is positive, `nanos` must be positive or zero.

1771

# If `units` is zero, `nanos` can be positive, zero, or negative.

1772

# If `units` is negative, `nanos` must be negative or zero.

1773

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1774

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1775

"units": "A String", # The whole units of the amount.

1776

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1777

},

1778

},

1779

"description": "A String", # Optional. Compensation description. For example, could

1780

# indicate equity terms or provide additional context to an estimated

1781

# bonus.

1782

"type": "A String", # Optional. Compensation type.

1783

#

1784

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

1785

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

1786

"nanos": 42, # Number of nano (10^-9) units of the amount.

1787

# The value must be between -999,999,999 and +999,999,999 inclusive.

1788

# If `units` is positive, `nanos` must be positive or zero.

1789

# If `units` is zero, `nanos` can be positive, zero, or negative.

1790

# If `units` is negative, `nanos` must be negative or zero.

1791

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1792

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1793

"units": "A String", # The whole units of the amount.

1794

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1800

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1801

# The resource name for the job. This is generated by the service when a

1802

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1803

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1804

# The format is "projects/{project_id}/jobs/{job_id}",

1805

# for example, "projects/api-test-project/jobs/1234".

1806

#

1807

# Use of this field in job queries and API calls is preferred over the use of

1808

# requisition_id since this value is unique.

1809

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

1810

# client to identify a job. This field is intended to be used by clients

1811

# for client identification and tracking of postings. A job is not allowed

1812

# to be created if there is another job with the same [company_name],

1813

# language_code and requisition_id.

1814

#

1815

# The maximum number of allowed characters is 255.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1820

<code class="details" id="list">list(parent, filter=None, pageToken=None, jobView=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1821

<pre>Lists jobs by filter.

1822

1823

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1824

parent: string, Required. The resource name of the project under which the job is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1825

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1826

The format is "projects/{project_id}", for example,

1827

"projects/api-test-project". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1828

filter: string, Required. The filter string specifies the jobs to be enumerated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1829

1830

Supported operator: =, AND

1831

1832

The fields eligible for filtering are:

1833

1834

* `companyName` (Required)

1835

* `requisitionId` (Optional)

Sample Query:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1839

* companyName = "projects/api-test-project/companies/123"

1840

* companyName = "projects/api-test-project/companies/123" AND requisitionId

1841

= "req-1"

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1842

pageToken: string, Optional. The starting point of a query result.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1843

jobView: string, Optional. The desired job attributes returned for jobs in the

1844

search response. Defaults to JobView.JOB_VIEW_FULL if no value is

1845

specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1846

pageSize: integer, Optional. The maximum number of jobs to be returned per page of results.

1847

1848

If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed

1849

page size is 1000. Otherwise, the maximum allowed page size is 100.

1850

1851

Default is 100 if empty or a number < 1 is specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1852

x__xgafv: string, V1 error format.

1853

Allowed values

1854

1 - v1 error format

1855

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1856

1857

Returns:

1858

An object of the form:

{ # Output only.

#

# List jobs response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1863

"nextPageToken": "A String", # A token to retrieve the next page of results.

1864

"metadata": { # Output only. # Additional information for the API invocation, such as the request

1865

# tracking id.

1866

#

1867

# Additional information returned to client, such as debugging information.

1868

"requestId": "A String", # A unique id associated with this call.

1869

# This id is logged for tracking purposes.

1870

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1871

"jobs": [ # The Jobs for a given company.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1872

#

1873

# The maximum number of items returned is based on the limit field

1874

# provided in the request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

{ # A Job resource represents a job posting (also referred to as a "job listing"

1876

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1877

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1879

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1880

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1881

"instruction": "A String", # Optional but at least one of uris,

1882

# emails or instruction must be

1883

# specified.

1884

#

1885

# Use this field to provide instructions, such as "Mail your application

1886

# to ...", that a candidate can follow to apply for the job.

1887

#

1888

# This field accepts and sanitizes HTML input, and also accepts

1889

# bold, italic, ordered list, and unordered list markup tags.

1890

#

1891

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1892

"uris": [ # Optional but at least one of uris,

1893

# emails or instruction must be

1894

# specified.

1895

#

1896

# Use this URI field to direct an applicant to a website, for example to

1897

# link to an online application form.

1898

#

1899

# The maximum number of allowed characters for each entry is 2,000.

1900

"A String",

1901

],

1902

"emails": [ # Optional but at least one of uris,

1903

# emails or instruction must be

1904

# specified.

1905

#

1906

# Use this field to specify email address(es) to which resumes or

1907

# applications can be sent.

1908

#

1909

# The maximum number of allowed characters for each entry is 255.

1910

"A String",

1911

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1912

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1913

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

1914

# recommended as an alternative to using the more general description

1915

# field.

1916

#

1917

# This field accepts and sanitizes HTML input, and also accepts

1918

# bold, italic, ordered list, and unordered list markup tags.

1919

#

1920

# The maximum number of allowed characters is 10,000.

1921

"companyName": "A String", # Required. The resource name of the company listing the job, such as

1922

# "projects/api-test-project/companies/foo".

1923

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

1924

# The value determines the sort order of the jobs returned when searching for

1925

# jobs using the featured jobs search call, with higher promotional values

1926

# being returned first and ties being resolved by relevance sort. Only the

1927

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

1928

#

1929

# Default value is 0, and negative values are treated as 0.

1930

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

1931

"A String",

1932

],

1933

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

1934

# description of the company and related information. Separate fields are

1935

# provided on the job object for responsibilities,

1936

# qualifications, and other job characteristics. Use of

1937

# these separate job fields is recommended.

1938

#

1939

# This field accepts and sanitizes HTML input, and also accepts

1940

# bold, italic, ordered list, and unordered list markup tags.

1941

#

1942

# The maximum number of allowed characters is 100,000.

1943

"title": "A String", # Required. The title of the job, such as "Software Engineer"

1944

#

1945

# The maximum number of allowed characters is 500.

1946

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

1947

# value is the time the request arrives at the server. Invalid timestamps are

1948

# ignored.

1949

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

1950

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

1951

# incentives associated with the job not including salary or pay.

1952

#

1953

# The maximum number of allowed characters is 10,000.

1954

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

1955

# engagements. Invalid timestamps are ignored.

1956

"addresses": [ # Optional but strongly recommended for the best service experience.

1957

#

1958

# Location(s) where the employer is looking to hire for this job posting.

1959

#

1960

# Specifying the full street address(es) of the hiring location enables

1961

# better API results, especially job searches by commute time.

1962

#

1963

# At most 50 locations are allowed for best search performance. If a job has

1964

# more locations, it is suggested to split it into multiple jobs with unique

1965

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

1966

# multiple jobs with the same company_name, language_code and

1967

# requisition_id are not allowed. If the original requisition_id must

1968

# be preserved, a custom field should be used for storage. It is also

1969

# suggested to group the locations that close to each other in the same job

1970

# for better search experience.

1971

#

1972

# The maximum number of allowed characters is 500.

1973

"A String",

1974

],

1975

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

1976

"jobBenefits": [ # Optional. The benefits included with the job.

1977

"A String",

1978

],

1979

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

1980

# job. The use of this field is recommended

1981

# as an alternative to using the more general description field.

1982

#

1983

# This field accepts and sanitizes HTML input, and also accepts

1984

# bold, italic, ordered list, and unordered list markup tags.

1985

#

1986

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1987

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

1988

# the job is available. If this field is set, a

1989

# LocationFilter in a search query within the job region

1990

# finds this job posting if an exact location match isn't specified.

1991

# If this field is set to PostingRegion.NATION or

1992

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

1993

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1994

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

1995

# attributes that are not covered by the provided structured fields.

1996

#

1997

# The keys of the map are strings up to 64 bytes and must match the

1998

# pattern: a-zA-Z*. For example, key0LikeThis or

1999

# KEY_1_LIKE_THIS.

2000

#

2001

# At most 100 filterable and at most 100 unfilterable keys are supported.

2002

# For filterable `string_values`, across all keys at most 200 values are

2003

# allowed, with each string no more than 255 characters. For unfilterable

2004

# `string_values`, the maximum total size of `string_values` across all keys

2005

# is 50KB.

2006

"a_key": { # Custom attribute values that are either filterable or non-filterable.

2007

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

2008

# custom attribute filters JobQuery.custom_attribute_filter.

2009

# If false, these values may not be used for custom attribute filters.

2010

#

2011

# Default is false.

2012

"stringValues": [ # Optional but exactly one of string_values or long_values must

2013

# be specified.

2014

#

2015

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

2016

# `CASE_INSENSITIVE_MATCH`) search.

2017

# For filterable `string_value`s, a maximum total number of 200 values

2018

# is allowed, with each `string_value` has a byte size of no more than

2019

# 500B. For unfilterable `string_values`, the maximum total byte size of

2020

# unfilterable `string_values` is 50KB.

2021

#

2022

# Empty string is not allowed.

2023

"A String",

2024

],

2025

"longValues": [ # Optional but exactly one of string_values or long_values must

2026

# be specified.

2027

#

2028

# This field is used to perform number range search.

2029

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

2030

#

2031

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

2037

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2042

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

2043

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2044

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2045

# The expiration timestamp of the job. After this timestamp, the

2046

# job is marked as expired, and it no longer appears in search results. The

2047

# expired job can't be deleted or listed by the DeleteJob and

2048

# ListJobs APIs, but it can be retrieved with the GetJob API or

2049

# updated with the UpdateJob API. An expired job can be updated and

2050

# opened again by using a future expiration timestamp. Updating an expired

2051

# job fails if there is another existing open job with same company_name,

2052

# language_code and requisition_id.

2053

#

2054

# The expired jobs are retained in our system for 90 days. However, the

2055

# overall expired job count cannot exceed 3 times the maximum of open jobs

2056

# count over the past week, otherwise jobs with earlier expire time are

2057

# cleaned first. Expired jobs are no longer accessible after they are cleaned

2058

# out.

2059

#

2060

# Invalid timestamps are ignored, and treated as expire time not provided.

2061

#

2062

# Timestamp before the instant request is made is considered valid, the job

2063

# will be treated as expired immediately.

2064

#

2065

# If this value is not provided at the time of job creation or is invalid,

2066

# the job posting expires after 30 days from the job's creation time. For

2067

# example, if the job was created on 2017/01/01 13:00AM UTC with an

2068

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

2069

#

2070

# If this value is not provided on job update, it depends on the field masks

2071

# set by UpdateJobRequest.update_mask. If the field masks include

2072

# expiry_time, or the masks are empty meaning that every field is

2073

# updated, the job posting expires after 30 days from the job's last

2074

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2075

"department": "A String", # Optional. The department or functional area within the company with the open

2076

# position.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2077

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2078

# The maximum number of allowed characters is 255.

2079

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2080

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2081

# Derived details about the job posting.

2082

"locations": [ # Structured locations of the job, resolved from Job.addresses.

2083

#

2084

# locations are exactly matched to Job.addresses in the same

2085

# order.

2086

{ # Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2087

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2088

# A resource that represents a location with full geographic information.

2089

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

2090

# such as postal delivery and payments addresses. Given a postal address,

2091

# a postal service can deliver items to a premises, P.O. Box, or other

2092

# delivery location.

2093

# Given a postal address, a postal service can deliver items to a premise, P.O.

2094

# Box or similar.

2095

# It is not intended to model geographical locations (roads, towns,

2096

# mountains).

2097

#

2098

# In typical usage an address would be created via user input or from importing

2099

# existing data, depending on the type of process.

2100

#

2101

# Advice on address input / editing:

2102

# - Use an i18n-ready address widget such as

2103

# https://github.com/google/libaddressinput)

2104

# - Users should not be presented with UI elements for input or editing of

2105

# fields outside countries where that field is used.

2106

#

2107

# For more guidance on how to use this schema, please see:

2108

# https://support.google.com/business/answer/6397478

2109

"organization": "A String", # Optional. The name of the organization at the address.

2110

"sublocality": "A String", # Optional. Sublocality of the address.

2111

# For example, this can be neighborhoods, boroughs, districts.

2112

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

2113

# known). This is often the UI language of the input form or is expected

2114

# to match one of the languages used in the address' country/region, or their

2115

# transliterated equivalents.

2116

# This can affect formatting in certain countries, but is not critical

2117

# to the correctness of the data and will never affect any validation or

2118

# other non-formatting related operations.

2119

#

2120

# If this value is not known, it should be omitted (rather than specifying a

2121

# possibly incorrect default).

2122

#

2123

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

2124

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

2125

# addresses of a country or region.

2126

# For example, this can be a state, a province, an oblast, or a prefecture.

2127

# Specifically, for Spain this is the province and not the autonomous

2128

# community (e.g. "Barcelona" and not "Catalonia").

2129

# Many countries don't use an administrative area in postal addresses. E.g.

2130

# in Switzerland this should be left unpopulated.

2131

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

2132

# Examples: US city, IT comune, UK post town.

2133

# In regions of the world where localities are not well defined or do not fit

2134

# into this structure well, leave locality empty and use address_lines.

2135

"recipients": [ # Optional. The recipient at the address.

2136

# This field may, under certain circumstances, contain multiline information.

2137

# For example, it might contain "care of" information.

2138

"A String",

2139

],

2140

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

2141

# the latest revision.

2142

#

2143

# All new revisions **must** be backward compatible with old revisions.

2144

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

2145

# postal codes to be present, but where they are used, they may trigger

2146

# additional validation with other parts of the address (e.g. state/zip

2147

# validation in the U.S.A.).

2148

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

2149

# in most regions. Where it is used, the value is either a string like

2150

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

2151

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

2152

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

2153

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

2154

# is never inferred and it is up to the user to ensure the value is

2155

# correct. See http://cldr.unicode.org/ and

2156

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

2157

# for details. Example: "CH" for Switzerland.

2158

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

2159

#

2160

# Because values in address_lines do not have type information and may

2161

# sometimes contain multiple values in a single field (e.g.

2162

# "Austin, TX"), it is important that the line order is clear. The order of

2163

# address lines should be "envelope order" for the country/region of the

2164

# address. In places where this can vary (e.g. Japan), address_language is

2165

# used to make it explicit (e.g. "ja" for large-to-small ordering and

2166

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

2167

# an address can be selected based on the language.

2168

#

2169

# The minimum permitted structural representation of an address consists

2170

# of a region_code with all remaining information placed in the

2171

# address_lines. It would be possible to format such an address very

2172

# approximately without geocoding, but no semantic reasoning could be

2173

# made about any of the address components until it was at least

2174

# partially resolved.

2175

#

2176

# Creating an address only containing a region_code and address_lines, and

2177

# then geocoding is the recommended way to handle completely unstructured

2178

# addresses (as opposed to guessing which parts of the address should be

2179

# localities or administrative areas).

"A String",

],

},

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

2184

# location bounding box in which a circle with the specified radius

2185

# centered from LatLng covers the area associated with the job location.

2186

# For example, currently, "Mountain View, CA, USA" has a radius of

2187

# 6.17 miles.

2188

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

2189

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

2190

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

2191

# LocationType#LOCALITY.

2192

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

2193

# of doubles representing degrees latitude and degrees longitude. Unless

2194

# specified otherwise, this must conform to the

2195

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

2196

# standard</a>. Values must be within normalized ranges.

2197

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

2198

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

2203

"A String",

2204

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2205

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2206

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

2207

# is used for contracting engagements. Invalid timestamps are ignored.

2208

"visibility": "A String", # Deprecated. The job is only visible to the owner.

2209

#

2210

# The visibility of the job.

2211

#

2212

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

2213

"processingOptions": { # Input only. # Optional. Options for job processing.

2214

#

2215

# Options for job processing.

2216

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

2217

# more precise address for the job.

2218

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

2219

#

2220

# * description

2221

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

2227

# disabled.

2228

#

2229

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

2230

},

2231

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2232

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

2233

# any requirements for fluency that are associated with the job.

2234

#

2235

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

2236

# For more information, see

2237

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

2238

# class="external" target="_blank" }.

2239

#

2240

# If this field is unspecified and Job.description is present, detected

2241

# language code based on Job.description is assigned, otherwise

2242

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2243

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

2244

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

2245

# base compensation entry's CompensationEntry.compensation times

2246

# CompensationEntry.expected_units_per_year.

2247

#

2248

# See CompensationEntry for explanation on compensation annualization.

2249

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2250

# to a maximal compensation value and the currency code is set to

2251

# match the currency code of

2252

# min_compensation.

2253

"nanos": 42, # Number of nano (10^-9) units of the amount.

2254

# The value must be between -999,999,999 and +999,999,999 inclusive.

2255

# If `units` is positive, `nanos` must be positive or zero.

2256

# If `units` is zero, `nanos` can be positive, zero, or negative.

2257

# If `units` is negative, `nanos` must be negative or zero.

2258

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2259

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2260

"units": "A String", # The whole units of the amount.

2261

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2262

},

2263

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2264

# to zero and the currency code is set to match the

2265

# currency code of max_compensation.

2266

"nanos": 42, # Number of nano (10^-9) units of the amount.

2267

# The value must be between -999,999,999 and +999,999,999 inclusive.

2268

# If `units` is positive, `nanos` must be positive or zero.

2269

# If `units` is zero, `nanos` can be positive, zero, or negative.

2270

# If `units` is negative, `nanos` must be negative or zero.

2271

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2272

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2273

"units": "A String", # The whole units of the amount.

2274

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2275

},

2276

},

2277

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

2278

# all compensation entries' CompensationEntry.compensation times

2279

# CompensationEntry.expected_units_per_year.

2280

#

2281

# See CompensationEntry for explanation on compensation annualization.

2282

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2283

# to a maximal compensation value and the currency code is set to

2284

# match the currency code of

2285

# min_compensation.

2286

"nanos": 42, # Number of nano (10^-9) units of the amount.

2287

# The value must be between -999,999,999 and +999,999,999 inclusive.

2288

# If `units` is positive, `nanos` must be positive or zero.

2289

# If `units` is zero, `nanos` can be positive, zero, or negative.

2290

# If `units` is negative, `nanos` must be negative or zero.

2291

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2292

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2293

"units": "A String", # The whole units of the amount.

2294

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2295

},

2296

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2297

# to zero and the currency code is set to match the

2298

# currency code of max_compensation.

2299

"nanos": 42, # Number of nano (10^-9) units of the amount.

2300

# The value must be between -999,999,999 and +999,999,999 inclusive.

2301

# If `units` is positive, `nanos` must be positive or zero.

2302

# If `units` is zero, `nanos` can be positive, zero, or negative.

2303

# If `units` is negative, `nanos` must be negative or zero.

2304

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2305

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2306

"units": "A String", # The whole units of the amount.

2307

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2308

},

2309

},

2310

"entries": [ # Optional. Job compensation information.

2311

#

2312

# At most one entry can be of type

2313

# CompensationInfo.CompensationType.BASE, which is

2314

# referred as ** base compensation entry ** for the job.

2315

{ # A compensation entry that represents one component of compensation, such

2316

# as base pay, bonus, or other compensation type.

2317

#

2318

# Annualization: One compensation entry can be annualized if

2319

# - it contains valid amount or range.

2320

# - and its expected_units_per_year is set or can be derived.

2321

# Its annualized range is determined as (amount or range) times

2322

# expected_units_per_year.

2323

"unit": "A String", # Optional. Frequency of the specified amount.

2324

#

2325

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

2326

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

2327

# Job.employment_types is FULLTIME, a default value is inferred

2328

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

2335

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2336

# to a maximal compensation value and the currency code is set to

2337

# match the currency code of

2338

# min_compensation.

2339

"nanos": 42, # Number of nano (10^-9) units of the amount.

2340

# The value must be between -999,999,999 and +999,999,999 inclusive.

2341

# If `units` is positive, `nanos` must be positive or zero.

2342

# If `units` is zero, `nanos` can be positive, zero, or negative.

2343

# If `units` is negative, `nanos` must be negative or zero.

2344

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2345

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2346

"units": "A String", # The whole units of the amount.

2347

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2348

},

2349

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2350

# to zero and the currency code is set to match the

2351

# currency code of max_compensation.

2352

"nanos": 42, # Number of nano (10^-9) units of the amount.

2353

# The value must be between -999,999,999 and +999,999,999 inclusive.

2354

# If `units` is positive, `nanos` must be positive or zero.

2355

# If `units` is zero, `nanos` can be positive, zero, or negative.

2356

# If `units` is negative, `nanos` must be negative or zero.

2357

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2358

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2359

"units": "A String", # The whole units of the amount.

2360

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2361

},

2362

},

2363

"description": "A String", # Optional. Compensation description. For example, could

2364

# indicate equity terms or provide additional context to an estimated

2365

# bonus.

2366

"type": "A String", # Optional. Compensation type.

2367

#

2368

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

2369

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

2370

"nanos": 42, # Number of nano (10^-9) units of the amount.

2371

# The value must be between -999,999,999 and +999,999,999 inclusive.

2372

# If `units` is positive, `nanos` must be positive or zero.

2373

# If `units` is zero, `nanos` can be positive, zero, or negative.

2374

# If `units` is negative, `nanos` must be negative or zero.

2375

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2376

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2377

"units": "A String", # The whole units of the amount.

2378

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2384

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2385

# The resource name for the job. This is generated by the service when a

2386

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2387

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2388

# The format is "projects/{project_id}/jobs/{job_id}",

2389

# for example, "projects/api-test-project/jobs/1234".

2390

#

2391

# Use of this field in job queries and API calls is preferred over the use of

2392

# requisition_id since this value is unique.

2393

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

2394

# client to identify a job. This field is intended to be used by clients

2395

# for client identification and tracking of postings. A job is not allowed

2396

# to be created if there is another job with the same [company_name],

2397

# language_code and requisition_id.

2398

#

2399

# The maximum number of allowed characters is 255.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2400

},

2401

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2407

<pre>Retrieves the next page of results.

2408

2409

Args:

2410

previous_request: The request for the previous page. (required)

2411

previous_response: The response from the request for the previous page. (required)

2412

2413

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2414

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2415

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2420

<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2421

<pre>Updates specified job.

2422

2423

Typically, updated contents become visible in search results within 10

2424

seconds, but it may take up to 5 minutes.

Args:

The resource name for the job. This is generated by the service when a

2430

job is created.

2431

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2432

The format is "projects/{project_id}/jobs/{job_id}",

2433

for example, "projects/api-test-project/jobs/1234".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2434

2435

Use of this field in job queries and API calls is preferred over the use of

2436

requisition_id since this value is unique. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2437

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2438

The object takes the form of:

{ # Input only.

#

# Update job request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2443

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be updated.

2444

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2445

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2446

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2447

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2448

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2449

"instruction": "A String", # Optional but at least one of uris,

2450

# emails or instruction must be

2451

# specified.

2452

#

2453

# Use this field to provide instructions, such as "Mail your application

2454

# to ...", that a candidate can follow to apply for the job.

2455

#

2456

# This field accepts and sanitizes HTML input, and also accepts

2457

# bold, italic, ordered list, and unordered list markup tags.

2458

#

2459

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2460

"uris": [ # Optional but at least one of uris,

2461

# emails or instruction must be

2462

# specified.

2463

#

2464

# Use this URI field to direct an applicant to a website, for example to

2465

# link to an online application form.

2466

#

2467

# The maximum number of allowed characters for each entry is 2,000.

2468

"A String",

2469

],

2470

"emails": [ # Optional but at least one of uris,

2471

# emails or instruction must be

2472

# specified.

2473

#

2474

# Use this field to specify email address(es) to which resumes or

2475

# applications can be sent.

2476

#

2477

# The maximum number of allowed characters for each entry is 255.

2478

"A String",

2479

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2480

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2481

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

2482

# recommended as an alternative to using the more general description

2483

# field.

2484

#

2485

# This field accepts and sanitizes HTML input, and also accepts

2486

# bold, italic, ordered list, and unordered list markup tags.

2487

#

2488

# The maximum number of allowed characters is 10,000.

2489

"companyName": "A String", # Required. The resource name of the company listing the job, such as

2490

# "projects/api-test-project/companies/foo".

2491

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

2492

# The value determines the sort order of the jobs returned when searching for

2493

# jobs using the featured jobs search call, with higher promotional values

2494

# being returned first and ties being resolved by relevance sort. Only the

2495

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

2496

#

2497

# Default value is 0, and negative values are treated as 0.

2498

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

2499

"A String",

2500

],

2501

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

2502

# description of the company and related information. Separate fields are

2503

# provided on the job object for responsibilities,

2504

# qualifications, and other job characteristics. Use of

2505

# these separate job fields is recommended.

2506

#

2507

# This field accepts and sanitizes HTML input, and also accepts

2508

# bold, italic, ordered list, and unordered list markup tags.

2509

#

2510

# The maximum number of allowed characters is 100,000.

2511

"title": "A String", # Required. The title of the job, such as "Software Engineer"

2512

#

2513

# The maximum number of allowed characters is 500.

2514

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

2515

# value is the time the request arrives at the server. Invalid timestamps are

2516

# ignored.

2517

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

2518

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

2519

# incentives associated with the job not including salary or pay.

2520

#

2521

# The maximum number of allowed characters is 10,000.

2522

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

2523

# engagements. Invalid timestamps are ignored.

2524

"addresses": [ # Optional but strongly recommended for the best service experience.

2525

#

2526

# Location(s) where the employer is looking to hire for this job posting.

2527

#

2528

# Specifying the full street address(es) of the hiring location enables

2529

# better API results, especially job searches by commute time.

2530

#

2531

# At most 50 locations are allowed for best search performance. If a job has

2532

# more locations, it is suggested to split it into multiple jobs with unique

2533

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

2534

# multiple jobs with the same company_name, language_code and

2535

# requisition_id are not allowed. If the original requisition_id must

2536

# be preserved, a custom field should be used for storage. It is also

2537

# suggested to group the locations that close to each other in the same job

2538

# for better search experience.

2539

#

2540

# The maximum number of allowed characters is 500.

2541

"A String",

2542

],

2543

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

2544

"jobBenefits": [ # Optional. The benefits included with the job.

2545

"A String",

2546

],

2547

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

2548

# job. The use of this field is recommended

2549

# as an alternative to using the more general description field.

2550

#

2551

# This field accepts and sanitizes HTML input, and also accepts

2552

# bold, italic, ordered list, and unordered list markup tags.

2553

#

2554

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2555

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

2556

# the job is available. If this field is set, a

2557

# LocationFilter in a search query within the job region

2558

# finds this job posting if an exact location match isn't specified.

2559

# If this field is set to PostingRegion.NATION or

2560

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

2561

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2562

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

2563

# attributes that are not covered by the provided structured fields.

2564

#

2565

# The keys of the map are strings up to 64 bytes and must match the

2566

# pattern: a-zA-Z*. For example, key0LikeThis or

2567

# KEY_1_LIKE_THIS.

2568

#

2569

# At most 100 filterable and at most 100 unfilterable keys are supported.

2570

# For filterable `string_values`, across all keys at most 200 values are

2571

# allowed, with each string no more than 255 characters. For unfilterable

2572

# `string_values`, the maximum total size of `string_values` across all keys

2573

# is 50KB.

2574

"a_key": { # Custom attribute values that are either filterable or non-filterable.

2575

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

2576

# custom attribute filters JobQuery.custom_attribute_filter.

2577

# If false, these values may not be used for custom attribute filters.

2578

#

2579

# Default is false.

2580

"stringValues": [ # Optional but exactly one of string_values or long_values must

2581

# be specified.

2582

#

2583

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

2584

# `CASE_INSENSITIVE_MATCH`) search.

2585

# For filterable `string_value`s, a maximum total number of 200 values

2586

# is allowed, with each `string_value` has a byte size of no more than

2587

# 500B. For unfilterable `string_values`, the maximum total byte size of

2588

# unfilterable `string_values` is 50KB.

2589

#

2590

# Empty string is not allowed.

2591

"A String",

2592

],

2593

"longValues": [ # Optional but exactly one of string_values or long_values must

2594

# be specified.

2595

#

2596

# This field is used to perform number range search.

2597

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

2598

#

2599

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

2605

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2610

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

2611

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2612

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2613

# The expiration timestamp of the job. After this timestamp, the

2614

# job is marked as expired, and it no longer appears in search results. The

2615

# expired job can't be deleted or listed by the DeleteJob and

2616

# ListJobs APIs, but it can be retrieved with the GetJob API or

2617

# updated with the UpdateJob API. An expired job can be updated and

2618

# opened again by using a future expiration timestamp. Updating an expired

2619

# job fails if there is another existing open job with same company_name,

2620

# language_code and requisition_id.

2621

#

2622

# The expired jobs are retained in our system for 90 days. However, the

2623

# overall expired job count cannot exceed 3 times the maximum of open jobs

2624

# count over the past week, otherwise jobs with earlier expire time are

2625

# cleaned first. Expired jobs are no longer accessible after they are cleaned

2626

# out.

2627

#

2628

# Invalid timestamps are ignored, and treated as expire time not provided.

2629

#

2630

# Timestamp before the instant request is made is considered valid, the job

2631

# will be treated as expired immediately.

2632

#

2633

# If this value is not provided at the time of job creation or is invalid,

2634

# the job posting expires after 30 days from the job's creation time. For

2635

# example, if the job was created on 2017/01/01 13:00AM UTC with an

2636

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

2637

#

2638

# If this value is not provided on job update, it depends on the field masks

2639

# set by UpdateJobRequest.update_mask. If the field masks include

2640

# expiry_time, or the masks are empty meaning that every field is

2641

# updated, the job posting expires after 30 days from the job's last

2642

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2643

"department": "A String", # Optional. The department or functional area within the company with the open

2644

# position.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2645

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2646

# The maximum number of allowed characters is 255.

2647

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2648

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2649

# Derived details about the job posting.

2650

"locations": [ # Structured locations of the job, resolved from Job.addresses.

2651

#

2652

# locations are exactly matched to Job.addresses in the same

2653

# order.

2654

{ # Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2655

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2656

# A resource that represents a location with full geographic information.

2657

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

2658

# such as postal delivery and payments addresses. Given a postal address,

2659

# a postal service can deliver items to a premises, P.O. Box, or other

2660

# delivery location.

2661

# Given a postal address, a postal service can deliver items to a premise, P.O.

2662

# Box or similar.

2663

# It is not intended to model geographical locations (roads, towns,

2664

# mountains).

2665

#

2666

# In typical usage an address would be created via user input or from importing

2667

# existing data, depending on the type of process.

2668

#

2669

# Advice on address input / editing:

2670

# - Use an i18n-ready address widget such as

2671

# https://github.com/google/libaddressinput)

2672

# - Users should not be presented with UI elements for input or editing of

2673

# fields outside countries where that field is used.

2674

#

2675

# For more guidance on how to use this schema, please see:

2676

# https://support.google.com/business/answer/6397478

2677

"organization": "A String", # Optional. The name of the organization at the address.

2678

"sublocality": "A String", # Optional. Sublocality of the address.

2679

# For example, this can be neighborhoods, boroughs, districts.

2680

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

2681

# known). This is often the UI language of the input form or is expected

2682

# to match one of the languages used in the address' country/region, or their

2683

# transliterated equivalents.

2684

# This can affect formatting in certain countries, but is not critical

2685

# to the correctness of the data and will never affect any validation or

2686

# other non-formatting related operations.

2687

#

2688

# If this value is not known, it should be omitted (rather than specifying a

2689

# possibly incorrect default).

2690

#

2691

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

2692

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

2693

# addresses of a country or region.

2694

# For example, this can be a state, a province, an oblast, or a prefecture.

2695

# Specifically, for Spain this is the province and not the autonomous

2696

# community (e.g. "Barcelona" and not "Catalonia").

2697

# Many countries don't use an administrative area in postal addresses. E.g.

2698

# in Switzerland this should be left unpopulated.

2699

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

2700

# Examples: US city, IT comune, UK post town.

2701

# In regions of the world where localities are not well defined or do not fit

2702

# into this structure well, leave locality empty and use address_lines.

2703

"recipients": [ # Optional. The recipient at the address.

2704

# This field may, under certain circumstances, contain multiline information.

2705

# For example, it might contain "care of" information.

2706

"A String",

2707

],

2708

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

2709

# the latest revision.

2710

#

2711

# All new revisions **must** be backward compatible with old revisions.

2712

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

2713

# postal codes to be present, but where they are used, they may trigger

2714

# additional validation with other parts of the address (e.g. state/zip

2715

# validation in the U.S.A.).

2716

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

2717

# in most regions. Where it is used, the value is either a string like

2718

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

2719

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

2720

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

2721

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

2722

# is never inferred and it is up to the user to ensure the value is

2723

# correct. See http://cldr.unicode.org/ and

2724

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

2725

# for details. Example: "CH" for Switzerland.

2726

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

2727

#

2728

# Because values in address_lines do not have type information and may

2729

# sometimes contain multiple values in a single field (e.g.

2730

# "Austin, TX"), it is important that the line order is clear. The order of

2731

# address lines should be "envelope order" for the country/region of the

2732

# address. In places where this can vary (e.g. Japan), address_language is

2733

# used to make it explicit (e.g. "ja" for large-to-small ordering and

2734

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

2735

# an address can be selected based on the language.

2736

#

2737

# The minimum permitted structural representation of an address consists

2738

# of a region_code with all remaining information placed in the

2739

# address_lines. It would be possible to format such an address very

2740

# approximately without geocoding, but no semantic reasoning could be

2741

# made about any of the address components until it was at least

2742

# partially resolved.

2743

#

2744

# Creating an address only containing a region_code and address_lines, and

2745

# then geocoding is the recommended way to handle completely unstructured

2746

# addresses (as opposed to guessing which parts of the address should be

2747

# localities or administrative areas).

"A String",

],

},

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

2752

# location bounding box in which a circle with the specified radius

2753

# centered from LatLng covers the area associated with the job location.

2754

# For example, currently, "Mountain View, CA, USA" has a radius of

2755

# 6.17 miles.

2756

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

2757

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

2758

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

2759

# LocationType#LOCALITY.

2760

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

2761

# of doubles representing degrees latitude and degrees longitude. Unless

2762

# specified otherwise, this must conform to the

2763

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

2764

# standard</a>. Values must be within normalized ranges.

2765

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

2766

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

2771

"A String",

2772

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2773

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2774

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

2775

# is used for contracting engagements. Invalid timestamps are ignored.

2776

"visibility": "A String", # Deprecated. The job is only visible to the owner.

2777

#

2778

# The visibility of the job.

2779

#

2780

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

2781

"processingOptions": { # Input only. # Optional. Options for job processing.

2782

#

2783

# Options for job processing.

2784

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

2785

# more precise address for the job.

2786

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

2787

#

2788

# * description

2789

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

2795

# disabled.

2796

#

2797

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

2798

},

2799

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2800

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

2801

# any requirements for fluency that are associated with the job.

2802

#

2803

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

2804

# For more information, see

2805

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

2806

# class="external" target="_blank" }.

2807

#

2808

# If this field is unspecified and Job.description is present, detected

2809

# language code based on Job.description is assigned, otherwise

2810

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2811

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

2812

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

2813

# base compensation entry's CompensationEntry.compensation times

2814

# CompensationEntry.expected_units_per_year.

2815

#

2816

# See CompensationEntry for explanation on compensation annualization.

2817

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2818

# to a maximal compensation value and the currency code is set to

2819

# match the currency code of

2820

# min_compensation.

2821

"nanos": 42, # Number of nano (10^-9) units of the amount.

2822

# The value must be between -999,999,999 and +999,999,999 inclusive.

2823

# If `units` is positive, `nanos` must be positive or zero.

2824

# If `units` is zero, `nanos` can be positive, zero, or negative.

2825

# If `units` is negative, `nanos` must be negative or zero.

2826

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2827

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2828

"units": "A String", # The whole units of the amount.

2829

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2830

},

2831

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2832

# to zero and the currency code is set to match the

2833

# currency code of max_compensation.

2834

"nanos": 42, # Number of nano (10^-9) units of the amount.

2835

# The value must be between -999,999,999 and +999,999,999 inclusive.

2836

# If `units` is positive, `nanos` must be positive or zero.

2837

# If `units` is zero, `nanos` can be positive, zero, or negative.

2838

# If `units` is negative, `nanos` must be negative or zero.

2839

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2840

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2841

"units": "A String", # The whole units of the amount.

2842

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2843

},

2844

},

2845

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

2846

# all compensation entries' CompensationEntry.compensation times

2847

# CompensationEntry.expected_units_per_year.

2848

#

2849

# See CompensationEntry for explanation on compensation annualization.

2850

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2851

# to a maximal compensation value and the currency code is set to

2852

# match the currency code of

2853

# min_compensation.

2854

"nanos": 42, # Number of nano (10^-9) units of the amount.

2855

# The value must be between -999,999,999 and +999,999,999 inclusive.

2856

# If `units` is positive, `nanos` must be positive or zero.

2857

# If `units` is zero, `nanos` can be positive, zero, or negative.

2858

# If `units` is negative, `nanos` must be negative or zero.

2859

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2860

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2861

"units": "A String", # The whole units of the amount.

2862

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2863

},

2864

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2865

# to zero and the currency code is set to match the

2866

# currency code of max_compensation.

2867

"nanos": 42, # Number of nano (10^-9) units of the amount.

2868

# The value must be between -999,999,999 and +999,999,999 inclusive.

2869

# If `units` is positive, `nanos` must be positive or zero.

2870

# If `units` is zero, `nanos` can be positive, zero, or negative.

2871

# If `units` is negative, `nanos` must be negative or zero.

2872

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2873

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2874

"units": "A String", # The whole units of the amount.

2875

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2876

},

2877

},

2878

"entries": [ # Optional. Job compensation information.

2879

#

2880

# At most one entry can be of type

2881

# CompensationInfo.CompensationType.BASE, which is

2882

# referred as ** base compensation entry ** for the job.

2883

{ # A compensation entry that represents one component of compensation, such

2884

# as base pay, bonus, or other compensation type.

2885

#

2886

# Annualization: One compensation entry can be annualized if

2887

# - it contains valid amount or range.

2888

# - and its expected_units_per_year is set or can be derived.

2889

# Its annualized range is determined as (amount or range) times

2890

# expected_units_per_year.

2891

"unit": "A String", # Optional. Frequency of the specified amount.

2892

#

2893

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

2894

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

2895

# Job.employment_types is FULLTIME, a default value is inferred

2896

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

2903

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2904

# to a maximal compensation value and the currency code is set to

2905

# match the currency code of

2906

# min_compensation.

2907

"nanos": 42, # Number of nano (10^-9) units of the amount.

2908

# The value must be between -999,999,999 and +999,999,999 inclusive.

2909

# If `units` is positive, `nanos` must be positive or zero.

2910

# If `units` is zero, `nanos` can be positive, zero, or negative.

2911

# If `units` is negative, `nanos` must be negative or zero.

2912

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2913

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2914

"units": "A String", # The whole units of the amount.

2915

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2916

},

2917

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2918

# to zero and the currency code is set to match the

2919

# currency code of max_compensation.

2920

"nanos": 42, # Number of nano (10^-9) units of the amount.

2921

# The value must be between -999,999,999 and +999,999,999 inclusive.

2922

# If `units` is positive, `nanos` must be positive or zero.

2923

# If `units` is zero, `nanos` can be positive, zero, or negative.

2924

# If `units` is negative, `nanos` must be negative or zero.

2925

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2926

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2927

"units": "A String", # The whole units of the amount.

2928

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2929

},

2930

},

2931

"description": "A String", # Optional. Compensation description. For example, could

2932

# indicate equity terms or provide additional context to an estimated

2933

# bonus.

2934

"type": "A String", # Optional. Compensation type.

2935

#

2936

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

2937

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

2938

"nanos": 42, # Number of nano (10^-9) units of the amount.

2939

# The value must be between -999,999,999 and +999,999,999 inclusive.

2940

# If `units` is positive, `nanos` must be positive or zero.

2941

# If `units` is zero, `nanos` can be positive, zero, or negative.

2942

# If `units` is negative, `nanos` must be negative or zero.

2943

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2944

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2945

"units": "A String", # The whole units of the amount.

2946

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2952

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2953

# The resource name for the job. This is generated by the service when a

2954

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2955

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2956

# The format is "projects/{project_id}/jobs/{job_id}",

2957

# for example, "projects/api-test-project/jobs/1234".

2958

#

2959

# Use of this field in job queries and API calls is preferred over the use of

2960

# requisition_id since this value is unique.

2961

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

2962

# client to identify a job. This field is intended to be used by clients

2963

# for client identification and tracking of postings. A job is not allowed

2964

# to be created if there is another job with the same [company_name],

2965

# language_code and requisition_id.

2966

#

2967

# The maximum number of allowed characters is 255.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2968

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2969

"updateMask": "A String", # Optional but strongly recommended to be provided for the best service

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2970

# experience.

2971

#

2972

# If update_mask is provided, only the specified fields in

2973

# job are updated. Otherwise all the fields are updated.

2974

#

2975

# A field mask to restrict the fields that are updated. Only

2976

# top level fields of Job are supported.

2977

}

2978

2979

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2986

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2987

{ # A Job resource represents a job posting (also referred to as a "job listing"

2988

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2989

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2990

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2991

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2992

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2993

"instruction": "A String", # Optional but at least one of uris,

2994

# emails or instruction must be

2995

# specified.

2996

#

2997

# Use this field to provide instructions, such as "Mail your application

2998

# to ...", that a candidate can follow to apply for the job.

2999

#

3000

# This field accepts and sanitizes HTML input, and also accepts

3001

# bold, italic, ordered list, and unordered list markup tags.

3002

#

3003

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3004

"uris": [ # Optional but at least one of uris,

3005

# emails or instruction must be

3006

# specified.

3007

#

3008

# Use this URI field to direct an applicant to a website, for example to

3009

# link to an online application form.

3010

#

3011

# The maximum number of allowed characters for each entry is 2,000.

3012

"A String",

3013

],

3014

"emails": [ # Optional but at least one of uris,

3015

# emails or instruction must be

3016

# specified.

3017

#

3018

# Use this field to specify email address(es) to which resumes or

3019

# applications can be sent.

3020

#

3021

# The maximum number of allowed characters for each entry is 255.

3022

"A String",

3023

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3024

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3025

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

3026

# recommended as an alternative to using the more general description

3027

# field.

3028

#

3029

# This field accepts and sanitizes HTML input, and also accepts

3030

# bold, italic, ordered list, and unordered list markup tags.

3031

#

3032

# The maximum number of allowed characters is 10,000.

3033

"companyName": "A String", # Required. The resource name of the company listing the job, such as

3034

# "projects/api-test-project/companies/foo".

3035

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

3036

# The value determines the sort order of the jobs returned when searching for

3037

# jobs using the featured jobs search call, with higher promotional values

3038

# being returned first and ties being resolved by relevance sort. Only the

3039

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

3040

#

3041

# Default value is 0, and negative values are treated as 0.

3042

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

3043

"A String",

3044

],

3045

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

3046

# description of the company and related information. Separate fields are

3047

# provided on the job object for responsibilities,

3048

# qualifications, and other job characteristics. Use of

3049

# these separate job fields is recommended.

3050

#

3051

# This field accepts and sanitizes HTML input, and also accepts

3052

# bold, italic, ordered list, and unordered list markup tags.

3053

#

3054

# The maximum number of allowed characters is 100,000.

3055

"title": "A String", # Required. The title of the job, such as "Software Engineer"

3056

#

3057

# The maximum number of allowed characters is 500.

3058

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

3059

# value is the time the request arrives at the server. Invalid timestamps are

3060

# ignored.

3061

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

3062

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

3063

# incentives associated with the job not including salary or pay.

3064

#

3065

# The maximum number of allowed characters is 10,000.

3066

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

3067

# engagements. Invalid timestamps are ignored.

3068

"addresses": [ # Optional but strongly recommended for the best service experience.

3069

#

3070

# Location(s) where the employer is looking to hire for this job posting.

3071

#

3072

# Specifying the full street address(es) of the hiring location enables

3073

# better API results, especially job searches by commute time.

3074

#

3075

# At most 50 locations are allowed for best search performance. If a job has

3076

# more locations, it is suggested to split it into multiple jobs with unique

3077

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

3078

# multiple jobs with the same company_name, language_code and

3079

# requisition_id are not allowed. If the original requisition_id must

3080

# be preserved, a custom field should be used for storage. It is also

3081

# suggested to group the locations that close to each other in the same job

3082

# for better search experience.

3083

#

3084

# The maximum number of allowed characters is 500.

3085

"A String",

3086

],

3087

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

3088

"jobBenefits": [ # Optional. The benefits included with the job.

3089

"A String",

3090

],

3091

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

3092

# job. The use of this field is recommended

3093

# as an alternative to using the more general description field.

3094

#

3095

# This field accepts and sanitizes HTML input, and also accepts

3096

# bold, italic, ordered list, and unordered list markup tags.

3097

#

3098

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3099

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

3100

# the job is available. If this field is set, a

3101

# LocationFilter in a search query within the job region

3102

# finds this job posting if an exact location match isn't specified.

3103

# If this field is set to PostingRegion.NATION or

3104

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

3105

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3106

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

3107

# attributes that are not covered by the provided structured fields.

3108

#

3109

# The keys of the map are strings up to 64 bytes and must match the

3110

# pattern: a-zA-Z*. For example, key0LikeThis or

3111

# KEY_1_LIKE_THIS.

3112

#

3113

# At most 100 filterable and at most 100 unfilterable keys are supported.

3114

# For filterable `string_values`, across all keys at most 200 values are

3115

# allowed, with each string no more than 255 characters. For unfilterable

3116

# `string_values`, the maximum total size of `string_values` across all keys

3117

# is 50KB.

3118

"a_key": { # Custom attribute values that are either filterable or non-filterable.

3119

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

3120

# custom attribute filters JobQuery.custom_attribute_filter.

3121

# If false, these values may not be used for custom attribute filters.

3122

#

3123

# Default is false.

3124

"stringValues": [ # Optional but exactly one of string_values or long_values must

3125

# be specified.

3126

#

3127

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

3128

# `CASE_INSENSITIVE_MATCH`) search.

3129

# For filterable `string_value`s, a maximum total number of 200 values

3130

# is allowed, with each `string_value` has a byte size of no more than

3131

# 500B. For unfilterable `string_values`, the maximum total byte size of

3132

# unfilterable `string_values` is 50KB.

3133

#

3134

# Empty string is not allowed.

3135

"A String",

3136

],

3137

"longValues": [ # Optional but exactly one of string_values or long_values must

3138

# be specified.

3139

#

3140

# This field is used to perform number range search.

3141

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

3142

#

3143

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

3149

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3154

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

3155

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3156

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3157

# The expiration timestamp of the job. After this timestamp, the

3158

# job is marked as expired, and it no longer appears in search results. The

3159

# expired job can't be deleted or listed by the DeleteJob and

3160

# ListJobs APIs, but it can be retrieved with the GetJob API or

3161

# updated with the UpdateJob API. An expired job can be updated and

3162

# opened again by using a future expiration timestamp. Updating an expired

3163

# job fails if there is another existing open job with same company_name,

3164

# language_code and requisition_id.

3165

#

3166

# The expired jobs are retained in our system for 90 days. However, the

3167

# overall expired job count cannot exceed 3 times the maximum of open jobs

3168

# count over the past week, otherwise jobs with earlier expire time are

3169

# cleaned first. Expired jobs are no longer accessible after they are cleaned

3170

# out.

3171

#

3172

# Invalid timestamps are ignored, and treated as expire time not provided.

3173

#

3174

# Timestamp before the instant request is made is considered valid, the job

3175

# will be treated as expired immediately.

3176

#

3177

# If this value is not provided at the time of job creation or is invalid,

3178

# the job posting expires after 30 days from the job's creation time. For

3179

# example, if the job was created on 2017/01/01 13:00AM UTC with an

3180

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

3181

#

3182

# If this value is not provided on job update, it depends on the field masks

3183

# set by UpdateJobRequest.update_mask. If the field masks include

3184

# expiry_time, or the masks are empty meaning that every field is

3185

# updated, the job posting expires after 30 days from the job's last

3186

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3187

"department": "A String", # Optional. The department or functional area within the company with the open

3188

# position.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3189

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3190

# The maximum number of allowed characters is 255.

3191

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3192

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3193

# Derived details about the job posting.

3194

"locations": [ # Structured locations of the job, resolved from Job.addresses.

3195

#

3196

# locations are exactly matched to Job.addresses in the same

3197

# order.

3198

{ # Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3199

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3200

# A resource that represents a location with full geographic information.

3201

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

3202

# such as postal delivery and payments addresses. Given a postal address,

3203

# a postal service can deliver items to a premises, P.O. Box, or other

3204

# delivery location.

3205

# Given a postal address, a postal service can deliver items to a premise, P.O.

3206

# Box or similar.

3207

# It is not intended to model geographical locations (roads, towns,

3208

# mountains).

3209

#

3210

# In typical usage an address would be created via user input or from importing

3211

# existing data, depending on the type of process.

3212

#

3213

# Advice on address input / editing:

3214

# - Use an i18n-ready address widget such as

3215

# https://github.com/google/libaddressinput)

3216

# - Users should not be presented with UI elements for input or editing of

3217

# fields outside countries where that field is used.

3218

#

3219

# For more guidance on how to use this schema, please see:

3220

# https://support.google.com/business/answer/6397478

3221

"organization": "A String", # Optional. The name of the organization at the address.

3222

"sublocality": "A String", # Optional. Sublocality of the address.

3223

# For example, this can be neighborhoods, boroughs, districts.

3224

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

3225

# known). This is often the UI language of the input form or is expected

3226

# to match one of the languages used in the address' country/region, or their

3227

# transliterated equivalents.

3228

# This can affect formatting in certain countries, but is not critical

3229

# to the correctness of the data and will never affect any validation or

3230

# other non-formatting related operations.

3231

#

3232

# If this value is not known, it should be omitted (rather than specifying a

3233

# possibly incorrect default).

3234

#

3235

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

3236

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

3237

# addresses of a country or region.

3238

# For example, this can be a state, a province, an oblast, or a prefecture.

3239

# Specifically, for Spain this is the province and not the autonomous

3240

# community (e.g. "Barcelona" and not "Catalonia").

3241

# Many countries don't use an administrative area in postal addresses. E.g.

3242

# in Switzerland this should be left unpopulated.

3243

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

3244

# Examples: US city, IT comune, UK post town.

3245

# In regions of the world where localities are not well defined or do not fit

3246

# into this structure well, leave locality empty and use address_lines.

3247

"recipients": [ # Optional. The recipient at the address.

3248

# This field may, under certain circumstances, contain multiline information.

3249

# For example, it might contain "care of" information.

3250

"A String",

3251

],

3252

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

3253

# the latest revision.

3254

#

3255

# All new revisions **must** be backward compatible with old revisions.

3256

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

3257

# postal codes to be present, but where they are used, they may trigger

3258

# additional validation with other parts of the address (e.g. state/zip

3259

# validation in the U.S.A.).

3260

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

3261

# in most regions. Where it is used, the value is either a string like

3262

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

3263

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

3264

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

3265

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

3266

# is never inferred and it is up to the user to ensure the value is

3267

# correct. See http://cldr.unicode.org/ and

3268

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3269

# for details. Example: "CH" for Switzerland.

3270

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

3271

#

3272

# Because values in address_lines do not have type information and may

3273

# sometimes contain multiple values in a single field (e.g.

3274

# "Austin, TX"), it is important that the line order is clear. The order of

3275

# address lines should be "envelope order" for the country/region of the

3276

# address. In places where this can vary (e.g. Japan), address_language is

3277

# used to make it explicit (e.g. "ja" for large-to-small ordering and

3278

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

3279

# an address can be selected based on the language.

3280

#

3281

# The minimum permitted structural representation of an address consists

3282

# of a region_code with all remaining information placed in the

3283

# address_lines. It would be possible to format such an address very

3284

# approximately without geocoding, but no semantic reasoning could be

3285

# made about any of the address components until it was at least

3286

# partially resolved.

3287

#

3288

# Creating an address only containing a region_code and address_lines, and

3289

# then geocoding is the recommended way to handle completely unstructured

3290

# addresses (as opposed to guessing which parts of the address should be

3291

# localities or administrative areas).

"A String",

],

},

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

3300

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

3301

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

3302

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

3303

# LocationType#LOCALITY.

3304

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

3305

# of doubles representing degrees latitude and degrees longitude. Unless

3306

# specified otherwise, this must conform to the

3307

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3308

# standard</a>. Values must be within normalized ranges.

3309

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3310

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

3315

"A String",

3316

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3317

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3318

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

3319

# is used for contracting engagements. Invalid timestamps are ignored.

3320

"visibility": "A String", # Deprecated. The job is only visible to the owner.

3321

#

3322

# The visibility of the job.

3323

#

3324

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

3325

"processingOptions": { # Input only. # Optional. Options for job processing.

3326

#

3327

# Options for job processing.

3328

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

3329

# more precise address for the job.

3330

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

3331

#

3332

# * description

3333

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

3339

# disabled.

3340

#

3341

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

3342

},

3343

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3344

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

3345

# any requirements for fluency that are associated with the job.

3346

#

3347

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

3348

# For more information, see

3349

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

3350

# class="external" target="_blank" }.

3351

#

3352

# If this field is unspecified and Job.description is present, detected

3353

# language code based on Job.description is assigned, otherwise

3354

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3355

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

3356

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

3357

# base compensation entry's CompensationEntry.compensation times

3358

# CompensationEntry.expected_units_per_year.

3359

#

3360

# See CompensationEntry for explanation on compensation annualization.

3361

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3362

# to a maximal compensation value and the currency code is set to

3363

# match the currency code of

3364

# min_compensation.

3365

"nanos": 42, # Number of nano (10^-9) units of the amount.

3366

# The value must be between -999,999,999 and +999,999,999 inclusive.

3367

# If `units` is positive, `nanos` must be positive or zero.

3368

# If `units` is zero, `nanos` can be positive, zero, or negative.

3369

# If `units` is negative, `nanos` must be negative or zero.

3370

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3371

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3372

"units": "A String", # The whole units of the amount.

3373

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3374

},

3375

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3376

# to zero and the currency code is set to match the

3377

# currency code of max_compensation.

3378

"nanos": 42, # Number of nano (10^-9) units of the amount.

3379

# The value must be between -999,999,999 and +999,999,999 inclusive.

3380

# If `units` is positive, `nanos` must be positive or zero.

3381

# If `units` is zero, `nanos` can be positive, zero, or negative.

3382

# If `units` is negative, `nanos` must be negative or zero.

3383

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3384

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3385

"units": "A String", # The whole units of the amount.

3386

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3387

},

3388

},

3389

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

3390

# all compensation entries' CompensationEntry.compensation times

3391

# CompensationEntry.expected_units_per_year.

3392

#

3393

# See CompensationEntry for explanation on compensation annualization.

3394

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3395

# to a maximal compensation value and the currency code is set to

3396

# match the currency code of

3397

# min_compensation.

3398

"nanos": 42, # Number of nano (10^-9) units of the amount.

3399

# The value must be between -999,999,999 and +999,999,999 inclusive.

3400

# If `units` is positive, `nanos` must be positive or zero.

3401

# If `units` is zero, `nanos` can be positive, zero, or negative.

3402

# If `units` is negative, `nanos` must be negative or zero.

3403

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3404

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3405

"units": "A String", # The whole units of the amount.

3406

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3407

},

3408

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3409

# to zero and the currency code is set to match the

3410

# currency code of max_compensation.

3411

"nanos": 42, # Number of nano (10^-9) units of the amount.

3412

# The value must be between -999,999,999 and +999,999,999 inclusive.

3413

# If `units` is positive, `nanos` must be positive or zero.

3414

# If `units` is zero, `nanos` can be positive, zero, or negative.

3415

# If `units` is negative, `nanos` must be negative or zero.

3416

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3417

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3418

"units": "A String", # The whole units of the amount.

3419

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3420

},

3421

},

3422

"entries": [ # Optional. Job compensation information.

3423

#

3424

# At most one entry can be of type

3425

# CompensationInfo.CompensationType.BASE, which is

3426

# referred as ** base compensation entry ** for the job.

3427

{ # A compensation entry that represents one component of compensation, such

3428

# as base pay, bonus, or other compensation type.

3429

#

3430

# Annualization: One compensation entry can be annualized if

3431

# - it contains valid amount or range.

3432

# - and its expected_units_per_year is set or can be derived.

3433

# Its annualized range is determined as (amount or range) times

3434

# expected_units_per_year.

3435

"unit": "A String", # Optional. Frequency of the specified amount.

3436

#

3437

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

3438

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

3439

# Job.employment_types is FULLTIME, a default value is inferred

3440

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

3447

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3448

# to a maximal compensation value and the currency code is set to

3449

# match the currency code of

3450

# min_compensation.

3451

"nanos": 42, # Number of nano (10^-9) units of the amount.

3452

# The value must be between -999,999,999 and +999,999,999 inclusive.

3453

# If `units` is positive, `nanos` must be positive or zero.

3454

# If `units` is zero, `nanos` can be positive, zero, or negative.

3455

# If `units` is negative, `nanos` must be negative or zero.

3456

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3457

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3458

"units": "A String", # The whole units of the amount.

3459

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3460

},

3461

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3462

# to zero and the currency code is set to match the

3463

# currency code of max_compensation.

3464

"nanos": 42, # Number of nano (10^-9) units of the amount.

3465

# The value must be between -999,999,999 and +999,999,999 inclusive.

3466

# If `units` is positive, `nanos` must be positive or zero.

3467

# If `units` is zero, `nanos` can be positive, zero, or negative.

3468

# If `units` is negative, `nanos` must be negative or zero.

3469

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3470

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3471

"units": "A String", # The whole units of the amount.

3472

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3473

},

3474

},

3475

"description": "A String", # Optional. Compensation description. For example, could

3476

# indicate equity terms or provide additional context to an estimated

3477

# bonus.

3478

"type": "A String", # Optional. Compensation type.

3479

#

3480

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

3481

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

3482

"nanos": 42, # Number of nano (10^-9) units of the amount.

3483

# The value must be between -999,999,999 and +999,999,999 inclusive.

3484

# If `units` is positive, `nanos` must be positive or zero.

3485

# If `units` is zero, `nanos` can be positive, zero, or negative.

3486

# If `units` is negative, `nanos` must be negative or zero.

3487

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3488

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3489

"units": "A String", # The whole units of the amount.

3490

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3496

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3497

# The resource name for the job. This is generated by the service when a

3498

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3499

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3500

# The format is "projects/{project_id}/jobs/{job_id}",

3501

# for example, "projects/api-test-project/jobs/1234".

3502

#

3503

# Use of this field in job queries and API calls is preferred over the use of

3504

# requisition_id since this value is unique.

3505

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

3506

# client to identify a job. This field is intended to be used by clients

3507

# for client identification and tracking of postings. A job is not allowed

3508

# to be created if there is another job with the same [company_name],

3509

# language_code and requisition_id.

3510

#

3511

# The maximum number of allowed characters is 255.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3516

<code class="details" id="search">search(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3517

<pre>Searches for jobs using the provided SearchJobsRequest.

3518

3519

This call constrains the visibility of jobs

3520

present in the database, and only returns jobs that the caller has

3521

permission to search against.

3522

3523

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3524

parent: string, Required. The resource name of the project to search within.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3525

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3526

The format is "projects/{project_id}", for example,

3527

"projects/api-test-project". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3528

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3529

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3534

"requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the

3535

# search quality of the service. The identifiers (such as `user_id`) are

3536

# provided by users, and must be unique and consistent.

3537

#

3538

# Meta information related to the job searcher or entity

3539

# conducting the job search. This information is used to improve the

3540

# performance of the service.

3541

"userId": "A String", # Required. A unique user identification string, as determined by the client.

3542

# To have the strongest positive impact on search quality

3543

# make sure the client-level is unique.

3544

# Obfuscate this field for privacy concerns before

3545

# providing it to the service.

3546

#

3547

# If this field is not available for some reason, send "UNKNOWN". Note

3548

# that any improvements to the model for a particular tenant

3549

# site, rely on this field being set correctly to a unique user_id.

3550

#

3551

# The maximum number of allowed characters is 255.

3552

"sessionId": "A String", # Required. A unique session identification string. A session is defined as the

3553

# duration of an end user's interaction with the service over a certain

3554

# period.

3555

# Obfuscate this field for privacy concerns before

3556

# providing it to the service.

3557

#

3558

# If this field is not available for some reason, send "UNKNOWN". Note

3559

# that any improvements to the model for a particular tenant

3560

# site, rely on this field being set correctly to some unique session_id.

3561

#

3562

# The maximum number of allowed characters is 255.

3563

"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

3564

# service.

3565

# other entity conducting the job search. Providing this information improves

3566

# the quality of the search results across devices.

3567

"id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that

3568

# distinguishes the device from other devices.

3569

"deviceType": "A String", # Optional. Type of the device.

3570

},

3571

"domain": "A String", # Required. The client-defined scope or source of the service call, which typically

3572

# is the domain on

3573

# which the service has been implemented and is currently being run.

3574

#

3575

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

3576

# job board www.foo.com and career site www.bar.com, then this field is

3577

# set to "foo.com" for use on the job board, and "bar.com" for use on the

3578

# career site.

3579

#

3580

# If this field isn't available for some reason, send "UNKNOWN".

3581

# Any improvements to the model for a particular tenant site rely on this

3582

# field being set correctly to a domain.

3583

#

3584

# The maximum number of allowed characters is 255.

3585

},

3586

"offset": 42, # Optional. An integer that specifies the current offset (that is, starting result

3587

# location, amongst the jobs deemed by the API as relevant) in search

3588

# results. This field is only considered if page_token is unset.

3589

#

3590

# The maximum allowed value is 5000. Otherwise an error is thrown.

3591

#

3592

# For example, 0 means to return results starting from the first matching

3593

# job, and 10 means to return from the 11th job. This can be used for

3594

# pagination, (for example, pageSize = 10 and offset = 10 means to return

3595

# from the second page).

3596

"histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.

3597

#

3598

# Histogram facets to be specified in SearchJobsRequest.

3599

"customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.

3600

# Duplicate values of CustomAttributeHistogramRequest.key are not

3601

# allowed.

3602

{ # Custom attributes histogram request. An error is thrown if neither

3603

# string_value_histogram or long_value_histogram_bucketing_option has

3604

# been defined.

3605

"longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's

3606

# filterable long custom field values, or min/max value requirements.

3607

#

3608

# Use this field to specify bucketing option for the histogram search response.

3609

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

3610

# value of the numeric field.

3611

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

3612

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

3613

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

3614

# [buckets_bound is supported.

3.14,

],

},

"stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for

3619

# each key as a string.

3620

"key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified

3621

# without `long_value_histogram_bucketing_option`, histogram on string values

3622

# of the given `key` is triggered, otherwise histogram is performed on long

# values.

},

],

"simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,

3627

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.

3628

"A String",

3629

],

3630

"compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.

3631

# Duplicate values of CompensationHistogramRequest.type are not allowed.

3632

{ # Input only.

3633

#

3634

# Compensation based histogram request.

3635

"type": "A String", # Required. Type of the request, representing which field the histogramming should be

3636

# performed over. A single request can only specify one histogram of each

3637

# `CompensationHistogramRequestType`.

3638

"bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.

3639

#

3640

# Use this field to specify bucketing option for the histogram search response.

3641

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

3642

# value of the numeric field.

3643

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

3644

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

3645

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

3646

# [buckets_bound is supported.

3.14,

],

},

},

],

},

"requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise

3654

# count of the first 300 results. Setting this to `true` ensures

3655

# consistency in the number of results per page. Best practice is to set this

3656

# value to true if a client allows users to jump directly to a

3657

# non-sequential search results page.

3658

#

3659

# Enabling this flag may adversely impact performance.

3660

#

3661

# Defaults to false.

3662

"searchMode": "A String", # Optional. Mode of a search.

3663

#

3664

# Defaults to SearchMode.JOB_SEARCH.

3665

"pageToken": "A String", # Optional. The token specifying the current offset within

3666

# search results. See SearchJobsResponse.next_page_token for

3667

# an explanation of how to obtain the next set of query results.

3668

"pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.

3669

# Increasing this value above the default value of 10 can increase search

3670

# response time. The value can be between 1 and 100.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3671

"disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,

3672

# Job.description, Job.company_display_name, Job.locations,

3673

# Job.qualifications. When disable keyword match is turned off, a

3674

# keyword match returns jobs that do not match given category filters when

3675

# there are matching keywords. For example, the query "program manager," a

3676

# result is returned even if the job posting has the title "software

3677

# developer," which does not fall into "program manager" ontology, but does

3678

# have "program manager" appearing in its description.

3679

#

3680

# For queries like "cloud" that does not contain title or

3681

# location specific ontology, jobs with "cloud" keyword matches are returned

3682

# regardless of this flag's value.

3683

#

3684

# Please use Company.keyword_searchable_custom_fields or

3685

# Company.keyword_searchable_custom_attributes if company specific

3686

# globally matched custom field/attribute string values is needed. Enabling

3687

# keyword match improves recall of subsequent search requests.

3688

#

3689

# Defaults to false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3690

"jobView": "A String", # Optional. The desired job attributes returned for jobs in the

3691

# search response. Defaults to JobView.SMALL if no value is specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3692

"enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.

3693

# Broadened queries append results to the end of the matching results

3694

# list.

3695

#

3696

# Defaults to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3697

"jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3698

#

3699

# The query required to perform a search query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3700

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for

3701

# example, driving or public transit). Note: This only works with COMMUTE

3702

# MODE. When specified, [JobQuery.location_filters] is

3703

# ignored.

3704

#

3705

# Currently we don't support sorting by commute time.

3706

#

3707

# Parameters needed for commute search.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3708

"commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3709

"travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

3710

# (one hour). Format is `123s`.

3711

"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

3712

# commute time.

3713

# of doubles representing degrees latitude and degrees longitude. Unless

3714

# specified otherwise, this must conform to the

3715

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3716

# standard</a>. Values must be within normalized ranges.

3717

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3718

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3719

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3720

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3721

"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

3722

# google.type.TimeOfDay in local time zone.

3723

#

3724

# Currently traffic model is restricted to hour level resolution.

3725

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3726

# types are google.type.Date and `google.protobuf.Timestamp`.

3727

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3728

# allow the value 60 if it allows leap-seconds.

3729

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3730

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3731

# to allow the value "24:00:00" for scenarios like business closing time.

3732

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3733

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3734

"allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS

3735

# coordinates) might also be returned. For city and coarser level addresses,

3736

# text matching is used. If this field is set to false or is not specified,

3737

# only jobs that include precise addresses are returned by Commute

3738

# Search.

3739

#

3740

# Note: If `allow_imprecise_addresses` is set to true, Commute Search is not

3741

# able to calculate accurate commute times to jobs with city level and

3742

# coarser address information. Jobs with imprecise addresses will return a

3743

# `travel_duration` time of 0 regardless of distance from the job seeker.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3744

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3745

"jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.

3746

# See Category for more information.

3747

#

3748

# If a value is not specified, jobs from any category are searched against.

3749

#

3750

# If multiple values are specified, jobs from any of the specified

3751

# categories are searched against.

3752

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3753

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3754

"companyNames": [ # Optional. This filter specifies the company entities to search against.

3755

#

3756

# If a value isn't specified, jobs are searched for against all

3757

# companies.

3758

#

3759

# If multiple values are specified, jobs are searched against the

3760

# companies specified.

3761

#

3762

# The format is "projects/{project_id}/companies/{company_id}", for example,

3763

# "projects/api-test-project/companies/foo".

3764

#

3765

# At most 20 company filters are allowed.

3766

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3767

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3768

"queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to

3769

# better interpret the query.

3770

#

3771

# If a value isn't specified, the query language code is automatically

3772

# detected, which may not be accurate.

3773

#

3774

# Language code should be in BCP-47 format, such as "en-US" or "sr-Latn".

3775

# For more information, see

3776

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3777

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

3778

# Job.custom_attributes marked as `filterable`.

3779

#

3780

# The syntax for this expression is a subset of SQL syntax.

3781

#

3782

# Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the

3783

# left of the operator is a custom field key and the right of the operator

3784

# is a number or a quoted string. You must escape backslash (\\) and

3785

# quote (\") characters.

3786

#

3787

# Supported functions are `LOWER([field_name])` to

3788

# perform a case insensitive match and `EMPTY([field_name])` to filter on the

3789

# existence of a key.

3790

#

3791

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

3792

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100

3793

# comparisons or functions are allowed in the expression. The expression

3794

# must be < 6000 bytes in length.

3795

#

3796

# Sample Query:

3797

# `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND

3798

# driving_years > 10`

3799

"publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched

3800

# against.

3801

"endTime": "A String", # End of the period.

3802

"startTime": "A String", # Begin of the period.

3803

},

3804

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

3805

# for example, "en-US".

3806

#

3807

# If a value isn't specified, the search results can contain jobs in any

# locale.

#

#

# Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".

3812

# For more information, see

3813

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

3814

#

3815

# At most 10 language code filters are allowed.

3816

"A String",

3817

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3818

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

3819

# search against, such as EmploymentType.FULL_TIME.

3820

#

3821

# If a value is not specified, jobs in the search results includes any

3822

# employment type.

3823

#

3824

# If multiple values are specified, jobs in the search results include

3825

# any of the specified employment types.

3826

"A String",

3827

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3828

"query": "A String", # Optional. The query string that matches against the job title, description, and

3829

# location fields.

3830

#

3831

# The maximum number of allowed characters is 255.

3832

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

3833

# service attempts to correct a misspelled query,

3834

# for example, "enginee" is corrected to "engineer".

3835

#

3836

# Defaults to false: a spell check is performed.

3837

"companyDisplayNames": [ # Optional. This filter specifies the exact company display

3838

# name of the jobs to search against.

3839

#

3840

# If a value isn't specified, jobs within the search results are

3841

# associated with any company.

3842

#

3843

# If multiple values are specified, jobs within the search results may be

3844

# associated with any of the specified companies.

3845

#

3846

# At most 20 company display name filters are allowed.

3847

"A String",

3848

],

3849

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

3850

# search against. See LocationFilter for more information.

3851

#

3852

# If a location value isn't specified, jobs fitting the other search

3853

# criteria are retrieved regardless of where they're located.

3854

#

3855

# If multiple values are specified, jobs are retrieved from any of the

3856

# specified locations. If different values are specified for the

3857

# LocationFilter.distance_in_miles parameter, the maximum provided

3858

# distance is used for all locations.

3859

#

3860

# At most 5 location filters are allowed.

3861

{ # Input only.

3862

#

3863

# Geographic region of the search.

3864

"telecommutePreference": "A String", # Optional. Allows the client to return jobs without a

3865

# set location, specifically, telecommuting jobs (telecommuting is considered

3866

# by the service as a special location.

3867

# Job.posting_region indicates if a job permits telecommuting.

3868

# If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,

3869

# telecommuting jobs are searched, and address and lat_lng are

3870

# ignored. If not set or set to

3871

# TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not

3872

# searched.

3873

#

3874

# This filter can be used by itself to search exclusively for telecommuting

3875

# jobs, or it can be combined with another location

3876

# filter to search for a combination of job locations,

3877

# such as "Mountain View" or "telecommuting" jobs. However, when used in

3878

# combination with other location filters, telecommuting jobs can be

3879

# treated as less relevant than other jobs in the search response.

3880

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

3881

# identified as a city or smaller. When the location being searched for is a

3882

# state or larger, this field is ignored.

3883

"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

3884

# search. This field's ignored if `address` is provided.

3885

# of doubles representing degrees latitude and degrees longitude. Unless

3886

# specified otherwise, this must conform to the

3887

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3888

# standard</a>. Values must be within normalized ranges.

3889

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3890

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3891

},

3892

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used

3893

# to address ambiguity of the user-input location, for example, "Liverpool"

3894

# against "Liverpool, NY, US" or "Liverpool, UK".

3895

#

3896

# Set this field if all the jobs to search against are from a same region,

3897

# or jobs are world-wide, but the job seeker is from a specific region.

3898

#

3899

# See http://cldr.unicode.org/ and

3900

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3901

# for details. Example: "CH" for Switzerland.

3902

"address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

3903

},

3904

],

3905

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

3906

# Job.compensation_info. For example, if the filter is specified

3907

# as "Hourly job with per-hour compensation > $15", only jobs meeting

3908

# these criteria are searched. If a filter isn't defined, all open jobs

3909

# are searched.

3910

#

3911

# Filter on job compensation type and amount.

3912

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are

3913

# included.

3914

"type": "A String", # Required. Type of filter.

3915

"units": [ # Required. Specify desired `base compensation entry's`

3916

# CompensationInfo.CompensationUnit.

3917

"A String",

3918

],

3919

"range": { # Compensation range. # Optional. Compensation range.

3920

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3921

# to a maximal compensation value and the currency code is set to

3922

# match the currency code of

3923

# min_compensation.

3924

"nanos": 42, # Number of nano (10^-9) units of the amount.

3925

# The value must be between -999,999,999 and +999,999,999 inclusive.

3926

# If `units` is positive, `nanos` must be positive or zero.

3927

# If `units` is zero, `nanos` can be positive, zero, or negative.

3928

# If `units` is negative, `nanos` must be negative or zero.

3929

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3930

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3931

"units": "A String", # The whole units of the amount.

3932

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3933

},

3934

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3935

# to zero and the currency code is set to match the

3936

# currency code of max_compensation.

3937

"nanos": 42, # Number of nano (10^-9) units of the amount.

3938

# The value must be between -999,999,999 and +999,999,999 inclusive.

3939

# If `units` is positive, `nanos` must be positive or zero.

3940

# If `units` is zero, `nanos` can be positive, zero, or negative.

3941

# If `units` is negative, `nanos` must be negative or zero.

3942

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3943

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3944

"units": "A String", # The whole units of the amount.

3945

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3946

},

3947

},

3948

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3949

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3950

"orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is

3951

# "relevance desc".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3952

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3953

# Supported options are:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3954

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3955

# * `"relevance desc"`: By relevance descending, as determined by the API

3956

# algorithms. Relevance thresholding of query results is only available

3957

# with this ordering.

3958

# * `"posting_publish_time desc"`: By Job.posting_publish_time

3959

# descending.

3960

# * `"posting_update_time desc"`: By Job.posting_update_time

3961

# descending.

3962

# * `"title"`: By Job.title ascending.

3963

# * `"title desc"`: By Job.title descending.

3964

# * `"annualized_base_compensation"`: By job's

3965

# CompensationInfo.annualized_base_compensation_range ascending. Jobs

3966

# whose annualized base compensation is unspecified are put at the end of

3967

# search results.

3968

# * `"annualized_base_compensation desc"`: By job's

3969

# CompensationInfo.annualized_base_compensation_range descending. Jobs

3970

# whose annualized base compensation is unspecified are put at the end of

3971

# search results.

3972

# * `"annualized_total_compensation"`: By job's

3973

# CompensationInfo.annualized_total_compensation_range ascending. Jobs

3974

# whose annualized base compensation is unspecified are put at the end of

3975

# search results.

3976

# * `"annualized_total_compensation desc"`: By job's

3977

# CompensationInfo.annualized_total_compensation_range descending. Jobs

3978

# whose annualized base compensation is unspecified are put at the end of

3979

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3980

"diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in

3981

# the search results. Jobs are identified as highly similar based on

3982

# their titles, job categories, and locations. Highly similar results are

3983

# clustered so that only one representative job of the cluster is

3984

# displayed to the job seeker higher up in the results, with the other jobs

3985

# being displayed lower down in the results.

3986

#

3987

# Defaults to DiversificationLevel.SIMPLE if no value

3988

# is specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3989

}

3990

3991

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# Response for SearchJob method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4002

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

4003

{ # Output only.

4004

#

4005

# Job entry with metadata inside SearchJobsResponse.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4006

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

4007

# fields that most closely match a search query's keywords, if available.

4008

# All HTML tags in the original fields are stripped when returned in this

4009

# field, and matching query keywords are enclosed in HTML bold tags.

4010

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

4011

# results listing page.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4012

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

4013

# or "job requisition"). A job belongs to a Company, which is the hiring

4014

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4015

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

4016

#

4017

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4018

"instruction": "A String", # Optional but at least one of uris,

4019

# emails or instruction must be

4020

# specified.

4021

#

4022

# Use this field to provide instructions, such as "Mail your application

4023

# to ...", that a candidate can follow to apply for the job.

4024

#

4025

# This field accepts and sanitizes HTML input, and also accepts

4026

# bold, italic, ordered list, and unordered list markup tags.

4027

#

4028

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4029

"uris": [ # Optional but at least one of uris,

4030

# emails or instruction must be

4031

# specified.

4032

#

4033

# Use this URI field to direct an applicant to a website, for example to

4034

# link to an online application form.

4035

#

4036

# The maximum number of allowed characters for each entry is 2,000.

4037

"A String",

4038

],

4039

"emails": [ # Optional but at least one of uris,

4040

# emails or instruction must be

4041

# specified.

4042

#

4043

# Use this field to specify email address(es) to which resumes or

4044

# applications can be sent.

4045

#

4046

# The maximum number of allowed characters for each entry is 255.

4047

"A String",

4048

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4049

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4050

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

4051

# recommended as an alternative to using the more general description

4052

# field.

4053

#

4054

# This field accepts and sanitizes HTML input, and also accepts

4055

# bold, italic, ordered list, and unordered list markup tags.

4056

#

4057

# The maximum number of allowed characters is 10,000.

4058

"companyName": "A String", # Required. The resource name of the company listing the job, such as

4059

# "projects/api-test-project/companies/foo".

4060

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

4061

# The value determines the sort order of the jobs returned when searching for

4062

# jobs using the featured jobs search call, with higher promotional values

4063

# being returned first and ties being resolved by relevance sort. Only the

4064

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

4065

#

4066

# Default value is 0, and negative values are treated as 0.

4067

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

4068

"A String",

4069

],

4070

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

4071

# description of the company and related information. Separate fields are

4072

# provided on the job object for responsibilities,

4073

# qualifications, and other job characteristics. Use of

4074

# these separate job fields is recommended.

4075

#

4076

# This field accepts and sanitizes HTML input, and also accepts

4077

# bold, italic, ordered list, and unordered list markup tags.

4078

#

4079

# The maximum number of allowed characters is 100,000.

4080

"title": "A String", # Required. The title of the job, such as "Software Engineer"

4081

#

4082

# The maximum number of allowed characters is 500.

4083

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

4084

# value is the time the request arrives at the server. Invalid timestamps are

4085

# ignored.

4086

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

4087

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

4088

# incentives associated with the job not including salary or pay.

4089

#

4090

# The maximum number of allowed characters is 10,000.

4091

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

4092

# engagements. Invalid timestamps are ignored.

4093

"addresses": [ # Optional but strongly recommended for the best service experience.

4094

#

4095

# Location(s) where the employer is looking to hire for this job posting.

4096

#

4097

# Specifying the full street address(es) of the hiring location enables

4098

# better API results, especially job searches by commute time.

4099

#

4100

# At most 50 locations are allowed for best search performance. If a job has

4101

# more locations, it is suggested to split it into multiple jobs with unique

4102

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

4103

# multiple jobs with the same company_name, language_code and

4104

# requisition_id are not allowed. If the original requisition_id must

4105

# be preserved, a custom field should be used for storage. It is also

4106

# suggested to group the locations that close to each other in the same job

4107

# for better search experience.

4108

#

4109

# The maximum number of allowed characters is 500.

4110

"A String",

4111

],

4112

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

4113

"jobBenefits": [ # Optional. The benefits included with the job.

4114

"A String",

4115

],

4116

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

4117

# job. The use of this field is recommended

4118

# as an alternative to using the more general description field.

4119

#

4120

# This field accepts and sanitizes HTML input, and also accepts

4121

# bold, italic, ordered list, and unordered list markup tags.

4122

#

4123

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4124

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

4125

# the job is available. If this field is set, a

4126

# LocationFilter in a search query within the job region

4127

# finds this job posting if an exact location match isn't specified.

4128

# If this field is set to PostingRegion.NATION or

4129

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

4130

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4131

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

4132

# attributes that are not covered by the provided structured fields.

4133

#

4134

# The keys of the map are strings up to 64 bytes and must match the

4135

# pattern: a-zA-Z*. For example, key0LikeThis or

4136

# KEY_1_LIKE_THIS.

4137

#

4138

# At most 100 filterable and at most 100 unfilterable keys are supported.

4139

# For filterable `string_values`, across all keys at most 200 values are

4140

# allowed, with each string no more than 255 characters. For unfilterable

4141

# `string_values`, the maximum total size of `string_values` across all keys

4142

# is 50KB.

4143

"a_key": { # Custom attribute values that are either filterable or non-filterable.

4144

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

4145

# custom attribute filters JobQuery.custom_attribute_filter.

4146

# If false, these values may not be used for custom attribute filters.

4147

#

4148

# Default is false.

4149

"stringValues": [ # Optional but exactly one of string_values or long_values must

4150

# be specified.

4151

#

4152

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

4153

# `CASE_INSENSITIVE_MATCH`) search.

4154

# For filterable `string_value`s, a maximum total number of 200 values

4155

# is allowed, with each `string_value` has a byte size of no more than

4156

# 500B. For unfilterable `string_values`, the maximum total byte size of

4157

# unfilterable `string_values` is 50KB.

4158

#

4159

# Empty string is not allowed.

4160

"A String",

4161

],

4162

"longValues": [ # Optional but exactly one of string_values or long_values must

4163

# be specified.

4164

#

4165

# This field is used to perform number range search.

4166

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

4167

#

4168

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

4174

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4179

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

4180

# experience.

4181

#

4182

# The expiration timestamp of the job. After this timestamp, the

4183

# job is marked as expired, and it no longer appears in search results. The

4184

# expired job can't be deleted or listed by the DeleteJob and

4185

# ListJobs APIs, but it can be retrieved with the GetJob API or

4186

# updated with the UpdateJob API. An expired job can be updated and

4187

# opened again by using a future expiration timestamp. Updating an expired

4188

# job fails if there is another existing open job with same company_name,

4189

# language_code and requisition_id.

4190

#

4191

# The expired jobs are retained in our system for 90 days. However, the

4192

# overall expired job count cannot exceed 3 times the maximum of open jobs

4193

# count over the past week, otherwise jobs with earlier expire time are

4194

# cleaned first. Expired jobs are no longer accessible after they are cleaned

4195

# out.

4196

#

4197

# Invalid timestamps are ignored, and treated as expire time not provided.

4198

#

4199

# Timestamp before the instant request is made is considered valid, the job

4200

# will be treated as expired immediately.

4201

#

4202

# If this value is not provided at the time of job creation or is invalid,

4203

# the job posting expires after 30 days from the job's creation time. For

4204

# example, if the job was created on 2017/01/01 13:00AM UTC with an

4205

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

4206

#

4207

# If this value is not provided on job update, it depends on the field masks

4208

# set by UpdateJobRequest.update_mask. If the field masks include

4209

# expiry_time, or the masks are empty meaning that every field is

4210

# updated, the job posting expires after 30 days from the job's last

4211

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4212

"department": "A String", # Optional. The department or functional area within the company with the open

4213

# position.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4214

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4215

# The maximum number of allowed characters is 255.

4216

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4217

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4218

# Derived details about the job posting.

4219

"locations": [ # Structured locations of the job, resolved from Job.addresses.

4220

#

4221

# locations are exactly matched to Job.addresses in the same

4222

# order.

4223

{ # Output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4224

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4225

# A resource that represents a location with full geographic information.

4226

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4227

# such as postal delivery and payments addresses. Given a postal address,

4228

# a postal service can deliver items to a premises, P.O. Box, or other

4229

# delivery location.

4230

# Given a postal address, a postal service can deliver items to a premise, P.O.

4231

# Box or similar.

4232

# It is not intended to model geographical locations (roads, towns,

4233

# mountains).

4234

#

4235

# In typical usage an address would be created via user input or from importing

4236

# existing data, depending on the type of process.

4237

#

4238

# Advice on address input / editing:

4239

# - Use an i18n-ready address widget such as

4240

# https://github.com/google/libaddressinput)

4241

# - Users should not be presented with UI elements for input or editing of

4242

# fields outside countries where that field is used.

4243

#

4244

# For more guidance on how to use this schema, please see:

4245

# https://support.google.com/business/answer/6397478

4246

"organization": "A String", # Optional. The name of the organization at the address.

4247

"sublocality": "A String", # Optional. Sublocality of the address.

4248

# For example, this can be neighborhoods, boroughs, districts.

4249

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4250

# known). This is often the UI language of the input form or is expected

4251

# to match one of the languages used in the address' country/region, or their

4252

# transliterated equivalents.

4253

# This can affect formatting in certain countries, but is not critical

4254

# to the correctness of the data and will never affect any validation or

4255

# other non-formatting related operations.

4256

#

4257

# If this value is not known, it should be omitted (rather than specifying a

4258

# possibly incorrect default).

4259

#

4260

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

4261

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

4262

# addresses of a country or region.

4263

# For example, this can be a state, a province, an oblast, or a prefecture.

4264

# Specifically, for Spain this is the province and not the autonomous

4265

# community (e.g. "Barcelona" and not "Catalonia").

4266

# Many countries don't use an administrative area in postal addresses. E.g.

4267

# in Switzerland this should be left unpopulated.

4268

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

4269

# Examples: US city, IT comune, UK post town.

4270

# In regions of the world where localities are not well defined or do not fit

4271

# into this structure well, leave locality empty and use address_lines.

4272

"recipients": [ # Optional. The recipient at the address.

4273

# This field may, under certain circumstances, contain multiline information.

4274

# For example, it might contain "care of" information.

4275

"A String",

4276

],

4277

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

4278

# the latest revision.

4279

#

4280

# All new revisions **must** be backward compatible with old revisions.

4281

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

4282

# postal codes to be present, but where they are used, they may trigger

4283

# additional validation with other parts of the address (e.g. state/zip

4284

# validation in the U.S.A.).

4285

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

4286

# in most regions. Where it is used, the value is either a string like

4287

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

4288

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

4289

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

4290

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

4291

# is never inferred and it is up to the user to ensure the value is

4292

# correct. See http://cldr.unicode.org/ and

4293

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4294

# for details. Example: "CH" for Switzerland.

4295

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

4296

#

4297

# Because values in address_lines do not have type information and may

4298

# sometimes contain multiple values in a single field (e.g.

4299

# "Austin, TX"), it is important that the line order is clear. The order of

4300

# address lines should be "envelope order" for the country/region of the

4301

# address. In places where this can vary (e.g. Japan), address_language is

4302

# used to make it explicit (e.g. "ja" for large-to-small ordering and

4303

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

4304

# an address can be selected based on the language.

4305

#

4306

# The minimum permitted structural representation of an address consists

4307

# of a region_code with all remaining information placed in the

4308

# address_lines. It would be possible to format such an address very

4309

# approximately without geocoding, but no semantic reasoning could be

4310

# made about any of the address components until it was at least

4311

# partially resolved.

4312

#

4313

# Creating an address only containing a region_code and address_lines, and

4314

# then geocoding is the recommended way to handle completely unstructured

4315

# addresses (as opposed to guessing which parts of the address should be

4316

# localities or administrative areas).

"A String",

],

},

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

4321

# location bounding box in which a circle with the specified radius

4322

# centered from LatLng covers the area associated with the job location.

4323

# For example, currently, "Mountain View, CA, USA" has a radius of

4324

# 6.17 miles.

4325

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4326

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4327

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4328

# LocationType#LOCALITY.

4329

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4330

# of doubles representing degrees latitude and degrees longitude. Unless

4331

# specified otherwise, this must conform to the

4332

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4333

# standard</a>. Values must be within normalized ranges.

4334

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4335

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

4340

"A String",

4341

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4342

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4343

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

4344

# is used for contracting engagements. Invalid timestamps are ignored.

4345

"visibility": "A String", # Deprecated. The job is only visible to the owner.

4346

#

4347

# The visibility of the job.

4348

#

4349

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

4350

"processingOptions": { # Input only. # Optional. Options for job processing.

4351

#

4352

# Options for job processing.

4353

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

4354

# more precise address for the job.

4355

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

4356

#

4357

# * description

4358

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

4364

# disabled.

4365

#

4366

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

4367

},

4368

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4369

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

4370

# any requirements for fluency that are associated with the job.

4371

#

4372

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

4373

# For more information, see

4374

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

4375

# class="external" target="_blank" }.

4376

#

4377

# If this field is unspecified and Job.description is present, detected

4378

# language code based on Job.description is assigned, otherwise

4379

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4380

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

4381

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

4382

# base compensation entry's CompensationEntry.compensation times

4383

# CompensationEntry.expected_units_per_year.

4384

#

4385

# See CompensationEntry for explanation on compensation annualization.

4386

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4387

# to a maximal compensation value and the currency code is set to

4388

# match the currency code of

4389

# min_compensation.

4390

"nanos": 42, # Number of nano (10^-9) units of the amount.

4391

# The value must be between -999,999,999 and +999,999,999 inclusive.

4392

# If `units` is positive, `nanos` must be positive or zero.

4393

# If `units` is zero, `nanos` can be positive, zero, or negative.

4394

# If `units` is negative, `nanos` must be negative or zero.

4395

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4396

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4397

"units": "A String", # The whole units of the amount.

4398

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4399

},

4400

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4401

# to zero and the currency code is set to match the

4402

# currency code of max_compensation.

4403

"nanos": 42, # Number of nano (10^-9) units of the amount.

4404

# The value must be between -999,999,999 and +999,999,999 inclusive.

4405

# If `units` is positive, `nanos` must be positive or zero.

4406

# If `units` is zero, `nanos` can be positive, zero, or negative.

4407

# If `units` is negative, `nanos` must be negative or zero.

4408

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4409

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4410

"units": "A String", # The whole units of the amount.

4411

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4412

},

4413

},

4414

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

4415

# all compensation entries' CompensationEntry.compensation times

4416

# CompensationEntry.expected_units_per_year.

4417

#

4418

# See CompensationEntry for explanation on compensation annualization.

4419

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4420

# to a maximal compensation value and the currency code is set to

4421

# match the currency code of

4422

# min_compensation.

4423

"nanos": 42, # Number of nano (10^-9) units of the amount.

4424

# The value must be between -999,999,999 and +999,999,999 inclusive.

4425

# If `units` is positive, `nanos` must be positive or zero.

4426

# If `units` is zero, `nanos` can be positive, zero, or negative.

4427

# If `units` is negative, `nanos` must be negative or zero.

4428

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4429

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4430

"units": "A String", # The whole units of the amount.

4431

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4432

},

4433

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4434

# to zero and the currency code is set to match the

4435

# currency code of max_compensation.

4436

"nanos": 42, # Number of nano (10^-9) units of the amount.

4437

# The value must be between -999,999,999 and +999,999,999 inclusive.

4438

# If `units` is positive, `nanos` must be positive or zero.

4439

# If `units` is zero, `nanos` can be positive, zero, or negative.

4440

# If `units` is negative, `nanos` must be negative or zero.

4441

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4442

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4443

"units": "A String", # The whole units of the amount.

4444

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4445

},

4446

},

4447

"entries": [ # Optional. Job compensation information.

4448

#

4449

# At most one entry can be of type

4450

# CompensationInfo.CompensationType.BASE, which is

4451

# referred as ** base compensation entry ** for the job.

4452

{ # A compensation entry that represents one component of compensation, such

4453

# as base pay, bonus, or other compensation type.

4454

#

4455

# Annualization: One compensation entry can be annualized if

4456

# - it contains valid amount or range.

4457

# - and its expected_units_per_year is set or can be derived.

4458

# Its annualized range is determined as (amount or range) times

4459

# expected_units_per_year.

4460

"unit": "A String", # Optional. Frequency of the specified amount.

4461

#

4462

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

4463

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

4464

# Job.employment_types is FULLTIME, a default value is inferred

4465

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

4472

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4473

# to a maximal compensation value and the currency code is set to

4474

# match the currency code of

4475

# min_compensation.

4476

"nanos": 42, # Number of nano (10^-9) units of the amount.

4477

# The value must be between -999,999,999 and +999,999,999 inclusive.

4478

# If `units` is positive, `nanos` must be positive or zero.

4479

# If `units` is zero, `nanos` can be positive, zero, or negative.

4480

# If `units` is negative, `nanos` must be negative or zero.

4481

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4482

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4483

"units": "A String", # The whole units of the amount.

4484

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4485

},

4486

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4487

# to zero and the currency code is set to match the

4488

# currency code of max_compensation.

4489

"nanos": 42, # Number of nano (10^-9) units of the amount.

4490

# The value must be between -999,999,999 and +999,999,999 inclusive.

4491

# If `units` is positive, `nanos` must be positive or zero.

4492

# If `units` is zero, `nanos` can be positive, zero, or negative.

4493

# If `units` is negative, `nanos` must be negative or zero.

4494

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4495

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4496

"units": "A String", # The whole units of the amount.

4497

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4498

},

4499

},

4500

"description": "A String", # Optional. Compensation description. For example, could

4501

# indicate equity terms or provide additional context to an estimated

4502

# bonus.

4503

"type": "A String", # Optional. Compensation type.

4504

#

4505

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

4506

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

4507

"nanos": 42, # Number of nano (10^-9) units of the amount.

4508

# The value must be between -999,999,999 and +999,999,999 inclusive.

4509

# If `units` is positive, `nanos` must be positive or zero.

4510

# If `units` is zero, `nanos` can be positive, zero, or negative.

4511

# If `units` is negative, `nanos` must be negative or zero.

4512

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4513

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4514

"units": "A String", # The whole units of the amount.

4515

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4521

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4522

# The resource name for the job. This is generated by the service when a

4523

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4524

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4525

# The format is "projects/{project_id}/jobs/{job_id}",

4526

# for example, "projects/api-test-project/jobs/1234".

4527

#

4528

# Use of this field in job queries and API calls is preferred over the use of

4529

# requisition_id since this value is unique.

4530

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

4531

# client to identify a job. This field is intended to be used by clients

4532

# for client identification and tracking of postings. A job is not allowed

4533

# to be created if there is another job with the same [company_name],

4534

# language_code and requisition_id.

4535

#

4536

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4537

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4538

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

4539

# closely matching a search query's keywords, if available. The matching

4540

# query keywords are enclosed in HTML bold tags.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4541

"commuteInfo": { # Output only. # Commute information which is generated based on specified

4542

# CommuteFilter.

4543

#

4544

# Commute details related to this job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4545

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

4546

#

4547

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4548

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4549

# such as postal delivery and payments addresses. Given a postal address,

4550

# a postal service can deliver items to a premises, P.O. Box, or other

4551

# delivery location.

4552

# Given a postal address, a postal service can deliver items to a premise, P.O.

4553

# Box or similar.

4554

# It is not intended to model geographical locations (roads, towns,

4555

# mountains).

4556

#

4557

# In typical usage an address would be created via user input or from importing

4558

# existing data, depending on the type of process.

4559

#

4560

# Advice on address input / editing:

4561

# - Use an i18n-ready address widget such as

4562

# https://github.com/google/libaddressinput)

4563

# - Users should not be presented with UI elements for input or editing of

4564

# fields outside countries where that field is used.

4565

#

4566

# For more guidance on how to use this schema, please see:

4567

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4568

"organization": "A String", # Optional. The name of the organization at the address.

4569

"sublocality": "A String", # Optional. Sublocality of the address.

4570

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4571

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4572

# known). This is often the UI language of the input form or is expected

4573

# to match one of the languages used in the address' country/region, or their

4574

# transliterated equivalents.

4575

# This can affect formatting in certain countries, but is not critical

4576

# to the correctness of the data and will never affect any validation or

4577

# other non-formatting related operations.

4578

#

4579

# If this value is not known, it should be omitted (rather than specifying a

4580

# possibly incorrect default).

4581

#

4582

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4583

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

4584

# addresses of a country or region.

4585

# For example, this can be a state, a province, an oblast, or a prefecture.

4586

# Specifically, for Spain this is the province and not the autonomous

4587

# community (e.g. "Barcelona" and not "Catalonia").

4588

# Many countries don't use an administrative area in postal addresses. E.g.

4589

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4590

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

4591

# Examples: US city, IT comune, UK post town.

4592

# In regions of the world where localities are not well defined or do not fit

4593

# into this structure well, leave locality empty and use address_lines.

4594

"recipients": [ # Optional. The recipient at the address.

4595

# This field may, under certain circumstances, contain multiline information.

4596

# For example, it might contain "care of" information.

4597

"A String",

4598

],

4599

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

4600

# the latest revision.

4601

#

4602

# All new revisions **must** be backward compatible with old revisions.

4603

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

4604

# postal codes to be present, but where they are used, they may trigger

4605

# additional validation with other parts of the address (e.g. state/zip

4606

# validation in the U.S.A.).

4607

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

4608

# in most regions. Where it is used, the value is either a string like

4609

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

4610

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

4611

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

4612

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

4613

# is never inferred and it is up to the user to ensure the value is

4614

# correct. See http://cldr.unicode.org/ and

4615

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4616

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4617

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

4618

#

4619

# Because values in address_lines do not have type information and may

4620

# sometimes contain multiple values in a single field (e.g.

4621

# "Austin, TX"), it is important that the line order is clear. The order of

4622

# address lines should be "envelope order" for the country/region of the

4623

# address. In places where this can vary (e.g. Japan), address_language is

4624

# used to make it explicit (e.g. "ja" for large-to-small ordering and

4625

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

4626

# an address can be selected based on the language.

4627

#

4628

# The minimum permitted structural representation of an address consists

4629

# of a region_code with all remaining information placed in the

4630

# address_lines. It would be possible to format such an address very

4631

# approximately without geocoding, but no semantic reasoning could be

4632

# made about any of the address components until it was at least

4633

# partially resolved.

4634

#

4635

# Creating an address only containing a region_code and address_lines, and

4636

# then geocoding is the recommended way to handle completely unstructured

4637

# addresses (as opposed to guessing which parts of the address should be

4638

# localities or administrative areas).

4639

"A String",

4640

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4641

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4642

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

4643

# location bounding box in which a circle with the specified radius

4644

# centered from LatLng covers the area associated with the job location.

4645

# For example, currently, "Mountain View, CA, USA" has a radius of

4646

# 6.17 miles.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4647

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4648

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4649

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4650

# LocationType#LOCALITY.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4651

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4652

# of doubles representing degrees latitude and degrees longitude. Unless

4653

# specified otherwise, this must conform to the

4654

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4655

# standard</a>. Values must be within normalized ranges.

4656

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4657

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4658

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4659

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4660

"travelDuration": "A String", # The number of seconds required to travel to the job location from the

4661

# query location. A duration of 0 seconds indicates that the job is not

4662

# reachable within the requested duration, but was returned as part of an

4663

# expanded query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4664

},

4665

},

4666

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4667

"broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the

4668

# broadened query. This number indicates how many of the jobs returned in the

4669

# jobs field are from the broadened query. These results are always at the

4670

# end of the jobs list. In particular, a value of 0, or if the field isn't

4671

# set, all the jobs in the jobs list are from the original

4672

# (without broadening) query. If this field is non-zero, subsequent requests

4673

# with offset after this result set should contain all broadened results.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4674

"locationFilters": [ # The location filters that the service applied to the specified query. If

4675

# any filters are lat-lng based, the JobLocation.location_type is

4676

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

4677

{ # Output only.

4678

#

4679

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4680

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4681

# such as postal delivery and payments addresses. Given a postal address,

4682

# a postal service can deliver items to a premises, P.O. Box, or other

4683

# delivery location.

4684

# Given a postal address, a postal service can deliver items to a premise, P.O.

4685

# Box or similar.

4686

# It is not intended to model geographical locations (roads, towns,

4687

# mountains).

4688

#

4689

# In typical usage an address would be created via user input or from importing

4690

# existing data, depending on the type of process.

4691

#

4692

# Advice on address input / editing:

4693

# - Use an i18n-ready address widget such as

4694

# https://github.com/google/libaddressinput)

4695

# - Users should not be presented with UI elements for input or editing of

4696

# fields outside countries where that field is used.

4697

#

4698

# For more guidance on how to use this schema, please see:

4699

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4700

"organization": "A String", # Optional. The name of the organization at the address.

4701

"sublocality": "A String", # Optional. Sublocality of the address.

4702

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4703

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4704

# known). This is often the UI language of the input form or is expected

4705

# to match one of the languages used in the address' country/region, or their

4706

# transliterated equivalents.

4707

# This can affect formatting in certain countries, but is not critical

4708

# to the correctness of the data and will never affect any validation or

4709

# other non-formatting related operations.

4710

#

4711

# If this value is not known, it should be omitted (rather than specifying a

4712

# possibly incorrect default).

4713

#

4714

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4715

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

4716

# addresses of a country or region.

4717

# For example, this can be a state, a province, an oblast, or a prefecture.

4718

# Specifically, for Spain this is the province and not the autonomous

4719

# community (e.g. "Barcelona" and not "Catalonia").

4720

# Many countries don't use an administrative area in postal addresses. E.g.

4721

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4722

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

4723

# Examples: US city, IT comune, UK post town.

4724

# In regions of the world where localities are not well defined or do not fit

4725

# into this structure well, leave locality empty and use address_lines.

4726

"recipients": [ # Optional. The recipient at the address.

4727

# This field may, under certain circumstances, contain multiline information.

4728

# For example, it might contain "care of" information.

4729

"A String",

4730

],

4731

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

4732

# the latest revision.

4733

#

4734

# All new revisions **must** be backward compatible with old revisions.

4735

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

4736

# postal codes to be present, but where they are used, they may trigger

4737

# additional validation with other parts of the address (e.g. state/zip

4738

# validation in the U.S.A.).

4739

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

4740

# in most regions. Where it is used, the value is either a string like

4741

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

4742

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

4743

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

4744

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

4745

# is never inferred and it is up to the user to ensure the value is

4746

# correct. See http://cldr.unicode.org/ and

4747

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4748

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4749

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

4750

#

4751

# Because values in address_lines do not have type information and may

4752

# sometimes contain multiple values in a single field (e.g.

4753

# "Austin, TX"), it is important that the line order is clear. The order of

4754

# address lines should be "envelope order" for the country/region of the

4755

# address. In places where this can vary (e.g. Japan), address_language is

4756

# used to make it explicit (e.g. "ja" for large-to-small ordering and

4757

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

4758

# an address can be selected based on the language.

4759

#

4760

# The minimum permitted structural representation of an address consists

4761

# of a region_code with all remaining information placed in the

4762

# address_lines. It would be possible to format such an address very

4763

# approximately without geocoding, but no semantic reasoning could be

4764

# made about any of the address components until it was at least

4765

# partially resolved.

4766

#

4767

# Creating an address only containing a region_code and address_lines, and

4768

# then geocoding is the recommended way to handle completely unstructured

4769

# addresses (as opposed to guessing which parts of the address should be

4770

# localities or administrative areas).

4771

"A String",

4772

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4773

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4774

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

4775

# location bounding box in which a circle with the specified radius

4776

# centered from LatLng covers the area associated with the job location.

4777

# For example, currently, "Mountain View, CA, USA" has a radius of

4778

# 6.17 miles.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4779

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4780

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4781

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4782

# LocationType#LOCALITY.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4783

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4784

# of doubles representing degrees latitude and degrees longitude. Unless

4785

# specified otherwise, this must conform to the

4786

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4787

# standard</a>. Values must be within normalized ranges.

4788

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4789

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4790

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4791

},

4792

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4793

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

4794

# This field is empty if there are no more results.

4795

"metadata": { # Output only. # Additional information for the API invocation, such as the request

4796

# tracking id.

4797

#

4798

# Additional information returned to client, such as debugging information.

4799

"requestId": "A String", # A unique id associated with this call.

4800

# This id is logged for tracking purposes.

4801

},

4802

"histogramResults": { # Output only. # The histogram results that match specified

4803

# SearchJobsRequest.histogram_facets.

4804

#

4805

# Histogram results that match HistogramFacets specified in

4806

# SearchJobsRequest.

4807

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that match

4808

# HistogramFacets.compensation_histogram_requests.

4809

{ # Output only.

4810

#

4811

# Compensation based histogram result.

4812

"result": { # Output only. # Histogram result.

4813

#

4814

# Custom numeric bucketing result.

4815

"counts": [ # Count within each bucket. Its size is the length of

4816

# NumericBucketingOption.bucket_bounds plus 1.

4817

{ # Represents count of jobs within one bucket.

4818

"count": 42, # Number of jobs whose numeric field value fall into `range`.

4819

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

4820

# that is, the count represents number of jobs in this range.

4821

"to": 3.14, # Ending value of the bucket range.

4822

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

4827

# [NumericBucketingOption.requires_min_max] is set to true.

4828

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

4829

# [NumericBucketingOption.requires_min_max] is set to true.

4830

},

4831

"type": "A String", # Type of the request, corresponding to

4832

# CompensationHistogramRequest.type.

4833

},

4834

],

4835

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match

4836

# HistogramFacets.custom_attribute_histogram_facets.

4837

{ # Output only.

4838

#

4839

# Custom attribute histogram result.

4840

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

4841

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

4842

# custom attribute long values associated with `key`.

4843

#

4844

# Custom numeric bucketing result.

4845

"counts": [ # Count within each bucket. Its size is the length of

4846

# NumericBucketingOption.bucket_bounds plus 1.

4847

{ # Represents count of jobs within one bucket.

4848

"count": 42, # Number of jobs whose numeric field value fall into `range`.

4849

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

4850

# that is, the count represents number of jobs in this range.

4851

"to": 3.14, # Ending value of the bucket range.

4852

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

4857

# [NumericBucketingOption.requires_min_max] is set to true.

4858

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

4859

# [NumericBucketingOption.requires_min_max] is set to true.

4860

},

4861

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

4862

# with `key` to the number of jobs with that value in this histogram result.

"a_key": 42,

},

},

],

"simpleHistogramResults": [ # Specifies histogram results that matches

4868

# HistogramFacets.simple_histogram_facets.

4869

{ # Output only.

4870

#

4871

# Result of a histogram call. The response contains the histogram map for the

4872

# search type specified by HistogramResult.field.

4873

# The response is a map of each filter value to the corresponding count of

4874

# jobs for that filter.

4875

"values": { # A map from the values of field to the number of jobs with that value

4876

# in this search result.

4877

#

4878

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

4879

#

4880

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

4881

"a_key": 42,

4882

},

4883

"searchType": "A String", # The Histogram search filters.

},

],

},

"estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.

4888

#

4889

# This number is not guaranteed to be accurate. For accurate results,

4890

# see enable_precise_result_size.

4891

"totalSize": 42, # The precise result count, which is available only if the client set

4892

# enable_precise_result_size to `true`, or if the response

4893

# is the last page of results. Otherwise, the value is `-1`.

4894

"spellCorrection": { # Output only. # The spell checking result, and correction.

4895

#

4896

# Spell check result.

4897

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

4898

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

4899

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4904

<code class="details" id="searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4905

<pre>Searches for jobs using the provided SearchJobsRequest.

4906

4907

This API call is intended for the use case of targeting passive job

4908

seekers (for example, job seekers who have signed up to receive email

4909

alerts about potential job opportunities), and has different algorithmic

4910

adjustments that are targeted to passive job seekers.

4911

4912

This call constrains the visibility of jobs

4913

present in the database, and only returns jobs the caller has

4914

permission to search against.

4915

4916

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4917

parent: string, Required. The resource name of the project to search within.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4918

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4919

The format is "projects/{project_id}", for example,

4920

"projects/api-test-project". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4921

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4922

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4927

"requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the

4928

# search quality of the service. The identifiers (such as `user_id`) are

4929

# provided by users, and must be unique and consistent.

4930

#

4931

# Meta information related to the job searcher or entity

4932

# conducting the job search. This information is used to improve the

4933

# performance of the service.

4934

"userId": "A String", # Required. A unique user identification string, as determined by the client.

4935

# To have the strongest positive impact on search quality

4936

# make sure the client-level is unique.

4937

# Obfuscate this field for privacy concerns before

4938

# providing it to the service.

4939

#

4940

# If this field is not available for some reason, send "UNKNOWN". Note

4941

# that any improvements to the model for a particular tenant

4942

# site, rely on this field being set correctly to a unique user_id.

4943

#

4944

# The maximum number of allowed characters is 255.

4945

"sessionId": "A String", # Required. A unique session identification string. A session is defined as the

4946

# duration of an end user's interaction with the service over a certain

4947

# period.

4948

# Obfuscate this field for privacy concerns before

4949

# providing it to the service.

4950

#

4951

# If this field is not available for some reason, send "UNKNOWN". Note

4952

# that any improvements to the model for a particular tenant

4953

# site, rely on this field being set correctly to some unique session_id.

4954

#

4955

# The maximum number of allowed characters is 255.

4956

"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

4957

# service.

4958

# other entity conducting the job search. Providing this information improves

4959

# the quality of the search results across devices.

4960

"id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that

4961

# distinguishes the device from other devices.

4962

"deviceType": "A String", # Optional. Type of the device.

4963

},

4964

"domain": "A String", # Required. The client-defined scope or source of the service call, which typically

4965

# is the domain on

4966

# which the service has been implemented and is currently being run.

4967

#

4968

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

4969

# job board www.foo.com and career site www.bar.com, then this field is

4970

# set to "foo.com" for use on the job board, and "bar.com" for use on the

4971

# career site.

4972

#

4973

# If this field isn't available for some reason, send "UNKNOWN".

4974

# Any improvements to the model for a particular tenant site rely on this

4975

# field being set correctly to a domain.

4976

#

4977

# The maximum number of allowed characters is 255.

4978

},

4979

"offset": 42, # Optional. An integer that specifies the current offset (that is, starting result

4980

# location, amongst the jobs deemed by the API as relevant) in search

4981

# results. This field is only considered if page_token is unset.

4982

#

4983

# The maximum allowed value is 5000. Otherwise an error is thrown.

4984

#

4985

# For example, 0 means to return results starting from the first matching

4986

# job, and 10 means to return from the 11th job. This can be used for

4987

# pagination, (for example, pageSize = 10 and offset = 10 means to return

4988

# from the second page).

4989

"histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.

4990

#

4991

# Histogram facets to be specified in SearchJobsRequest.

4992

"customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.

4993

# Duplicate values of CustomAttributeHistogramRequest.key are not

4994

# allowed.

4995

{ # Custom attributes histogram request. An error is thrown if neither

4996

# string_value_histogram or long_value_histogram_bucketing_option has

4997

# been defined.

4998

"longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's

4999

# filterable long custom field values, or min/max value requirements.

5000

#

5001

# Use this field to specify bucketing option for the histogram search response.

5002

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

5003

# value of the numeric field.

5004

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

5005

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

5006

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

5007

# [buckets_bound is supported.

3.14,

],

},

"stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for

5012

# each key as a string.

5013

"key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified

5014

# without `long_value_histogram_bucketing_option`, histogram on string values

5015

# of the given `key` is triggered, otherwise histogram is performed on long

# values.

},

],

"simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,

5020

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.

5021

"A String",

5022

],

5023

"compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.

5024

# Duplicate values of CompensationHistogramRequest.type are not allowed.

5025

{ # Input only.

5026

#

5027

# Compensation based histogram request.

5028

"type": "A String", # Required. Type of the request, representing which field the histogramming should be

5029

# performed over. A single request can only specify one histogram of each

5030

# `CompensationHistogramRequestType`.

5031

"bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.

5032

#

5033

# Use this field to specify bucketing option for the histogram search response.

5034

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

5035

# value of the numeric field.

5036

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

5037

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

5038

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

5039

# [buckets_bound is supported.

3.14,

],

},

},

],

},

"requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise

5047

# count of the first 300 results. Setting this to `true` ensures

5048

# consistency in the number of results per page. Best practice is to set this

5049

# value to true if a client allows users to jump directly to a

5050

# non-sequential search results page.

5051

#

5052

# Enabling this flag may adversely impact performance.

5053

#

5054

# Defaults to false.

5055

"searchMode": "A String", # Optional. Mode of a search.

5056

#

5057

# Defaults to SearchMode.JOB_SEARCH.

5058

"pageToken": "A String", # Optional. The token specifying the current offset within

5059

# search results. See SearchJobsResponse.next_page_token for

5060

# an explanation of how to obtain the next set of query results.

5061

"pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.

5062

# Increasing this value above the default value of 10 can increase search

5063

# response time. The value can be between 1 and 100.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5064

"disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,

5065

# Job.description, Job.company_display_name, Job.locations,

5066

# Job.qualifications. When disable keyword match is turned off, a

5067

# keyword match returns jobs that do not match given category filters when

5068

# there are matching keywords. For example, the query "program manager," a

5069

# result is returned even if the job posting has the title "software

5070

# developer," which does not fall into "program manager" ontology, but does

5071

# have "program manager" appearing in its description.

5072

#

5073

# For queries like "cloud" that does not contain title or

5074

# location specific ontology, jobs with "cloud" keyword matches are returned

5075

# regardless of this flag's value.

5076

#

5077

# Please use Company.keyword_searchable_custom_fields or

5078

# Company.keyword_searchable_custom_attributes if company specific

5079

# globally matched custom field/attribute string values is needed. Enabling

5080

# keyword match improves recall of subsequent search requests.

5081

#

5082

# Defaults to false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5083

"jobView": "A String", # Optional. The desired job attributes returned for jobs in the

5084

# search response. Defaults to JobView.SMALL if no value is specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5085

"enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.

5086

# Broadened queries append results to the end of the matching results

5087

# list.

5088

#

5089

# Defaults to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5090

"jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5091

#

5092

# The query required to perform a search query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5093

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for

5094

# example, driving or public transit). Note: This only works with COMMUTE

5095

# MODE. When specified, [JobQuery.location_filters] is

5096

# ignored.

5097

#

5098

# Currently we don't support sorting by commute time.

5099

#

5100

# Parameters needed for commute search.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5101

"commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5102

"travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

5103

# (one hour). Format is `123s`.

5104

"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

5105

# commute time.

5106

# of doubles representing degrees latitude and degrees longitude. Unless

5107

# specified otherwise, this must conform to the

5108

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5109

# standard</a>. Values must be within normalized ranges.

5110

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5111

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5112

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5113

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5114

"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

5115

# google.type.TimeOfDay in local time zone.

5116

#

5117

# Currently traffic model is restricted to hour level resolution.

5118

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5119

# types are google.type.Date and `google.protobuf.Timestamp`.

5120

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5121

# allow the value 60 if it allows leap-seconds.

5122

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5123

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5124

# to allow the value "24:00:00" for scenarios like business closing time.

5125

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5126

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5127

"allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS

5128

# coordinates) might also be returned. For city and coarser level addresses,

5129

# text matching is used. If this field is set to false or is not specified,

5130

# only jobs that include precise addresses are returned by Commute

5131

# Search.

5132

#

5133

# Note: If `allow_imprecise_addresses` is set to true, Commute Search is not

5134

# able to calculate accurate commute times to jobs with city level and

5135

# coarser address information. Jobs with imprecise addresses will return a

5136

# `travel_duration` time of 0 regardless of distance from the job seeker.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5137

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5138

"jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.

5139

# See Category for more information.

5140

#

5141

# If a value is not specified, jobs from any category are searched against.

5142

#

5143

# If multiple values are specified, jobs from any of the specified

5144

# categories are searched against.

5145

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5146

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5147

"companyNames": [ # Optional. This filter specifies the company entities to search against.

5148

#

5149

# If a value isn't specified, jobs are searched for against all

5150

# companies.

5151

#

5152

# If multiple values are specified, jobs are searched against the

5153

# companies specified.

5154

#

5155

# The format is "projects/{project_id}/companies/{company_id}", for example,

5156

# "projects/api-test-project/companies/foo".

5157

#

5158

# At most 20 company filters are allowed.

5159

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5160

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5161

"queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to

5162

# better interpret the query.

5163

#

5164

# If a value isn't specified, the query language code is automatically

5165

# detected, which may not be accurate.

5166

#

5167

# Language code should be in BCP-47 format, such as "en-US" or "sr-Latn".

5168

# For more information, see

5169

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5170

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

5171

# Job.custom_attributes marked as `filterable`.

5172

#

5173

# The syntax for this expression is a subset of SQL syntax.

5174

#

5175

# Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the

5176

# left of the operator is a custom field key and the right of the operator

5177

# is a number or a quoted string. You must escape backslash (\\) and

5178

# quote (\") characters.

5179

#

5180

# Supported functions are `LOWER([field_name])` to

5181

# perform a case insensitive match and `EMPTY([field_name])` to filter on the

5182

# existence of a key.

5183

#

5184

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

5185

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100

5186

# comparisons or functions are allowed in the expression. The expression

5187

# must be < 6000 bytes in length.

5188

#

5189

# Sample Query:

5190

# `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND

5191

# driving_years > 10`

5192

"publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched

5193

# against.

5194

"endTime": "A String", # End of the period.

5195

"startTime": "A String", # Begin of the period.

5196

},

5197

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

5198

# for example, "en-US".

5199

#

5200

# If a value isn't specified, the search results can contain jobs in any

# locale.

#

#

# Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".

5205

# For more information, see

5206

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

5207

#

5208

# At most 10 language code filters are allowed.

5209

"A String",

5210

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5211

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

5212

# search against, such as EmploymentType.FULL_TIME.

5213

#

5214

# If a value is not specified, jobs in the search results includes any

5215

# employment type.

5216

#

5217

# If multiple values are specified, jobs in the search results include

5218

# any of the specified employment types.

5219

"A String",

5220

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5221

"query": "A String", # Optional. The query string that matches against the job title, description, and

5222

# location fields.

5223

#

5224

# The maximum number of allowed characters is 255.

5225

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

5226

# service attempts to correct a misspelled query,

5227

# for example, "enginee" is corrected to "engineer".

5228

#

5229

# Defaults to false: a spell check is performed.

5230

"companyDisplayNames": [ # Optional. This filter specifies the exact company display

5231

# name of the jobs to search against.

5232

#

5233

# If a value isn't specified, jobs within the search results are

5234

# associated with any company.

5235

#

5236

# If multiple values are specified, jobs within the search results may be

5237

# associated with any of the specified companies.

5238

#

5239

# At most 20 company display name filters are allowed.

5240

"A String",

5241

],

5242

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

5243

# search against. See LocationFilter for more information.

5244

#

5245

# If a location value isn't specified, jobs fitting the other search

5246

# criteria are retrieved regardless of where they're located.

5247

#

5248

# If multiple values are specified, jobs are retrieved from any of the

5249

# specified locations. If different values are specified for the

5250

# LocationFilter.distance_in_miles parameter, the maximum provided

5251

# distance is used for all locations.

5252

#

5253

# At most 5 location filters are allowed.

5254

{ # Input only.

5255

#

5256

# Geographic region of the search.

5257

"telecommutePreference": "A String", # Optional. Allows the client to return jobs without a

5258

# set location, specifically, telecommuting jobs (telecommuting is considered

5259

# by the service as a special location.

5260

# Job.posting_region indicates if a job permits telecommuting.

5261

# If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,

5262

# telecommuting jobs are searched, and address and lat_lng are

5263

# ignored. If not set or set to

5264

# TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not

5265

# searched.

5266

#

5267

# This filter can be used by itself to search exclusively for telecommuting

5268

# jobs, or it can be combined with another location

5269

# filter to search for a combination of job locations,

5270

# such as "Mountain View" or "telecommuting" jobs. However, when used in

5271

# combination with other location filters, telecommuting jobs can be

5272

# treated as less relevant than other jobs in the search response.

5273

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

5274

# identified as a city or smaller. When the location being searched for is a

5275

# state or larger, this field is ignored.

5276

"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

5277

# search. This field's ignored if `address` is provided.

5278

# of doubles representing degrees latitude and degrees longitude. Unless

5279

# specified otherwise, this must conform to the

5280

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5281

# standard</a>. Values must be within normalized ranges.

5282

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5283

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5284

},

5285

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used

5286

# to address ambiguity of the user-input location, for example, "Liverpool"

5287

# against "Liverpool, NY, US" or "Liverpool, UK".

5288

#

5289

# Set this field if all the jobs to search against are from a same region,

5290

# or jobs are world-wide, but the job seeker is from a specific region.

5291

#

5292

# See http://cldr.unicode.org/ and

5293

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5294

# for details. Example: "CH" for Switzerland.

5295

"address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

5296

},

5297

],

5298

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

5299

# Job.compensation_info. For example, if the filter is specified

5300

# as "Hourly job with per-hour compensation > $15", only jobs meeting

5301

# these criteria are searched. If a filter isn't defined, all open jobs

5302

# are searched.

5303

#

5304

# Filter on job compensation type and amount.

5305

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are

5306

# included.

5307

"type": "A String", # Required. Type of filter.

5308

"units": [ # Required. Specify desired `base compensation entry's`

5309

# CompensationInfo.CompensationUnit.

5310

"A String",

5311

],

5312

"range": { # Compensation range. # Optional. Compensation range.

5313

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5314

# to a maximal compensation value and the currency code is set to

5315

# match the currency code of

5316

# min_compensation.

5317

"nanos": 42, # Number of nano (10^-9) units of the amount.

5318

# The value must be between -999,999,999 and +999,999,999 inclusive.

5319

# If `units` is positive, `nanos` must be positive or zero.

5320

# If `units` is zero, `nanos` can be positive, zero, or negative.

5321

# If `units` is negative, `nanos` must be negative or zero.

5322

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5323

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5324

"units": "A String", # The whole units of the amount.

5325

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5326

},

5327

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5328

# to zero and the currency code is set to match the

5329

# currency code of max_compensation.

5330

"nanos": 42, # Number of nano (10^-9) units of the amount.

5331

# The value must be between -999,999,999 and +999,999,999 inclusive.

5332

# If `units` is positive, `nanos` must be positive or zero.

5333

# If `units` is zero, `nanos` can be positive, zero, or negative.

5334

# If `units` is negative, `nanos` must be negative or zero.

5335

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5336

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5337

"units": "A String", # The whole units of the amount.

5338

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5339

},

5340

},

5341

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5342

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5343

"orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is

5344

# "relevance desc".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5345

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5346

# Supported options are:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5347

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5348

# * `"relevance desc"`: By relevance descending, as determined by the API

5349

# algorithms. Relevance thresholding of query results is only available

5350

# with this ordering.

5351

# * `"posting_publish_time desc"`: By Job.posting_publish_time

5352

# descending.

5353

# * `"posting_update_time desc"`: By Job.posting_update_time

5354

# descending.

5355

# * `"title"`: By Job.title ascending.

5356

# * `"title desc"`: By Job.title descending.

5357

# * `"annualized_base_compensation"`: By job's

5358

# CompensationInfo.annualized_base_compensation_range ascending. Jobs

5359

# whose annualized base compensation is unspecified are put at the end of

5360

# search results.

5361

# * `"annualized_base_compensation desc"`: By job's

5362

# CompensationInfo.annualized_base_compensation_range descending. Jobs

5363

# whose annualized base compensation is unspecified are put at the end of

5364

# search results.

5365

# * `"annualized_total_compensation"`: By job's

5366

# CompensationInfo.annualized_total_compensation_range ascending. Jobs

5367

# whose annualized base compensation is unspecified are put at the end of

5368

# search results.

5369

# * `"annualized_total_compensation desc"`: By job's

5370

# CompensationInfo.annualized_total_compensation_range descending. Jobs

5371

# whose annualized base compensation is unspecified are put at the end of

5372

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5373

"diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in

5374

# the search results. Jobs are identified as highly similar based on

5375

# their titles, job categories, and locations. Highly similar results are

5376

# clustered so that only one representative job of the cluster is

5377

# displayed to the job seeker higher up in the results, with the other jobs

5378

# being displayed lower down in the results.

5379

#

5380

# Defaults to DiversificationLevel.SIMPLE if no value

5381

# is specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5382

}

5383

5384

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# Response for SearchJob method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5395

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

5396

{ # Output only.

5397

#

5398

# Job entry with metadata inside SearchJobsResponse.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5399

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

5400

# fields that most closely match a search query's keywords, if available.

5401

# All HTML tags in the original fields are stripped when returned in this

5402

# field, and matching query keywords are enclosed in HTML bold tags.

5403

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

5404

# results listing page.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5405

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

5406

# or "job requisition"). A job belongs to a Company, which is the hiring

5407

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5408

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

5409

#

5410

# Job application information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5411

"instruction": "A String", # Optional but at least one of uris,

5412

# emails or instruction must be

5413

# specified.

5414

#

5415

# Use this field to provide instructions, such as "Mail your application

5416

# to ...", that a candidate can follow to apply for the job.

5417

#

5418

# This field accepts and sanitizes HTML input, and also accepts

5419

# bold, italic, ordered list, and unordered list markup tags.

5420

#

5421

# The maximum number of allowed characters is 3,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5422

"uris": [ # Optional but at least one of uris,

5423

# emails or instruction must be

5424

# specified.

5425

#

5426

# Use this URI field to direct an applicant to a website, for example to

5427

# link to an online application form.

5428

#

5429

# The maximum number of allowed characters for each entry is 2,000.

5430

"A String",

5431

],

5432

"emails": [ # Optional but at least one of uris,

5433

# emails or instruction must be

5434

# specified.

5435

#

5436

# Use this field to specify email address(es) to which resumes or

5437

# applications can be sent.

5438

#

5439

# The maximum number of allowed characters for each entry is 255.

5440

"A String",

5441

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5442

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5443

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

5444

# recommended as an alternative to using the more general description

5445

# field.

5446

#

5447

# This field accepts and sanitizes HTML input, and also accepts

5448

# bold, italic, ordered list, and unordered list markup tags.

5449

#

5450

# The maximum number of allowed characters is 10,000.

5451

"companyName": "A String", # Required. The resource name of the company listing the job, such as

5452

# "projects/api-test-project/companies/foo".

5453

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

5454

# The value determines the sort order of the jobs returned when searching for

5455

# jobs using the featured jobs search call, with higher promotional values

5456

# being returned first and ties being resolved by relevance sort. Only the

5457

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

5458

#

5459

# Default value is 0, and negative values are treated as 0.

5460

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

5461

"A String",

5462

],

5463

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

5464

# description of the company and related information. Separate fields are

5465

# provided on the job object for responsibilities,

5466

# qualifications, and other job characteristics. Use of

5467

# these separate job fields is recommended.

5468

#

5469

# This field accepts and sanitizes HTML input, and also accepts

5470

# bold, italic, ordered list, and unordered list markup tags.

5471

#

5472

# The maximum number of allowed characters is 100,000.

5473

"title": "A String", # Required. The title of the job, such as "Software Engineer"

5474

#

5475

# The maximum number of allowed characters is 500.

5476

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

5477

# value is the time the request arrives at the server. Invalid timestamps are

5478

# ignored.

5479

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

5480

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

5481

# incentives associated with the job not including salary or pay.

5482

#

5483

# The maximum number of allowed characters is 10,000.

5484

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

5485

# engagements. Invalid timestamps are ignored.

5486

"addresses": [ # Optional but strongly recommended for the best service experience.

5487

#

5488

# Location(s) where the employer is looking to hire for this job posting.

5489

#

5490

# Specifying the full street address(es) of the hiring location enables

5491

# better API results, especially job searches by commute time.

5492

#

5493

# At most 50 locations are allowed for best search performance. If a job has

5494

# more locations, it is suggested to split it into multiple jobs with unique

5495

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

5496

# multiple jobs with the same company_name, language_code and

5497

# requisition_id are not allowed. If the original requisition_id must

5498

# be preserved, a custom field should be used for storage. It is also

5499

# suggested to group the locations that close to each other in the same job

5500

# for better search experience.

5501

#

5502

# The maximum number of allowed characters is 500.

5503

"A String",

5504

],

5505

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

5506

"jobBenefits": [ # Optional. The benefits included with the job.

5507

"A String",

5508

],

5509

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

5510

# job. The use of this field is recommended

5511

# as an alternative to using the more general description field.

5512

#

5513

# This field accepts and sanitizes HTML input, and also accepts

5514

# bold, italic, ordered list, and unordered list markup tags.

5515

#

5516

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5517

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

5518

# the job is available. If this field is set, a

5519

# LocationFilter in a search query within the job region

5520

# finds this job posting if an exact location match isn't specified.

5521

# If this field is set to PostingRegion.NATION or

5522

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

5523

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5524

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

5525

# attributes that are not covered by the provided structured fields.

5526

#

5527

# The keys of the map are strings up to 64 bytes and must match the

5528

# pattern: a-zA-Z*. For example, key0LikeThis or

5529

# KEY_1_LIKE_THIS.

5530

#

5531

# At most 100 filterable and at most 100 unfilterable keys are supported.

5532

# For filterable `string_values`, across all keys at most 200 values are

5533

# allowed, with each string no more than 255 characters. For unfilterable

5534

# `string_values`, the maximum total size of `string_values` across all keys

5535

# is 50KB.

5536

"a_key": { # Custom attribute values that are either filterable or non-filterable.

5537

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

5538

# custom attribute filters JobQuery.custom_attribute_filter.

5539

# If false, these values may not be used for custom attribute filters.

5540

#

5541

# Default is false.

5542

"stringValues": [ # Optional but exactly one of string_values or long_values must

5543

# be specified.

5544

#

5545

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

5546

# `CASE_INSENSITIVE_MATCH`) search.

5547

# For filterable `string_value`s, a maximum total number of 200 values

5548

# is allowed, with each `string_value` has a byte size of no more than

5549

# 500B. For unfilterable `string_values`, the maximum total byte size of

5550

# unfilterable `string_values` is 50KB.

5551

#

5552

# Empty string is not allowed.

5553

"A String",

5554

],

5555

"longValues": [ # Optional but exactly one of string_values or long_values must

5556

# be specified.

5557

#

5558

# This field is used to perform number range search.

5559

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

5560

#

5561

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

5567

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5572

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

5573

# experience.

5574

#

5575

# The expiration timestamp of the job. After this timestamp, the

5576

# job is marked as expired, and it no longer appears in search results. The

5577

# expired job can't be deleted or listed by the DeleteJob and

5578

# ListJobs APIs, but it can be retrieved with the GetJob API or

5579

# updated with the UpdateJob API. An expired job can be updated and

5580

# opened again by using a future expiration timestamp. Updating an expired

5581

# job fails if there is another existing open job with same company_name,

5582

# language_code and requisition_id.

5583

#

5584

# The expired jobs are retained in our system for 90 days. However, the

5585

# overall expired job count cannot exceed 3 times the maximum of open jobs

5586

# count over the past week, otherwise jobs with earlier expire time are

5587

# cleaned first. Expired jobs are no longer accessible after they are cleaned

5588

# out.

5589

#

5590

# Invalid timestamps are ignored, and treated as expire time not provided.

5591

#

5592

# Timestamp before the instant request is made is considered valid, the job

5593

# will be treated as expired immediately.

5594

#

5595

# If this value is not provided at the time of job creation or is invalid,

5596

# the job posting expires after 30 days from the job's creation time. For

5597

# example, if the job was created on 2017/01/01 13:00AM UTC with an

5598

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

5599

#

5600

# If this value is not provided on job update, it depends on the field masks

5601

# set by UpdateJobRequest.update_mask. If the field masks include

5602

# expiry_time, or the masks are empty meaning that every field is

5603

# updated, the job posting expires after 30 days from the job's last

5604

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5605

"department": "A String", # Optional. The department or functional area within the company with the open

5606

# position.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5607

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5608

# The maximum number of allowed characters is 255.

5609

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5610

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5611

# Derived details about the job posting.

5612

"locations": [ # Structured locations of the job, resolved from Job.addresses.

5613

#

5614

# locations are exactly matched to Job.addresses in the same

5615

# order.

5616

{ # Output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5617

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5618

# A resource that represents a location with full geographic information.

5619

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

5620

# such as postal delivery and payments addresses. Given a postal address,

5621

# a postal service can deliver items to a premises, P.O. Box, or other

5622

# delivery location.

5623

# Given a postal address, a postal service can deliver items to a premise, P.O.

5624

# Box or similar.

5625

# It is not intended to model geographical locations (roads, towns,

5626

# mountains).

5627

#

5628

# In typical usage an address would be created via user input or from importing

5629

# existing data, depending on the type of process.

5630

#

5631

# Advice on address input / editing:

5632

# - Use an i18n-ready address widget such as

5633

# https://github.com/google/libaddressinput)

5634

# - Users should not be presented with UI elements for input or editing of

5635

# fields outside countries where that field is used.

5636

#

5637

# For more guidance on how to use this schema, please see:

5638

# https://support.google.com/business/answer/6397478

5639

"organization": "A String", # Optional. The name of the organization at the address.

5640

"sublocality": "A String", # Optional. Sublocality of the address.

5641

# For example, this can be neighborhoods, boroughs, districts.

5642

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

5643

# known). This is often the UI language of the input form or is expected

5644

# to match one of the languages used in the address' country/region, or their

5645

# transliterated equivalents.

5646

# This can affect formatting in certain countries, but is not critical

5647

# to the correctness of the data and will never affect any validation or

5648

# other non-formatting related operations.

5649

#

5650

# If this value is not known, it should be omitted (rather than specifying a

5651

# possibly incorrect default).

5652

#

5653

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

5654

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

5655

# addresses of a country or region.

5656

# For example, this can be a state, a province, an oblast, or a prefecture.

5657

# Specifically, for Spain this is the province and not the autonomous

5658

# community (e.g. "Barcelona" and not "Catalonia").

5659

# Many countries don't use an administrative area in postal addresses. E.g.

5660

# in Switzerland this should be left unpopulated.

5661

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

5662

# Examples: US city, IT comune, UK post town.

5663

# In regions of the world where localities are not well defined or do not fit

5664

# into this structure well, leave locality empty and use address_lines.

5665

"recipients": [ # Optional. The recipient at the address.

5666

# This field may, under certain circumstances, contain multiline information.

5667

# For example, it might contain "care of" information.

5668

"A String",

5669

],

5670

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

5671

# the latest revision.

5672

#

5673

# All new revisions **must** be backward compatible with old revisions.

5674

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

5675

# postal codes to be present, but where they are used, they may trigger

5676

# additional validation with other parts of the address (e.g. state/zip

5677

# validation in the U.S.A.).

5678

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

5679

# in most regions. Where it is used, the value is either a string like

5680

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

5681

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

5682

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

5683

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

5684

# is never inferred and it is up to the user to ensure the value is

5685

# correct. See http://cldr.unicode.org/ and

5686

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5687

# for details. Example: "CH" for Switzerland.

5688

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

5689

#

5690

# Because values in address_lines do not have type information and may

5691

# sometimes contain multiple values in a single field (e.g.

5692

# "Austin, TX"), it is important that the line order is clear. The order of

5693

# address lines should be "envelope order" for the country/region of the

5694

# address. In places where this can vary (e.g. Japan), address_language is

5695

# used to make it explicit (e.g. "ja" for large-to-small ordering and

5696

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

5697

# an address can be selected based on the language.

5698

#

5699

# The minimum permitted structural representation of an address consists

5700

# of a region_code with all remaining information placed in the

5701

# address_lines. It would be possible to format such an address very

5702

# approximately without geocoding, but no semantic reasoning could be

5703

# made about any of the address components until it was at least

5704

# partially resolved.

5705

#

5706

# Creating an address only containing a region_code and address_lines, and

5707

# then geocoding is the recommended way to handle completely unstructured

5708

# addresses (as opposed to guessing which parts of the address should be

5709

# localities or administrative areas).

"A String",

],

},

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

5714

# location bounding box in which a circle with the specified radius

5715

# centered from LatLng covers the area associated with the job location.

5716

# For example, currently, "Mountain View, CA, USA" has a radius of

5717

# 6.17 miles.

5718

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

5719

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

5720

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

5721

# LocationType#LOCALITY.

5722

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

5723

# of doubles representing degrees latitude and degrees longitude. Unless

5724

# specified otherwise, this must conform to the

5725

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5726

# standard</a>. Values must be within normalized ranges.

5727

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5728

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

},

},

],

"jobCategories": [ # Job categories derived from Job.title and Job.description.

5733

"A String",

5734

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5735

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5736

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

5737

# is used for contracting engagements. Invalid timestamps are ignored.

5738

"visibility": "A String", # Deprecated. The job is only visible to the owner.

5739

#

5740

# The visibility of the job.

5741

#

5742

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

5743

"processingOptions": { # Input only. # Optional. Options for job processing.

5744

#

5745

# Options for job processing.

5746

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

5747

# more precise address for the job.

5748

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

5749

#

5750

# * description

5751

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

5757

# disabled.

5758

#

5759

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

5760

},

5761

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5762

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

5763

# any requirements for fluency that are associated with the job.

5764

#

5765

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

5766

# For more information, see

5767

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

5768

# class="external" target="_blank" }.

5769

#

5770

# If this field is unspecified and Job.description is present, detected

5771

# language code based on Job.description is assigned, otherwise

5772

# defaults to 'en_US'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5773

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

5774

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

5775

# base compensation entry's CompensationEntry.compensation times

5776

# CompensationEntry.expected_units_per_year.

5777

#

5778

# See CompensationEntry for explanation on compensation annualization.

5779

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5780

# to a maximal compensation value and the currency code is set to

5781

# match the currency code of

5782

# min_compensation.

5783

"nanos": 42, # Number of nano (10^-9) units of the amount.

5784

# The value must be between -999,999,999 and +999,999,999 inclusive.

5785

# If `units` is positive, `nanos` must be positive or zero.

5786

# If `units` is zero, `nanos` can be positive, zero, or negative.

5787

# If `units` is negative, `nanos` must be negative or zero.

5788

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5789

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5790

"units": "A String", # The whole units of the amount.

5791

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5792

},

5793

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5794

# to zero and the currency code is set to match the

5795

# currency code of max_compensation.

5796

"nanos": 42, # Number of nano (10^-9) units of the amount.

5797

# The value must be between -999,999,999 and +999,999,999 inclusive.

5798

# If `units` is positive, `nanos` must be positive or zero.

5799

# If `units` is zero, `nanos` can be positive, zero, or negative.

5800

# If `units` is negative, `nanos` must be negative or zero.

5801

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5802

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5803

"units": "A String", # The whole units of the amount.

5804

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5805

},

5806

},

5807

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

5808

# all compensation entries' CompensationEntry.compensation times

5809

# CompensationEntry.expected_units_per_year.

5810

#

5811

# See CompensationEntry for explanation on compensation annualization.

5812

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5813

# to a maximal compensation value and the currency code is set to

5814

# match the currency code of

5815

# min_compensation.

5816

"nanos": 42, # Number of nano (10^-9) units of the amount.

5817

# The value must be between -999,999,999 and +999,999,999 inclusive.

5818

# If `units` is positive, `nanos` must be positive or zero.

5819

# If `units` is zero, `nanos` can be positive, zero, or negative.

5820

# If `units` is negative, `nanos` must be negative or zero.

5821

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5822

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5823

"units": "A String", # The whole units of the amount.

5824

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5825

},

5826

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5827

# to zero and the currency code is set to match the

5828

# currency code of max_compensation.

5829

"nanos": 42, # Number of nano (10^-9) units of the amount.

5830

# The value must be between -999,999,999 and +999,999,999 inclusive.

5831

# If `units` is positive, `nanos` must be positive or zero.

5832

# If `units` is zero, `nanos` can be positive, zero, or negative.

5833

# If `units` is negative, `nanos` must be negative or zero.

5834

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5835

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5836

"units": "A String", # The whole units of the amount.

5837

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5838

},

5839

},

5840

"entries": [ # Optional. Job compensation information.

5841

#

5842

# At most one entry can be of type

5843

# CompensationInfo.CompensationType.BASE, which is

5844

# referred as ** base compensation entry ** for the job.

5845

{ # A compensation entry that represents one component of compensation, such

5846

# as base pay, bonus, or other compensation type.

5847

#

5848

# Annualization: One compensation entry can be annualized if

5849

# - it contains valid amount or range.

5850

# - and its expected_units_per_year is set or can be derived.

5851

# Its annualized range is determined as (amount or range) times

5852

# expected_units_per_year.

5853

"unit": "A String", # Optional. Frequency of the specified amount.

5854

#

5855

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

5856

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

5857

# Job.employment_types is FULLTIME, a default value is inferred

5858

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"range": { # Compensation range. # Optional. Compensation range.

5865

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5866

# to a maximal compensation value and the currency code is set to

5867

# match the currency code of

5868

# min_compensation.

5869

"nanos": 42, # Number of nano (10^-9) units of the amount.

5870

# The value must be between -999,999,999 and +999,999,999 inclusive.

5871

# If `units` is positive, `nanos` must be positive or zero.

5872

# If `units` is zero, `nanos` can be positive, zero, or negative.

5873

# If `units` is negative, `nanos` must be negative or zero.

5874

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5875

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5876

"units": "A String", # The whole units of the amount.

5877

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5878

},

5879

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5880

# to zero and the currency code is set to match the

5881

# currency code of max_compensation.

5882

"nanos": 42, # Number of nano (10^-9) units of the amount.

5883

# The value must be between -999,999,999 and +999,999,999 inclusive.

5884

# If `units` is positive, `nanos` must be positive or zero.

5885

# If `units` is zero, `nanos` can be positive, zero, or negative.

5886

# If `units` is negative, `nanos` must be negative or zero.

5887

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5888

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5889

"units": "A String", # The whole units of the amount.

5890

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5891

},

5892

},

5893

"description": "A String", # Optional. Compensation description. For example, could

5894

# indicate equity terms or provide additional context to an estimated

5895

# bonus.

5896

"type": "A String", # Optional. Compensation type.

5897

#

5898

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

5899

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

5900

"nanos": 42, # Number of nano (10^-9) units of the amount.

5901

# The value must be between -999,999,999 and +999,999,999 inclusive.

5902

# If `units` is positive, `nanos` must be positive or zero.

5903

# If `units` is zero, `nanos` can be positive, zero, or negative.

5904

# If `units` is negative, `nanos` must be negative or zero.

5905

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5906

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5907

"units": "A String", # The whole units of the amount.

5908

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

},

},

],

},

"name": "A String", # Required during job update.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5914

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5915

# The resource name for the job. This is generated by the service when a

5916

# job is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5917

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5918

# The format is "projects/{project_id}/jobs/{job_id}",

5919

# for example, "projects/api-test-project/jobs/1234".

5920

#

5921

# Use of this field in job queries and API calls is preferred over the use of

5922

# requisition_id since this value is unique.

5923

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

5924

# client to identify a job. This field is intended to be used by clients

5925

# for client identification and tracking of postings. A job is not allowed

5926

# to be created if there is another job with the same [company_name],

5927

# language_code and requisition_id.

5928

#

5929

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5930

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5931

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

5932

# closely matching a search query's keywords, if available. The matching

5933

# query keywords are enclosed in HTML bold tags.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5934

"commuteInfo": { # Output only. # Commute information which is generated based on specified

5935

# CommuteFilter.

5936

#

5937

# Commute details related to this job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5938

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

5939

#

5940

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5941

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

5942

# such as postal delivery and payments addresses. Given a postal address,

5943

# a postal service can deliver items to a premises, P.O. Box, or other

5944

# delivery location.

5945

# Given a postal address, a postal service can deliver items to a premise, P.O.

5946

# Box or similar.

5947

# It is not intended to model geographical locations (roads, towns,

5948

# mountains).

5949

#

5950

# In typical usage an address would be created via user input or from importing

5951

# existing data, depending on the type of process.

5952

#

5953

# Advice on address input / editing:

5954

# - Use an i18n-ready address widget such as

5955

# https://github.com/google/libaddressinput)

5956

# - Users should not be presented with UI elements for input or editing of

5957

# fields outside countries where that field is used.

5958

#

5959

# For more guidance on how to use this schema, please see:

5960

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5961

"organization": "A String", # Optional. The name of the organization at the address.

5962

"sublocality": "A String", # Optional. Sublocality of the address.

5963

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5964

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

5965

# known). This is often the UI language of the input form or is expected

5966

# to match one of the languages used in the address' country/region, or their

5967

# transliterated equivalents.

5968

# This can affect formatting in certain countries, but is not critical

5969

# to the correctness of the data and will never affect any validation or

5970

# other non-formatting related operations.

5971

#

5972

# If this value is not known, it should be omitted (rather than specifying a

5973

# possibly incorrect default).

5974

#

5975

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5976

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

5977

# addresses of a country or region.

5978

# For example, this can be a state, a province, an oblast, or a prefecture.

5979

# Specifically, for Spain this is the province and not the autonomous

5980

# community (e.g. "Barcelona" and not "Catalonia").

5981

# Many countries don't use an administrative area in postal addresses. E.g.

5982

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5983

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

5984

# Examples: US city, IT comune, UK post town.

5985

# In regions of the world where localities are not well defined or do not fit

5986

# into this structure well, leave locality empty and use address_lines.

5987

"recipients": [ # Optional. The recipient at the address.

5988

# This field may, under certain circumstances, contain multiline information.

5989

# For example, it might contain "care of" information.

5990

"A String",

5991

],

5992

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

5993

# the latest revision.

5994

#

5995

# All new revisions **must** be backward compatible with old revisions.

5996

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

5997

# postal codes to be present, but where they are used, they may trigger

5998

# additional validation with other parts of the address (e.g. state/zip

5999

# validation in the U.S.A.).

6000

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

6001

# in most regions. Where it is used, the value is either a string like

6002

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

6003

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

6004

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

6005

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

6006

# is never inferred and it is up to the user to ensure the value is

6007

# correct. See http://cldr.unicode.org/ and

6008

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6009

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6010

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

6011

#

6012

# Because values in address_lines do not have type information and may

6013

# sometimes contain multiple values in a single field (e.g.

6014

# "Austin, TX"), it is important that the line order is clear. The order of

6015

# address lines should be "envelope order" for the country/region of the

6016

# address. In places where this can vary (e.g. Japan), address_language is

6017

# used to make it explicit (e.g. "ja" for large-to-small ordering and

6018

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

6019

# an address can be selected based on the language.

6020

#

6021

# The minimum permitted structural representation of an address consists

6022

# of a region_code with all remaining information placed in the

6023

# address_lines. It would be possible to format such an address very

6024

# approximately without geocoding, but no semantic reasoning could be

6025

# made about any of the address components until it was at least

6026

# partially resolved.

6027

#

6028

# Creating an address only containing a region_code and address_lines, and

6029

# then geocoding is the recommended way to handle completely unstructured

6030

# addresses (as opposed to guessing which parts of the address should be

6031

# localities or administrative areas).

6032

"A String",

6033

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6034

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6035

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

6036

# location bounding box in which a circle with the specified radius

6037

# centered from LatLng covers the area associated with the job location.

6038

# For example, currently, "Mountain View, CA, USA" has a radius of

6039

# 6.17 miles.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6040

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

6041

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

6042

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

6043

# LocationType#LOCALITY.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6044

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

6045

# of doubles representing degrees latitude and degrees longitude. Unless

6046

# specified otherwise, this must conform to the

6047

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6048

# standard</a>. Values must be within normalized ranges.

6049

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6050

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6051

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6052

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6053

"travelDuration": "A String", # The number of seconds required to travel to the job location from the

6054

# query location. A duration of 0 seconds indicates that the job is not

6055

# reachable within the requested duration, but was returned as part of an

6056

# expanded query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6057

},

6058

},

6059

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6060

"broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the

6061

# broadened query. This number indicates how many of the jobs returned in the

6062

# jobs field are from the broadened query. These results are always at the

6063

# end of the jobs list. In particular, a value of 0, or if the field isn't

6064

# set, all the jobs in the jobs list are from the original

6065

# (without broadening) query. If this field is non-zero, subsequent requests

6066

# with offset after this result set should contain all broadened results.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6067

"locationFilters": [ # The location filters that the service applied to the specified query. If

6068

# any filters are lat-lng based, the JobLocation.location_type is

6069

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

6070

{ # Output only.

6071

#

6072

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6073

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

6074

# such as postal delivery and payments addresses. Given a postal address,

6075

# a postal service can deliver items to a premises, P.O. Box, or other

6076

# delivery location.

6077

# Given a postal address, a postal service can deliver items to a premise, P.O.

6078

# Box or similar.

6079

# It is not intended to model geographical locations (roads, towns,

6080

# mountains).

6081

#

6082

# In typical usage an address would be created via user input or from importing

6083

# existing data, depending on the type of process.

6084

#

6085

# Advice on address input / editing:

6086

# - Use an i18n-ready address widget such as

6087

# https://github.com/google/libaddressinput)

6088

# - Users should not be presented with UI elements for input or editing of

6089

# fields outside countries where that field is used.

6090

#

6091

# For more guidance on how to use this schema, please see:

6092

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6093

"organization": "A String", # Optional. The name of the organization at the address.

6094

"sublocality": "A String", # Optional. Sublocality of the address.

6095

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6096

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

6097

# known). This is often the UI language of the input form or is expected

6098

# to match one of the languages used in the address' country/region, or their

6099

# transliterated equivalents.

6100

# This can affect formatting in certain countries, but is not critical

6101

# to the correctness of the data and will never affect any validation or

6102

# other non-formatting related operations.

6103

#

6104

# If this value is not known, it should be omitted (rather than specifying a

6105

# possibly incorrect default).

6106

#

6107

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6108

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

6109

# addresses of a country or region.

6110

# For example, this can be a state, a province, an oblast, or a prefecture.

6111

# Specifically, for Spain this is the province and not the autonomous

6112

# community (e.g. "Barcelona" and not "Catalonia").

6113

# Many countries don't use an administrative area in postal addresses. E.g.

6114

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6115

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

6116

# Examples: US city, IT comune, UK post town.

6117

# In regions of the world where localities are not well defined or do not fit

6118

# into this structure well, leave locality empty and use address_lines.

6119

"recipients": [ # Optional. The recipient at the address.

6120

# This field may, under certain circumstances, contain multiline information.

6121

# For example, it might contain "care of" information.

6122

"A String",

6123

],

6124

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

6125

# the latest revision.

6126

#

6127

# All new revisions **must** be backward compatible with old revisions.

6128

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

6129

# postal codes to be present, but where they are used, they may trigger

6130

# additional validation with other parts of the address (e.g. state/zip

6131

# validation in the U.S.A.).

6132

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

6133

# in most regions. Where it is used, the value is either a string like

6134

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

6135

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

6136

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

6137

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

6138

# is never inferred and it is up to the user to ensure the value is

6139

# correct. See http://cldr.unicode.org/ and

6140

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6141

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6142

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

6143

#

6144

# Because values in address_lines do not have type information and may

6145

# sometimes contain multiple values in a single field (e.g.

6146

# "Austin, TX"), it is important that the line order is clear. The order of

6147

# address lines should be "envelope order" for the country/region of the

6148

# address. In places where this can vary (e.g. Japan), address_language is

6149

# used to make it explicit (e.g. "ja" for large-to-small ordering and

6150

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

6151

# an address can be selected based on the language.

6152

#

6153

# The minimum permitted structural representation of an address consists

6154

# of a region_code with all remaining information placed in the

6155

# address_lines. It would be possible to format such an address very

6156

# approximately without geocoding, but no semantic reasoning could be

6157

# made about any of the address components until it was at least

6158

# partially resolved.

6159

#

6160

# Creating an address only containing a region_code and address_lines, and

6161

# then geocoding is the recommended way to handle completely unstructured

6162

# addresses (as opposed to guessing which parts of the address should be

6163

# localities or administrative areas).

6164

"A String",

6165

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6166

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6167

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

6168

# location bounding box in which a circle with the specified radius

6169

# centered from LatLng covers the area associated with the job location.

6170

# For example, currently, "Mountain View, CA, USA" has a radius of

6171

# 6.17 miles.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6172

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

6173

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

6174

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

6175

# LocationType#LOCALITY.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6176

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

6177

# of doubles representing degrees latitude and degrees longitude. Unless

6178

# specified otherwise, this must conform to the

6179

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6180

# standard</a>. Values must be within normalized ranges.

6181

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6182

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6183

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6184

},

6185

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

6186

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

6187

# This field is empty if there are no more results.

6188

"metadata": { # Output only. # Additional information for the API invocation, such as the request

6189

# tracking id.

6190

#

6191

# Additional information returned to client, such as debugging information.

6192

"requestId": "A String", # A unique id associated with this call.

6193

# This id is logged for tracking purposes.

6194

},

6195

"histogramResults": { # Output only. # The histogram results that match specified

6196

# SearchJobsRequest.histogram_facets.

6197

#

6198

# Histogram results that match HistogramFacets specified in

6199

# SearchJobsRequest.

6200

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that match

6201

# HistogramFacets.compensation_histogram_requests.

6202

{ # Output only.

6203

#

6204

# Compensation based histogram result.

6205

"result": { # Output only. # Histogram result.

6206

#

6207

# Custom numeric bucketing result.

6208

"counts": [ # Count within each bucket. Its size is the length of

6209

# NumericBucketingOption.bucket_bounds plus 1.

6210

{ # Represents count of jobs within one bucket.

6211

"count": 42, # Number of jobs whose numeric field value fall into `range`.

6212

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

6213

# that is, the count represents number of jobs in this range.

6214

"to": 3.14, # Ending value of the bucket range.

6215

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

6220

# [NumericBucketingOption.requires_min_max] is set to true.

6221

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

6222

# [NumericBucketingOption.requires_min_max] is set to true.

6223

},

6224

"type": "A String", # Type of the request, corresponding to

6225

# CompensationHistogramRequest.type.

6226

},

6227

],

6228

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match

6229

# HistogramFacets.custom_attribute_histogram_facets.

6230

{ # Output only.

6231

#

6232

# Custom attribute histogram result.

6233

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

6234

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

6235

# custom attribute long values associated with `key`.

6236

#

6237

# Custom numeric bucketing result.

6238

"counts": [ # Count within each bucket. Its size is the length of

6239

# NumericBucketingOption.bucket_bounds plus 1.

6240

{ # Represents count of jobs within one bucket.

6241

"count": 42, # Number of jobs whose numeric field value fall into `range`.

6242

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

6243

# that is, the count represents number of jobs in this range.

6244

"to": 3.14, # Ending value of the bucket range.

6245

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

6250

# [NumericBucketingOption.requires_min_max] is set to true.

6251

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

6252

# [NumericBucketingOption.requires_min_max] is set to true.

6253

},

6254

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

6255

# with `key` to the number of jobs with that value in this histogram result.

"a_key": 42,

},

},

],

"simpleHistogramResults": [ # Specifies histogram results that matches

6261

# HistogramFacets.simple_histogram_facets.

6262

{ # Output only.

6263

#

6264

# Result of a histogram call. The response contains the histogram map for the

6265

# search type specified by HistogramResult.field.

6266

# The response is a map of each filter value to the corresponding count of

6267

# jobs for that filter.

6268

"values": { # A map from the values of field to the number of jobs with that value

6269

# in this search result.

6270

#

6271

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

6272

#

6273

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

6274

"a_key": 42,

6275

},

6276

"searchType": "A String", # The Histogram search filters.

},

],

},

"estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.

6281

#

6282

# This number is not guaranteed to be accurate. For accurate results,

6283

# see enable_precise_result_size.

6284

"totalSize": 42, # The precise result count, which is available only if the client set

6285

# enable_precise_result_size to `true`, or if the response

6286

# is the last page of results. Otherwise, the value is `-1`.

6287

"spellCorrection": { # Output only. # The spell checking result, and correction.

6288

#

6289

# Spell check result.

6290

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

6291

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

6292

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code>

6298

<pre>Retrieves the next page of results.

6299

6300

Args:

6301

previous_request: The request for the previous page. (required)

6302

previous_response: The response from the request for the previous page. (required)

6303

6304

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6305

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6306

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="search_next">search_next(previous_request, previous_response)</code>

6312

<pre>Retrieves the next page of results.

6313

6314

Args:

6315

previous_request: The request for the previous page. (required)

6316

previous_response: The response from the request for the previous page. (required)

6317

6318

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6319

A request object that you can call 'execute()' on to request the next

Bu Sun Kim