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

<h1><a href="jobs_v3.html">Cloud Talent Solution API</a> . <a href="jobs_v3.projects.html">projects</a> . <a href="jobs_v3.projects.jobs.html">jobs</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#batchDelete">batchDelete(parent, body, x__xgafv=None)</a></code></p>

79

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

80

81

<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>

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

90

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

91

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

92

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

96

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

97

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

98

99

<code><a href="#search">search(parent, body, x__xgafv=None)</a></code></p>

100

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

101

102

<code><a href="#searchForAlert">searchForAlert(parent, body, x__xgafv=None)</a></code></p>

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

112

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

113

<pre>Deletes a list of Jobs by filter.

114

115

Args:

116

parent: string, Required.

117

118

The resource name of the project under which the job is created.

119

120

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

121

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

122

body: object, The request body. (required)

123

The object takes the form of:

{ # Input only.

#

# Batch delete jobs request.

128

"filter": "A String", # Required.

129

#

130

# The filter string specifies the jobs to be deleted.

131

#

132

# Supported operator: =, AND

133

#

134

# The fields eligible for filtering are:

135

#

136

# * `companyName` (Required)

137

# * `requisitionId` (Required)

138

#

139

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

140

# requisitionId = "req-1"

141

}

142

143

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

150

151

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

152

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

153

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

154

#

155

# service Foo {

156

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

157

# }

158

#

159

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

}</pre>

</div>

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

165

<pre>Creates a new job.

166

167

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

up to 5 minutes.

Args:

parent: string, Required.

172

173

The resource name of the project under which the job is created.

174

175

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

176

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

177

body: object, The request body. (required)

178

The object takes the form of:

{ # Input only.

#

# Create job request.

183

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

184

#

185

# The Job to be created.

186

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

187

# entity responsible for the job.

188

"languageCode": "A String", # Optional.

189

#

190

# The language of the posting. This field is distinct from

191

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

192

#

193

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

194

# For more information, see

195

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

196

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

197

#

198

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

199

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

200

# defaults to 'en_US'.

201

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

202

#

203

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

204

#

205

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

206

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

207

#

208

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

209

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

210

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

211

# multiple jobs with the same company_name, language_code and

212

# requisition_id are not allowed. If the original requisition_id must

213

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

214

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

215

# for better search experience.

216

#

217

# The maximum number of allowed characters is 500.

218

"A String",

219

],

220

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

221

"promotionValue": 42, # Optional.

222

#

223

# A promotion value of the job, as determined by the client.

224

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

225

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

226

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

227

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

228

#

229

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

230

"employmentTypes": [ # Optional.

231

#

232

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

238

#

239

# The end timestamp of the job. Typically this field is used for contracting

240

# engagements. Invalid timestamps are ignored.

241

"description": "A String", # Required.

242

#

243

# The description of the job, which typically includes a multi-paragraph

244

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

245

# provided on the job object for responsibilities,

246

# qualifications, and other job characteristics. Use of

247

# these separate job fields is recommended.

248

#

249

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

250

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

251

#

252

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

253

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

254

# experience.

255

#

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

# language_code and requisition_id.

264

#

265

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

266

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

267

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

268

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

269

# out.

270

#

271

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

272

#

273

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

274

# will be treated as expired immediately.

275

#

276

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

277

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

278

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

279

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

280

#

281

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

282

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

283

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

284

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

285

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

286

"title": "A String", # Required.

287

#

288

# The title of the job, such as "Software Engineer"

289

#

290

# The maximum number of allowed characters is 500.

291

"responsibilities": "A String", # Optional.

292

#

293

# A description of job responsibilities. The use of this field is

294

# recommended as an alternative to using the more general description

295

# field.

296

#

297

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

298

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

299

#

300

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

301

"jobStartTime": "A String", # Optional.

302

#

303

# The start timestamp of the job in UTC time zone. Typically this field

304

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

305

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

306

#

307

# Job compensation information.

308

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

309

# all compensation entries' CompensationEntry.compensation times

310

# CompensationEntry.expected_units_per_year.

311

#

312

# See CompensationEntry for explanation on compensation annualization.

313

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

314

#

315

# The minimum amount of compensation. If left empty, the value is set

316

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

317

# currency code of max_compensation.

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

},

328

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

329

#

330

# The maximum amount of compensation. If left empty, the value is set

331

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

332

# match the currency code of

333

# min_compensation.

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

},

344

},

345

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

346

# base compensation entry's CompensationEntry.compensation times

347

# CompensationEntry.expected_units_per_year.

348

#

349

# See CompensationEntry for explanation on compensation annualization.

350

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

351

#

352

# The minimum amount of compensation. If left empty, the value is set

353

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

354

# currency code of max_compensation.

355

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

356

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

357

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

358

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

359

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

360

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

361

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

362

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

363

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

364

},

365

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

366

#

367

# The maximum amount of compensation. If left empty, the value is set

368

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

369

# match the currency code of

370

# min_compensation.

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

},

381

},

382

"entries": [ # Optional.

383

#

384

# Job compensation information.

385

#

386

# At most one entry can be of type

387

# CompensationInfo.CompensationType.BASE, which is

388

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

389

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

390

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

391

#

392

# Annualization: One compensation entry can be annualized if

393

# - it contains valid amount or range.

394

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

395

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

396

# expected_units_per_year.

397

"description": "A String", # Optional.

398

#

399

# Compensation description. For example, could

400

# indicate equity terms or provide additional context to an estimated

401

# bonus.

402

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

403

#

404

# Compensation range.

405

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

406

#

407

# The minimum amount of compensation. If left empty, the value is set

408

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

409

# currency code of max_compensation.

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

},

420

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

421

#

422

# The maximum amount of compensation. If left empty, the value is set

423

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

424

# match the currency code of

425

# min_compensation.

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

},

436

},

437

"expectedUnitsPerYear": 3.14, # Optional.

438

#

439

# Expected number of units paid each year. If not specified, when

440

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

441

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

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

448

#

449

# Compensation amount.

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

},

460

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

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

465

"unit": "A String", # Optional.

466

#

467

# Frequency of the specified amount.

468

#

469

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

474

#

475

# The department or functional area within the company with the open

476

# position.

477

#

478

# The maximum number of allowed characters is 255.

479

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

480

"requisitionId": "A String", # Required.

481

#

482

# The requisition ID, also referred to as the posting ID, assigned by the

483

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

484

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

485

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

486

# language_code and requisition_id.

487

#

488

# The maximum number of allowed characters is 255.

489

"postingPublishTime": "A String", # Optional.

490

#

491

# The timestamp this job posting was most recently published. The default

492

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

493

# ignored.

494

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

495

#

496

# Job application information.

497

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

498

# emails or instruction must be

499

# specified.

500

#

501

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

502

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

503

#

504

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

505

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

506

#

507

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

508

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

509

# emails or instruction must be

510

# specified.

511

#

512

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

513

# applications can be sent.

514

#

515

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

516

"A String",

517

],

518

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

519

# emails or instruction must be

520

# specified.

521

#

522

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

523

# link to an online application form.

524

#

525

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

"A String",

],

},

"companyName": "A String", # Required.

530

#

531

# The resource name of the company listing the job, such as

532

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

533

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

534

#

535

# Derived details about the job posting.

536

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

537

"A String",

538

],

539

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

540

#

541

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

# order.

{ # Output only.

#

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

546

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

547

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

548

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

549

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

550

# 6.17 miles.

551

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

552

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

553

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

554

# LocationType#LOCALITY.

555

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

556

# of doubles representing degrees latitude and degrees longitude. Unless

557

# specified otherwise, this must conform to the

558

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

559

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

560

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

561

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

562

},

563

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

564

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

565

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

566

# delivery location.

567

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

568

# Box or similar.

569

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

570

# mountains).

571

#

572

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

573

# existing data, depending on the type of process.

574

#

575

# Advice on address input / editing:

576

# - Use an i18n-ready address widget such as

577

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

578

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

579

# fields outside countries where that field is used.

580

#

581

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

582

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

583

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

584

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

585

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

586

# transliterated equivalents.

587

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

588

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

589

# other non-formatting related operations.

590

#

591

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

592

# possibly incorrect default).

593

#

594

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

595

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

596

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

597

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

598

"A String",

599

],

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

# addresses of a country or region.

616

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

617

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

618

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

619

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

620

# in Switzerland this should be left unpopulated.

621

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

622

#

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

# an address can be selected based on the language.

631

#

632

# The minimum permitted structural representation of an address consists

633

# of a region_code with all remaining information placed in the

634

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

635

# approximately without geocoding, but no semantic reasoning could be

636

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

637

# partially resolved.

638

#

639

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

640

# then geocoding is the recommended way to handle completely unstructured

641

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

642

# localities or administrative areas).

643

"A String",

644

],

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

# the latest revision.

654

#

655

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

},

},

],

},

"incentives": "A String", # Optional.

661

#

662

# A description of bonus, commission, and other compensation

663

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

664

#

665

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

666

"jobBenefits": [ # Optional.

667

#

668

# The benefits included with the job.

669

"A String",

670

],

671

"qualifications": "A String", # Optional.

672

#

673

# A description of the qualifications required to perform the

674

# job. The use of this field is recommended

675

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

676

#

677

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

678

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

679

#

680

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

681

"visibility": "A String", # Optional.

682

#

683

# The visibility of the job.

684

#

685

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

686

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

687

"postingRegion": "A String", # Optional.

688

#

689

# The job PostingRegion (for example, state, country) throughout which

690

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

691

# LocationFilter in a search query within the job region

692

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

693

# If this field is set to PostingRegion.NATION or

694

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

695

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

696

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

697

#

698

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

699

# job is created.

700

#

701

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

702

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

703

#

704

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

705

# requisition_id since this value is unique.

706

"processingOptions": { # Input only. # Optional.

707

#

708

# Options for job processing.

709

#

710

# Options for job processing.

711

"htmlSanitization": "A String", # Optional.

712

#

713

# Option for job HTML content sanitization. Applied fields are:

714

#

715

# * description

716

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

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

722

# disabled.

723

#

724

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

725

"disableStreetAddressResolution": True or False, # Optional.

726

#

727

# If set to `true`, the service does not attempt to resolve a

728

# more precise address for the job.

729

},

730

"degreeTypes": [ # Optional.

731

#

732

# The desired education degrees for the job, such as Bachelors, Masters.

733

"A String",

734

],

735

"customAttributes": { # Optional.

736

#

737

# A map of fields to hold both filterable and non-filterable custom job

738

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

739

#

740

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

741

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

742

# KEY_1_LIKE_THIS.

743

#

744

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

745

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

746

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

747

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

748

# is 50KB.

749

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

750

"filterable": True or False, # Optional.

751

#

752

# If the `filterable` flag is true, custom field values are searchable.

753

# If false, values are not searchable.

754

#

755

# Default is false.

756

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

757

# be specified.

758

#

759

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

760

# `CASE_INSENSITIVE_MATCH`) search.

761

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

762

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

763

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

764

# unfilterable `string_values` is 50KB.

765

#

766

# Empty string is not allowed.

767

"A String",

768

],

769

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

770

# be specified.

771

#

772

# This field is used to perform number range search.

773

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

774

#

775

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

781

#

782

# The experience level associated with the job, such as "Entry Level".

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

793

794

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

795

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

796

# entity responsible for the job.

797

"languageCode": "A String", # Optional.

798

#

799

# The language of the posting. This field is distinct from

800

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

801

#

802

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

803

# For more information, see

804

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

805

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

806

#

807

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

808

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

809

# defaults to 'en_US'.

810

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

811

#

812

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

813

#

814

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

815

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

816

#

817

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

818

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

819

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

820

# multiple jobs with the same company_name, language_code and

821

# requisition_id are not allowed. If the original requisition_id must

822

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

823

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

824

# for better search experience.

825

#

826

# The maximum number of allowed characters is 500.

827

"A String",

828

],

829

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

830

"promotionValue": 42, # Optional.

831

#

832

# A promotion value of the job, as determined by the client.

833

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

834

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

835

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

836

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

837

#

838

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

839

"employmentTypes": [ # Optional.

840

#

841

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

847

#

848

# The end timestamp of the job. Typically this field is used for contracting

849

# engagements. Invalid timestamps are ignored.

850

"description": "A String", # Required.

851

#

852

# The description of the job, which typically includes a multi-paragraph

853

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

854

# provided on the job object for responsibilities,

855

# qualifications, and other job characteristics. Use of

856

# these separate job fields is recommended.

857

#

858

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

859

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

860

#

861

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

862

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

863

# experience.

864

#

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

# language_code and requisition_id.

873

#

874

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

875

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

876

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

877

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

878

# out.

879

#

880

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

881

#

882

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

883

# will be treated as expired immediately.

884

#

885

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

886

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

887

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

888

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

889

#

890

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

891

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

892

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

893

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

894

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

895

"title": "A String", # Required.

896

#

897

# The title of the job, such as "Software Engineer"

898

#

899

# The maximum number of allowed characters is 500.

900

"responsibilities": "A String", # Optional.

901

#

902

# A description of job responsibilities. The use of this field is

903

# recommended as an alternative to using the more general description

904

# field.

905

#

906

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

907

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

908

#

909

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

910

"jobStartTime": "A String", # Optional.

911

#

912

# The start timestamp of the job in UTC time zone. Typically this field

913

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

914

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

915

#

916

# Job compensation information.

917

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

918

# all compensation entries' CompensationEntry.compensation times

919

# CompensationEntry.expected_units_per_year.

920

#

921

# See CompensationEntry for explanation on compensation annualization.

922

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

923

#

924

# The minimum amount of compensation. If left empty, the value is set

925

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

926

# currency code of max_compensation.

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

},

937

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

938

#

939

# The maximum amount of compensation. If left empty, the value is set

940

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

941

# match the currency code of

942

# min_compensation.

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

},

953

},

954

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

955

# base compensation entry's CompensationEntry.compensation times

956

# CompensationEntry.expected_units_per_year.

957

#

958

# See CompensationEntry for explanation on compensation annualization.

959

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

960

#

961

# The minimum amount of compensation. If left empty, the value is set

962

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

963

# currency code of max_compensation.

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

},

974

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

975

#

976

# The maximum amount of compensation. If left empty, the value is set

977

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

978

# match the currency code of

979

# min_compensation.

980

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

981

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

982

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

983

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

984

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

985

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

986

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

987

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

988

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

989

},

990

},

991

"entries": [ # Optional.

992

#

993

# Job compensation information.

994

#

995

# At most one entry can be of type

996

# CompensationInfo.CompensationType.BASE, which is

997

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

998

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

999

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

1000

#

1001

# Annualization: One compensation entry can be annualized if

1002

# - it contains valid amount or range.

1003

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

1004

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

1005

# expected_units_per_year.

1006

"description": "A String", # Optional.

1007

#

1008

# Compensation description. For example, could

1009

# indicate equity terms or provide additional context to an estimated

1010

# bonus.

1011

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

1012

#

1013

# Compensation range.

1014

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

1015

#

1016

# The minimum amount of compensation. If left empty, the value is set

1017

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

1018

# currency code of max_compensation.

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

},

1029

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

1030

#

1031

# The maximum amount of compensation. If left empty, the value is set

1032

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

1033

# match the currency code of

1034

# min_compensation.

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

},

1045

},

1046

"expectedUnitsPerYear": 3.14, # Optional.

1047

#

1048

# Expected number of units paid each year. If not specified, when

1049

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

1050

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

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

1057

#

1058

# Compensation amount.

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

},

1069

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

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

1074

"unit": "A String", # Optional.

1075

#

1076

# Frequency of the specified amount.

1077

#

1078

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

1083

#

1084

# The department or functional area within the company with the open

1085

# position.

1086

#

1087

# The maximum number of allowed characters is 255.

1088

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

1089

"requisitionId": "A String", # Required.

1090

#

1091

# The requisition ID, also referred to as the posting ID, assigned by the

1092

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

1093

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

1094

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

1095

# language_code and requisition_id.

1096

#

1097

# The maximum number of allowed characters is 255.

1098

"postingPublishTime": "A String", # Optional.

1099

#

1100

# The timestamp this job posting was most recently published. The default

1101

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

1102

# ignored.

1103

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

1104

#

1105

# Job application information.

1106

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

1107

# emails or instruction must be

1108

# specified.

1109

#

1110

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

1111

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

1112

#

1113

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

1114

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

1115

#

1116

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

1117

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

1118

# emails or instruction must be

1119

# specified.

1120

#

1121

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

1122

# applications can be sent.

1123

#

1124

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

1125

"A String",

1126

],

1127

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

1128

# emails or instruction must be

1129

# specified.

1130

#

1131

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

1132

# link to an online application form.

1133

#

1134

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

"A String",

],

},

"companyName": "A String", # Required.

1139

#

1140

# The resource name of the company listing the job, such as

1141

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

1142

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

1143

#

1144

# Derived details about the job posting.

1145

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

1146

"A String",

1147

],

1148

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

1149

#

1150

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

# order.

{ # Output only.

#

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

1155

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

1156

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

1157

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

1158

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

1159

# 6.17 miles.

1160

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

1161

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

1162

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

1163

# LocationType#LOCALITY.

1164

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

1165

# of doubles representing degrees latitude and degrees longitude. Unless

1166

# specified otherwise, this must conform to the

1167

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

1168

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

1169

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

1170

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

1171

},

1172

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

1173

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

1174

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

1175

# delivery location.

1176

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

1177

# Box or similar.

1178

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

1179

# mountains).

1180

#

1181

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

1182

# existing data, depending on the type of process.

1183

#

1184

# Advice on address input / editing:

1185

# - Use an i18n-ready address widget such as

1186

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

1187

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

1188

# fields outside countries where that field is used.

1189

#

1190

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

1191

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

1192

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

1193

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

1194

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

1195

# transliterated equivalents.

1196

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

1197

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

1198

# other non-formatting related operations.

1199

#

1200

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

1201

# possibly incorrect default).

1202

#

1203

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

1204

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

1205

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

1206

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

1207

"A String",

1208

],

1209

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

1210

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

1211

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

1212

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

1213

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

1214

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

1215

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

1216

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

1217

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

1218

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

1219

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

1220

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

1221

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

1222

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

1223

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

1224

# addresses of a country or region.

1225

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

1226

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

1227

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

1228

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

1229

# in Switzerland this should be left unpopulated.

1230

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

1231

#

1232

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

1233

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

1234

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

1235

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

1236

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

1237

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

1238

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

1239

# an address can be selected based on the language.

1240

#

1241

# The minimum permitted structural representation of an address consists

1242

# of a region_code with all remaining information placed in the

1243

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

1244

# approximately without geocoding, but no semantic reasoning could be

1245

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

1246

# partially resolved.

1247

#

1248

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

1249

# then geocoding is the recommended way to handle completely unstructured

1250

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

1251

# localities or administrative areas).

1252

"A String",

1253

],

1254

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

1255

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

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

# the latest revision.

1263

#

1264

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

},

},

],

},

"incentives": "A String", # Optional.

1270

#

1271

# A description of bonus, commission, and other compensation

1272

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

1273

#

1274

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

1275

"jobBenefits": [ # Optional.

1276

#

1277

# The benefits included with the job.

1278

"A String",

1279

],

1280

"qualifications": "A String", # Optional.

1281

#

1282

# A description of the qualifications required to perform the

1283

# job. The use of this field is recommended

1284

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

1285

#

1286

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

1287

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

1288

#

1289

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

1290

"visibility": "A String", # Optional.

1291

#

1292

# The visibility of the job.

1293

#

1294

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

1295

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

1296

"postingRegion": "A String", # Optional.

1297

#

1298

# The job PostingRegion (for example, state, country) throughout which

1299

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

1300

# LocationFilter in a search query within the job region

1301

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

1302

# If this field is set to PostingRegion.NATION or

1303

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

1304

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

1305

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

1306

#

1307

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

1308

# job is created.

1309

#

1310

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

1311

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

1312

#

1313

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

1314

# requisition_id since this value is unique.

1315

"processingOptions": { # Input only. # Optional.

1316

#

1317

# Options for job processing.

1318

#

1319

# Options for job processing.

1320

"htmlSanitization": "A String", # Optional.

1321

#

1322

# Option for job HTML content sanitization. Applied fields are:

1323

#

1324

# * description

1325

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

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

1331

# disabled.

1332

#

1333

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

1334

"disableStreetAddressResolution": True or False, # Optional.

1335

#

1336

# If set to `true`, the service does not attempt to resolve a

1337

# more precise address for the job.

1338

},

1339

"degreeTypes": [ # Optional.

1340

#

1341

# The desired education degrees for the job, such as Bachelors, Masters.

1342

"A String",

1343

],

1344

"customAttributes": { # Optional.

1345

#

1346

# A map of fields to hold both filterable and non-filterable custom job

1347

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

1348

#

1349

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

1350

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

1351

# KEY_1_LIKE_THIS.

1352

#

1353

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

1354

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

1355

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

1356

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

1357

# is 50KB.

1358

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

1359

"filterable": True or False, # Optional.

1360

#

1361

# If the `filterable` flag is true, custom field values are searchable.

1362

# If false, values are not searchable.

1363

#

1364

# Default is false.

1365

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

1366

# be specified.

1367

#

1368

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

1369

# `CASE_INSENSITIVE_MATCH`) search.

1370

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

1371

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

1372

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

1373

# unfilterable `string_values` is 50KB.

1374

#

1375

# Empty string is not allowed.

1376

"A String",

1377

],

1378

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

1379

# be specified.

1380

#

1381

# This field is used to perform number range search.

1382

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

1383

#

1384

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

1390

#

1391

# The experience level associated with the job, such as "Entry Level".

}</pre>

</div>

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

1397

<pre>Deletes the specified job.

1398

1399

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

up to 5 minutes.

Args:

The resource name of the job to be deleted.

1406

1407

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

1408

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

1409

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1416

1417

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

1418

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

1419

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

1420

#

1421

# service Foo {

1422

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

1423

# }

1424

#

1425

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

}</pre>

</div>

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

1431

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

1432

within the last 90 days.

Args:

The resource name of the job to retrieve.

1438

1439

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

1440

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

1441

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1448

1449

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

1450

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

1451

# entity responsible for the job.

1452

"languageCode": "A String", # Optional.

1453

#

1454

# The language of the posting. This field is distinct from

1455

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

1456

#

1457

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

1458

# For more information, see

1459

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

1460

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

1461

#

1462

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

1463

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

1464

# defaults to 'en_US'.

1465

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

1466

#

1467

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

1468

#

1469

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

1470

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

1471

#

1472

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

1473

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

1474

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

1475

# multiple jobs with the same company_name, language_code and

1476

# requisition_id are not allowed. If the original requisition_id must

1477

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

1478

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

1479

# for better search experience.

1480

#

1481

# The maximum number of allowed characters is 500.

1482

"A String",

1483

],

1484

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

1485

"promotionValue": 42, # Optional.

1486

#

1487

# A promotion value of the job, as determined by the client.

1488

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

1489

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

1490

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

1491

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

1492

#

1493

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

1494

"employmentTypes": [ # Optional.

1495

#

1496

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

1502

#

1503

# The end timestamp of the job. Typically this field is used for contracting

1504

# engagements. Invalid timestamps are ignored.

1505

"description": "A String", # Required.

1506

#

1507

# The description of the job, which typically includes a multi-paragraph

1508

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

1509

# provided on the job object for responsibilities,

1510

# qualifications, and other job characteristics. Use of

1511

# these separate job fields is recommended.

1512

#

1513

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

1514

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

1515

#

1516

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

1517

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

1518

# experience.

1519

#

1520

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

1521

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

1522

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

1523

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

1524

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

1525

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

1526

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

1527

# language_code and requisition_id.

1528

#

1529

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

1530

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

1531

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

1532

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

1533

# out.

1534

#

1535

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

1536

#

1537

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

1538

# will be treated as expired immediately.

1539

#

1540

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

1541

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

1542

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

1543

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

1544

#

1545

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

1546

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

1547

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

1548

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

1549

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

1550

"title": "A String", # Required.

1551

#

1552

# The title of the job, such as "Software Engineer"

1553

#

1554

# The maximum number of allowed characters is 500.

1555

"responsibilities": "A String", # Optional.

1556

#

1557

# A description of job responsibilities. The use of this field is

1558

# recommended as an alternative to using the more general description

1559

# field.

1560

#

1561

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

1562

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

1563

#

1564

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

1565

"jobStartTime": "A String", # Optional.

1566

#

1567

# The start timestamp of the job in UTC time zone. Typically this field

1568

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

1569

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

1570

#

1571

# Job compensation information.

1572

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

1573

# all compensation entries' CompensationEntry.compensation times

1574

# CompensationEntry.expected_units_per_year.

1575

#

1576

# See CompensationEntry for explanation on compensation annualization.

1577

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

1578

#

1579

# The minimum amount of compensation. If left empty, the value is set

1580

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

1581

# currency code of max_compensation.

1582

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

1583

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

1584

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

1585

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

1586

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

1587

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

1588

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

1589

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

1590

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

1591

},

1592

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

1593

#

1594

# The maximum amount of compensation. If left empty, the value is set

1595

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

1596

# match the currency code of

1597

# min_compensation.

1598

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

1599

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

1600

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

1601

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

1602

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

1603

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

1604

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

1605

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

1606

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

1607

},

1608

},

1609

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

1610

# base compensation entry's CompensationEntry.compensation times

1611

# CompensationEntry.expected_units_per_year.

1612

#

1613

# See CompensationEntry for explanation on compensation annualization.

1614

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

1615

#

1616

# The minimum amount of compensation. If left empty, the value is set

1617

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

1618

# currency code of max_compensation.

1619

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

1620

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

1621

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

1622

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

1623

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

1624

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

1625

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

1626

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

1627

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

1628

},

1629

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

1630

#

1631

# The maximum amount of compensation. If left empty, the value is set

1632

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

1633

# match the currency code of

1634

# min_compensation.

1635

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

1636

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

1637

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

1638

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

1639

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

1640

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

1641

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

1642

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

1643

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

1644

},

1645

},

1646

"entries": [ # Optional.

1647

#

1648

# Job compensation information.

1649

#

1650

# At most one entry can be of type

1651

# CompensationInfo.CompensationType.BASE, which is

1652

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

1653

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

1654

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

1655

#

1656

# Annualization: One compensation entry can be annualized if

1657

# - it contains valid amount or range.

1658

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

1659

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

1660

# expected_units_per_year.

1661

"description": "A String", # Optional.

1662

#

1663

# Compensation description. For example, could

1664

# indicate equity terms or provide additional context to an estimated

1665

# bonus.

1666

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

1667

#

1668

# Compensation range.

1669

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

1670

#

1671

# The minimum amount of compensation. If left empty, the value is set

1672

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

1673

# currency code of max_compensation.

1674

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

1675

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

1676

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

1677

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

1678

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

1679

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

1680

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

1681

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

1682

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

1683

},

1684

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

1685

#

1686

# The maximum amount of compensation. If left empty, the value is set

1687

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

1688

# match the currency code of

1689

# min_compensation.

1690

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

1691

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

1692

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

1693

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

1694

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

1695

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

1696

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

1697

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

1698

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

1699

},

1700

},

1701

"expectedUnitsPerYear": 3.14, # Optional.

1702

#

1703

# Expected number of units paid each year. If not specified, when

1704

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

1705

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

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

1712

#

1713

# Compensation amount.

1714

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

1715

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

1716

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

1717

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

1718

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

1719

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

1720

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

1721

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

1722

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

1723

},

1724

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

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

1729

"unit": "A String", # Optional.

1730

#

1731

# Frequency of the specified amount.

1732

#

1733

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

1738

#

1739

# The department or functional area within the company with the open

1740

# position.

1741

#

1742

# The maximum number of allowed characters is 255.

1743

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

1744

"requisitionId": "A String", # Required.

1745

#

1746

# The requisition ID, also referred to as the posting ID, assigned by the

1747

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

1748

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

1749

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

1750

# language_code and requisition_id.

1751

#

1752

# The maximum number of allowed characters is 255.

1753

"postingPublishTime": "A String", # Optional.

1754

#

1755

# The timestamp this job posting was most recently published. The default

1756

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

1757

# ignored.

1758

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

1759

#

1760

# Job application information.

1761

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

1762

# emails or instruction must be

1763

# specified.

1764

#

1765

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

1766

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

1767

#

1768

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

1769

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

1770

#

1771

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

1772

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

1773

# emails or instruction must be

1774

# specified.

1775

#

1776

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

1777

# applications can be sent.

1778

#

1779

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

1780

"A String",

1781

],

1782

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

1783

# emails or instruction must be

1784

# specified.

1785

#

1786

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

1787

# link to an online application form.

1788

#

1789

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

"A String",

],

},

"companyName": "A String", # Required.

1794

#

1795

# The resource name of the company listing the job, such as

1796

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

1797

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

1798

#

1799

# Derived details about the job posting.

1800

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

1801

"A String",

1802

],

1803

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

1804

#

1805

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

# order.

{ # Output only.

#

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

1810

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

1811

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

1812

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

1813

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

1814

# 6.17 miles.

1815

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

1816

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

1817

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

1818

# LocationType#LOCALITY.

1819

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

1820

# of doubles representing degrees latitude and degrees longitude. Unless

1821

# specified otherwise, this must conform to the

1822

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

1823

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

1824

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

1825

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

1826

},

1827

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

1828

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

1829

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

1830

# delivery location.

1831

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

1832

# Box or similar.

1833

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

1834

# mountains).

1835

#

1836

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

1837

# existing data, depending on the type of process.

1838

#

1839

# Advice on address input / editing:

1840

# - Use an i18n-ready address widget such as

1841

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

1842

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

1843

# fields outside countries where that field is used.

1844

#

1845

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

1846

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

1847

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

1848

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

1849

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

1850

# transliterated equivalents.

1851

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

1852

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

1853

# other non-formatting related operations.

1854

#

1855

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

1856

# possibly incorrect default).

1857

#

1858

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

1859

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

1860

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

1861

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

1862

"A String",

1863

],

1864

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

1865

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

1866

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

1867

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

1868

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

1869

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

1870

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

1871

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

1872

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

1873

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

1874

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

1875

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

1876

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

1877

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

1878

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

1879

# addresses of a country or region.

1880

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

1881

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

1882

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

1883

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

1884

# in Switzerland this should be left unpopulated.

1885

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

1886

#

1887

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

1888

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

1889

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

1890

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

1891

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

1892

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

1893

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

1894

# an address can be selected based on the language.

1895

#

1896

# The minimum permitted structural representation of an address consists

1897

# of a region_code with all remaining information placed in the

1898

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

1899

# approximately without geocoding, but no semantic reasoning could be

1900

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

1901

# partially resolved.

1902

#

1903

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

1904

# then geocoding is the recommended way to handle completely unstructured

1905

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

1906

# localities or administrative areas).

1907

"A String",

1908

],

1909

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

1910

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

1911

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

1912

# validation in the U.S.A.).

1913

"organization": "A String", # Optional. The name of the organization at the address.

1914

"sublocality": "A String", # Optional. Sublocality of the address.

1915

# For example, this can be neighborhoods, boroughs, districts.

1916

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

1917

# the latest revision.

1918

#

1919

# All new revisions **must** be backward compatible with old revisions.

},

},

],

},

"incentives": "A String", # Optional.

1925

#

1926

# A description of bonus, commission, and other compensation

1927

# incentives associated with the job not including salary or pay.

1928

#

1929

# The maximum number of allowed characters is 10,000.

1930

"jobBenefits": [ # Optional.

1931

#

1932

# The benefits included with the job.

1933

"A String",

1934

],

1935

"qualifications": "A String", # Optional.

1936

#

1937

# A description of the qualifications required to perform the

1938

# job. The use of this field is recommended

1939

# as an alternative to using the more general description field.

1940

#

1941

# This field accepts and sanitizes HTML input, and also accepts

1942

# bold, italic, ordered list, and unordered list markup tags.

1943

#

1944

# The maximum number of allowed characters is 10,000.

1945

"visibility": "A String", # Optional.

1946

#

1947

# The visibility of the job.

1948

#

1949

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

1950

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

1951

"postingRegion": "A String", # Optional.

1952

#

1953

# The job PostingRegion (for example, state, country) throughout which

1954

# the job is available. If this field is set, a

1955

# LocationFilter in a search query within the job region

1956

# finds this job posting if an exact location match isn't specified.

1957

# If this field is set to PostingRegion.NATION or

1958

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

1959

# to the same location level as this field is strongly recommended.

1960

"name": "A String", # Required during job update.

1961

#

1962

# The resource name for the job. This is generated by the service when a

1963

# job is created.

1964

#

1965

# The format is "projects/{project_id}/jobs/{job_id}",

1966

# for example, "projects/api-test-project/jobs/1234".

1967

#

1968

# Use of this field in job queries and API calls is preferred over the use of

1969

# requisition_id since this value is unique.

1970

"processingOptions": { # Input only. # Optional.

1971

#

1972

# Options for job processing.

1973

#

1974

# Options for job processing.

1975

"htmlSanitization": "A String", # Optional.

1976

#

1977

# Option for job HTML content sanitization. Applied fields are:

1978

#

1979

# * description

1980

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

1986

# disabled.

1987

#

1988

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

1989

"disableStreetAddressResolution": True or False, # Optional.

1990

#

1991

# If set to `true`, the service does not attempt to resolve a

1992

# more precise address for the job.

1993

},

1994

"degreeTypes": [ # Optional.

1995

#

1996

# The desired education degrees for the job, such as Bachelors, Masters.

1997

"A String",

1998

],

1999

"customAttributes": { # Optional.

2000

#

2001

# A map of fields to hold both filterable and non-filterable custom job

2002

# attributes that are not covered by the provided structured fields.

2003

#

2004

# The keys of the map are strings up to 64 bytes and must match the

2005

# pattern: a-zA-Z*. For example, key0LikeThis or

2006

# KEY_1_LIKE_THIS.

2007

#

2008

# At most 100 filterable and at most 100 unfilterable keys are supported.

2009

# For filterable `string_values`, across all keys at most 200 values are

2010

# allowed, with each string no more than 255 characters. For unfilterable

2011

# `string_values`, the maximum total size of `string_values` across all keys

2012

# is 50KB.

2013

"a_key": { # Custom attribute values that are either filterable or non-filterable.

2014

"filterable": True or False, # Optional.

2015

#

2016

# If the `filterable` flag is true, custom field values are searchable.

2017

# If false, values are not searchable.

2018

#

2019

# Default is false.

2020

"stringValues": [ # Optional but exactly one of string_values or long_values must

2021

# be specified.

2022

#

2023

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

2024

# `CASE_INSENSITIVE_MATCH`) search.

2025

# For filterable `string_value`s, a maximum total number of 200 values

2026

# is allowed, with each `string_value` has a byte size of no more than

2027

# 255B. For unfilterable `string_values`, the maximum total byte size of

2028

# unfilterable `string_values` is 50KB.

2029

#

2030

# Empty string is not allowed.

2031

"A String",

2032

],

2033

"longValues": [ # Optional but exactly one of string_values or long_values must

2034

# be specified.

2035

#

2036

# This field is used to perform number range search.

2037

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

2038

#

2039

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

2045

#

2046

# The experience level associated with the job, such as "Entry Level".

}</pre>

</div>

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, jobView=None, filter=None)</code>

2052

<pre>Lists jobs by filter.

2053

2054

Args:

2055

parent: string, Required.

2056

2057

The resource name of the project under which the job is created.

2058

2059

The format is "projects/{project_id}", for example,

2060

"projects/api-test-project". (required)

2061

pageSize: integer, Optional.

2062

2063

The maximum number of jobs to be returned per page of results.

2064

2065

If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed

2066

page size is 1000. Otherwise, the maximum allowed page size is 100.

2067

2068

Default is 100 if empty or a number < 1 is specified.

2069

pageToken: string, Optional.

2070

2071

The starting point of a query result.

2072

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

jobView: string, Optional.

2077

2078

The desired job attributes returned for jobs in the

2079

search response. Defaults to JobView.JOB_VIEW_FULL if no value is

2080

specified.

2081

filter: string, Required.

2082

2083

The filter string specifies the jobs to be enumerated.

2084

2085

Supported operator: =, AND

2086

2087

The fields eligible for filtering are:

2088

2089

* `companyName` (Required)

2090

* `requisitionId` (Optional)

Sample Query:

* companyName = "projects/api-test-project/companies/123"

2095

* companyName = "projects/api-test-project/companies/123" AND requisitionId

= "req-1"

Returns:

An object of the form:

{ # Output only.

#

# List jobs response.

2104

"nextPageToken": "A String", # A token to retrieve the next page of results.

2105

"jobs": [ # The Jobs for a given company.

2106

#

2107

# The maximum number of items returned is based on the limit field

2108

# provided in the request.

2109

{ # A Job resource represents a job posting (also referred to as a "job listing"

2110

# or "job requisition"). A job belongs to a Company, which is the hiring

2111

# entity responsible for the job.

2112

"languageCode": "A String", # Optional.

2113

#

2114

# The language of the posting. This field is distinct from

2115

# any requirements for fluency that are associated with the job.

2116

#

2117

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

2118

# For more information, see

2119

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

2120

# class="external" target="_blank" }.

2121

#

2122

# If this field is unspecified and Job.description is present, detected

2123

# language code based on Job.description is assigned, otherwise

2124

# defaults to 'en_US'.

2125

"addresses": [ # Optional but strongly recommended for the best service experience.

2126

#

2127

# Location(s) where the employer is looking to hire for this job posting.

2128

#

2129

# Specifying the full street address(es) of the hiring location enables

2130

# better API results, especially job searches by commute time.

2131

#

2132

# At most 50 locations are allowed for best search performance. If a job has

2133

# more locations, it is suggested to split it into multiple jobs with unique

2134

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

2135

# multiple jobs with the same company_name, language_code and

2136

# requisition_id are not allowed. If the original requisition_id must

2137

# be preserved, a custom field should be used for storage. It is also

2138

# suggested to group the locations that close to each other in the same job

2139

# for better search experience.

2140

#

2141

# The maximum number of allowed characters is 500.

2142

"A String",

2143

],

2144

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

2145

"promotionValue": 42, # Optional.

2146

#

2147

# A promotion value of the job, as determined by the client.

2148

# The value determines the sort order of the jobs returned when searching for

2149

# jobs using the featured jobs search call, with higher promotional values

2150

# being returned first and ties being resolved by relevance sort. Only the

2151

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

2152

#

2153

# Default value is 0, and negative values are treated as 0.

2154

"employmentTypes": [ # Optional.

2155

#

2156

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

2162

#

2163

# The end timestamp of the job. Typically this field is used for contracting

2164

# engagements. Invalid timestamps are ignored.

2165

"description": "A String", # Required.

2166

#

2167

# The description of the job, which typically includes a multi-paragraph

2168

# description of the company and related information. Separate fields are

2169

# provided on the job object for responsibilities,

2170

# qualifications, and other job characteristics. Use of

2171

# these separate job fields is recommended.

2172

#

2173

# This field accepts and sanitizes HTML input, and also accepts

2174

# bold, italic, ordered list, and unordered list markup tags.

2175

#

2176

# The maximum number of allowed characters is 100,000.

2177

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

2178

# experience.

2179

#

2180

# The expiration timestamp of the job. After this timestamp, the

2181

# job is marked as expired, and it no longer appears in search results. The

2182

# expired job can't be deleted or listed by the DeleteJob and

2183

# ListJobs APIs, but it can be retrieved with the GetJob API or

2184

# updated with the UpdateJob API. An expired job can be updated and

2185

# opened again by using a future expiration timestamp. Updating an expired

2186

# job fails if there is another existing open job with same company_name,

2187

# language_code and requisition_id.

2188

#

2189

# The expired jobs are retained in our system for 90 days. However, the

2190

# overall expired job count cannot exceed 3 times the maximum of open jobs

2191

# count over the past week, otherwise jobs with earlier expire time are

2192

# cleaned first. Expired jobs are no longer accessible after they are cleaned

2193

# out.

2194

#

2195

# Invalid timestamps are ignored, and treated as expire time not provided.

2196

#

2197

# Timestamp before the instant request is made is considered valid, the job

2198

# will be treated as expired immediately.

2199

#

2200

# If this value is not provided at the time of job creation or is invalid,

2201

# the job posting expires after 30 days from the job's creation time. For

2202

# example, if the job was created on 2017/01/01 13:00AM UTC with an

2203

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

2204

#

2205

# If this value is not provided on job update, it depends on the field masks

2206

# set by UpdateJobRequest.update_mask. If the field masks include

2207

# expiry_time, or the masks are empty meaning that every field is

2208

# updated, the job posting expires after 30 days from the job's last

2209

# update time. Otherwise the expiration date isn't updated.

2210

"title": "A String", # Required.

2211

#

2212

# The title of the job, such as "Software Engineer"

2213

#

2214

# The maximum number of allowed characters is 500.

2215

"responsibilities": "A String", # Optional.

2216

#

2217

# A description of job responsibilities. The use of this field is

2218

# recommended as an alternative to using the more general description

2219

# field.

2220

#

2221

# This field accepts and sanitizes HTML input, and also accepts

2222

# bold, italic, ordered list, and unordered list markup tags.

2223

#

2224

# The maximum number of allowed characters is 10,000.

2225

"jobStartTime": "A String", # Optional.

2226

#

2227

# The start timestamp of the job in UTC time zone. Typically this field

2228

# is used for contracting engagements. Invalid timestamps are ignored.

2229

"compensationInfo": { # Job compensation details. # Optional.

2230

#

2231

# Job compensation information.

2232

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

2233

# all compensation entries' CompensationEntry.compensation times

2234

# CompensationEntry.expected_units_per_year.

2235

#

2236

# See CompensationEntry for explanation on compensation annualization.

2237

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

2238

#

2239

# The minimum amount of compensation. If left empty, the value is set

2240

# to zero and the currency code is set to match the

2241

# currency code of max_compensation.

2242

"nanos": 42, # Number of nano (10^-9) units of the amount.

2243

# The value must be between -999,999,999 and +999,999,999 inclusive.

2244

# If `units` is positive, `nanos` must be positive or zero.

2245

# If `units` is zero, `nanos` can be positive, zero, or negative.

2246

# If `units` is negative, `nanos` must be negative or zero.

2247

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2248

"units": "A String", # The whole units of the amount.

2249

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2250

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2251

},

2252

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

2253

#

2254

# The maximum amount of compensation. If left empty, the value is set

2255

# to a maximal compensation value and the currency code is set to

2256

# match the currency code of

2257

# min_compensation.

2258

"nanos": 42, # Number of nano (10^-9) units of the amount.

2259

# The value must be between -999,999,999 and +999,999,999 inclusive.

2260

# If `units` is positive, `nanos` must be positive or zero.

2261

# If `units` is zero, `nanos` can be positive, zero, or negative.

2262

# If `units` is negative, `nanos` must be negative or zero.

2263

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2264

"units": "A String", # The whole units of the amount.

2265

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2266

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2267

},

2268

},

2269

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

2270

# base compensation entry's CompensationEntry.compensation times

2271

# CompensationEntry.expected_units_per_year.

2272

#

2273

# See CompensationEntry for explanation on compensation annualization.

2274

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

2275

#

2276

# The minimum amount of compensation. If left empty, the value is set

2277

# to zero and the currency code is set to match the

2278

# currency code of max_compensation.

2279

"nanos": 42, # Number of nano (10^-9) units of the amount.

2280

# The value must be between -999,999,999 and +999,999,999 inclusive.

2281

# If `units` is positive, `nanos` must be positive or zero.

2282

# If `units` is zero, `nanos` can be positive, zero, or negative.

2283

# If `units` is negative, `nanos` must be negative or zero.

2284

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2285

"units": "A String", # The whole units of the amount.

2286

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2287

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2288

},

2289

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

2290

#

2291

# The maximum amount of compensation. If left empty, the value is set

2292

# to a maximal compensation value and the currency code is set to

2293

# match the currency code of

2294

# min_compensation.

2295

"nanos": 42, # Number of nano (10^-9) units of the amount.

2296

# The value must be between -999,999,999 and +999,999,999 inclusive.

2297

# If `units` is positive, `nanos` must be positive or zero.

2298

# If `units` is zero, `nanos` can be positive, zero, or negative.

2299

# If `units` is negative, `nanos` must be negative or zero.

2300

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2301

"units": "A String", # The whole units of the amount.

2302

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2303

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2304

},

2305

},

2306

"entries": [ # Optional.

2307

#

2308

# Job compensation information.

2309

#

2310

# At most one entry can be of type

2311

# CompensationInfo.CompensationType.BASE, which is

2312

# referred as ** base compensation entry ** for the job.

2313

{ # A compensation entry that represents one component of compensation, such

2314

# as base pay, bonus, or other compensation type.

2315

#

2316

# Annualization: One compensation entry can be annualized if

2317

# - it contains valid amount or range.

2318

# - and its expected_units_per_year is set or can be derived.

2319

# Its annualized range is determined as (amount or range) times

2320

# expected_units_per_year.

2321

"description": "A String", # Optional.

2322

#

2323

# Compensation description. For example, could

2324

# indicate equity terms or provide additional context to an estimated

2325

# bonus.

2326

"range": { # Compensation range. # Optional.

2327

#

2328

# Compensation range.

2329

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

2330

#

2331

# The minimum amount of compensation. If left empty, the value is set

2332

# to zero and the currency code is set to match the

2333

# currency code of max_compensation.

2334

"nanos": 42, # Number of nano (10^-9) units of the amount.

2335

# The value must be between -999,999,999 and +999,999,999 inclusive.

2336

# If `units` is positive, `nanos` must be positive or zero.

2337

# If `units` is zero, `nanos` can be positive, zero, or negative.

2338

# If `units` is negative, `nanos` must be negative or zero.

2339

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2340

"units": "A String", # The whole units of the amount.

2341

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2342

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2343

},

2344

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

2345

#

2346

# The maximum amount of compensation. If left empty, the value is set

2347

# to a maximal compensation value and the currency code is set to

2348

# match the currency code of

2349

# min_compensation.

2350

"nanos": 42, # Number of nano (10^-9) units of the amount.

2351

# The value must be between -999,999,999 and +999,999,999 inclusive.

2352

# If `units` is positive, `nanos` must be positive or zero.

2353

# If `units` is zero, `nanos` can be positive, zero, or negative.

2354

# If `units` is negative, `nanos` must be negative or zero.

2355

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2356

"units": "A String", # The whole units of the amount.

2357

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2358

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2359

},

2360

},

2361

"expectedUnitsPerYear": 3.14, # Optional.

2362

#

2363

# Expected number of units paid each year. If not specified, when

2364

# Job.employment_types is FULLTIME, a default value is inferred

2365

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"amount": { # Represents an amount of money with its currency type. # Optional.

2372

#

2373

# Compensation amount.

2374

"nanos": 42, # Number of nano (10^-9) units of the amount.

2375

# The value must be between -999,999,999 and +999,999,999 inclusive.

2376

# If `units` is positive, `nanos` must be positive or zero.

2377

# If `units` is zero, `nanos` can be positive, zero, or negative.

2378

# If `units` is negative, `nanos` must be negative or zero.

2379

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2380

"units": "A String", # The whole units of the amount.

2381

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2382

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2383

},

2384

"type": "A String", # Optional.

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

2389

"unit": "A String", # Optional.

2390

#

2391

# Frequency of the specified amount.

2392

#

2393

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

2398

#

2399

# The department or functional area within the company with the open

2400

# position.

2401

#

2402

# The maximum number of allowed characters is 255.

2403

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

2404

"requisitionId": "A String", # Required.

2405

#

2406

# The requisition ID, also referred to as the posting ID, assigned by the

2407

# client to identify a job. This field is intended to be used by clients

2408

# for client identification and tracking of postings. A job is not allowed

2409

# to be created if there is another job with the same [company_name],

2410

# language_code and requisition_id.

2411

#

2412

# The maximum number of allowed characters is 255.

2413

"postingPublishTime": "A String", # Optional.

2414

#

2415

# The timestamp this job posting was most recently published. The default

2416

# value is the time the request arrives at the server. Invalid timestamps are

2417

# ignored.

2418

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

2419

#

2420

# Job application information.

2421

"instruction": "A String", # Optional but at least one of uris,

2422

# emails or instruction must be

2423

# specified.

2424

#

2425

# Use this field to provide instructions, such as "Mail your application

2426

# to ...", that a candidate can follow to apply for the job.

2427

#

2428

# This field accepts and sanitizes HTML input, and also accepts

2429

# bold, italic, ordered list, and unordered list markup tags.

2430

#

2431

# The maximum number of allowed characters is 3,000.

2432

"emails": [ # Optional but at least one of uris,

2433

# emails or instruction must be

2434

# specified.

2435

#

2436

# Use this field to specify email address(es) to which resumes or

2437

# applications can be sent.

2438

#

2439

# The maximum number of allowed characters for each entry is 255.

2440

"A String",

2441

],

2442

"uris": [ # Optional but at least one of uris,

2443

# emails or instruction must be

2444

# specified.

2445

#

2446

# Use this URI field to direct an applicant to a website, for example to

2447

# link to an online application form.

2448

#

2449

# The maximum number of allowed characters for each entry is 2,000.

"A String",

],

},

"companyName": "A String", # Required.

2454

#

2455

# The resource name of the company listing the job, such as

2456

# "projects/api-test-project/companies/foo".

2457

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

2458

#

2459

# Derived details about the job posting.

2460

"jobCategories": [ # Job categories derived from Job.title and Job.description.

2461

"A String",

2462

],

2463

"locations": [ # Structured locations of the job, resolved from Job.addresses.

2464

#

2465

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

2470

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

2471

# location bounding box in which a circle with the specified radius

2472

# centered from LatLng covers the area associated with the job location.

2473

# For example, currently, "Mountain View, CA, USA" has a radius of

2474

# 6.17 miles.

2475

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

2476

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

2477

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

2478

# LocationType#LOCALITY.

2479

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

2480

# of doubles representing degrees latitude and degrees longitude. Unless

2481

# specified otherwise, this must conform to the

2482

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

2483

# standard</a>. Values must be within normalized ranges.

2484

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

2485

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

2486

},

2487

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

2488

# such as postal delivery and payments addresses. Given a postal address,

2489

# a postal service can deliver items to a premises, P.O. Box, or other

2490

# delivery location.

2491

# Given a postal address, a postal service can deliver items to a premise, P.O.

2492

# Box or similar.

2493

# It is not intended to model geographical locations (roads, towns,

2494

# mountains).

2495

#

2496

# In typical usage an address would be created via user input or from importing

2497

# existing data, depending on the type of process.

2498

#

2499

# Advice on address input / editing:

2500

# - Use an i18n-ready address widget such as

2501

# https://github.com/googlei18n/libaddressinput)

2502

# - Users should not be presented with UI elements for input or editing of

2503

# fields outside countries where that field is used.

2504

#

2505

# For more guidance on how to use this schema, please see:

2506

# https://support.google.com/business/answer/6397478

2507

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

2508

# known). This is often the UI language of the input form or is expected

2509

# to match one of the languages used in the address' country/region, or their

2510

# transliterated equivalents.

2511

# This can affect formatting in certain countries, but is not critical

2512

# to the correctness of the data and will never affect any validation or

2513

# other non-formatting related operations.

2514

#

2515

# If this value is not known, it should be omitted (rather than specifying a

2516

# possibly incorrect default).

2517

#

2518

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

2519

"recipients": [ # Optional. The recipient at the address.

2520

# This field may, under certain circumstances, contain multiline information.

2521

# For example, it might contain "care of" information.

2522

"A String",

2523

],

2524

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

2525

# Examples: US city, IT comune, UK post town.

2526

# In regions of the world where localities are not well defined or do not fit

2527

# into this structure well, leave locality empty and use address_lines.

2528

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

2529

# in most regions. Where it is used, the value is either a string like

2530

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

2531

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

2532

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

2533

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

2534

# is never inferred and it is up to the user to ensure the value is

2535

# correct. See http://cldr.unicode.org/ and

2536

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

2537

# for details. Example: "CH" for Switzerland.

2538

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

2539

# addresses of a country or region.

2540

# For example, this can be a state, a province, an oblast, or a prefecture.

2541

# Specifically, for Spain this is the province and not the autonomous

2542

# community (e.g. "Barcelona" and not "Catalonia").

2543

# Many countries don't use an administrative area in postal addresses. E.g.

2544

# in Switzerland this should be left unpopulated.

2545

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

2546

#

2547

# Because values in address_lines do not have type information and may

2548

# sometimes contain multiple values in a single field (e.g.

2549

# "Austin, TX"), it is important that the line order is clear. The order of

2550

# address lines should be "envelope order" for the country/region of the

2551

# address. In places where this can vary (e.g. Japan), address_language is

2552

# used to make it explicit (e.g. "ja" for large-to-small ordering and

2553

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

2554

# an address can be selected based on the language.

2555

#

2556

# The minimum permitted structural representation of an address consists

2557

# of a region_code with all remaining information placed in the

2558

# address_lines. It would be possible to format such an address very

2559

# approximately without geocoding, but no semantic reasoning could be

2560

# made about any of the address components until it was at least

2561

# partially resolved.

2562

#

2563

# Creating an address only containing a region_code and address_lines, and

2564

# then geocoding is the recommended way to handle completely unstructured

2565

# addresses (as opposed to guessing which parts of the address should be

2566

# localities or administrative areas).

2567

"A String",

2568

],

2569

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

2570

# postal codes to be present, but where they are used, they may trigger

2571

# additional validation with other parts of the address (e.g. state/zip

2572

# validation in the U.S.A.).

2573

"organization": "A String", # Optional. The name of the organization at the address.

2574

"sublocality": "A String", # Optional. Sublocality of the address.

2575

# For example, this can be neighborhoods, boroughs, districts.

2576

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

2577

# the latest revision.

2578

#

2579

# All new revisions **must** be backward compatible with old revisions.

},

},

],

},

"incentives": "A String", # Optional.

2585

#

2586

# A description of bonus, commission, and other compensation

2587

# incentives associated with the job not including salary or pay.

2588

#

2589

# The maximum number of allowed characters is 10,000.

2590

"jobBenefits": [ # Optional.

2591

#

2592

# The benefits included with the job.

2593

"A String",

2594

],

2595

"qualifications": "A String", # Optional.

2596

#

2597

# A description of the qualifications required to perform the

2598

# job. The use of this field is recommended

2599

# as an alternative to using the more general description field.

2600

#

2601

# This field accepts and sanitizes HTML input, and also accepts

2602

# bold, italic, ordered list, and unordered list markup tags.

2603

#

2604

# The maximum number of allowed characters is 10,000.

2605

"visibility": "A String", # Optional.

2606

#

2607

# The visibility of the job.

2608

#

2609

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

2610

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

2611

"postingRegion": "A String", # Optional.

2612

#

2613

# The job PostingRegion (for example, state, country) throughout which

2614

# the job is available. If this field is set, a

2615

# LocationFilter in a search query within the job region

2616

# finds this job posting if an exact location match isn't specified.

2617

# If this field is set to PostingRegion.NATION or

2618

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

2619

# to the same location level as this field is strongly recommended.

2620

"name": "A String", # Required during job update.

2621

#

2622

# The resource name for the job. This is generated by the service when a

2623

# job is created.

2624

#

2625

# The format is "projects/{project_id}/jobs/{job_id}",

2626

# for example, "projects/api-test-project/jobs/1234".

2627

#

2628

# Use of this field in job queries and API calls is preferred over the use of

2629

# requisition_id since this value is unique.

2630

"processingOptions": { # Input only. # Optional.

2631

#

2632

# Options for job processing.

2633

#

2634

# Options for job processing.

2635

"htmlSanitization": "A String", # Optional.

2636

#

2637

# Option for job HTML content sanitization. Applied fields are:

2638

#

2639

# * description

2640

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

2646

# disabled.

2647

#

2648

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

2649

"disableStreetAddressResolution": True or False, # Optional.

2650

#

2651

# If set to `true`, the service does not attempt to resolve a

2652

# more precise address for the job.

2653

},

2654

"degreeTypes": [ # Optional.

2655

#

2656

# The desired education degrees for the job, such as Bachelors, Masters.

2657

"A String",

2658

],

2659

"customAttributes": { # Optional.

2660

#

2661

# A map of fields to hold both filterable and non-filterable custom job

2662

# attributes that are not covered by the provided structured fields.

2663

#

2664

# The keys of the map are strings up to 64 bytes and must match the

2665

# pattern: a-zA-Z*. For example, key0LikeThis or

2666

# KEY_1_LIKE_THIS.

2667

#

2668

# At most 100 filterable and at most 100 unfilterable keys are supported.

2669

# For filterable `string_values`, across all keys at most 200 values are

2670

# allowed, with each string no more than 255 characters. For unfilterable

2671

# `string_values`, the maximum total size of `string_values` across all keys

2672

# is 50KB.

2673

"a_key": { # Custom attribute values that are either filterable or non-filterable.

2674

"filterable": True or False, # Optional.

2675

#

2676

# If the `filterable` flag is true, custom field values are searchable.

2677

# If false, values are not searchable.

2678

#

2679

# Default is false.

2680

"stringValues": [ # Optional but exactly one of string_values or long_values must

2681

# be specified.

2682

#

2683

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

2684

# `CASE_INSENSITIVE_MATCH`) search.

2685

# For filterable `string_value`s, a maximum total number of 200 values

2686

# is allowed, with each `string_value` has a byte size of no more than

2687

# 255B. For unfilterable `string_values`, the maximum total byte size of

2688

# unfilterable `string_values` is 50KB.

2689

#

2690

# Empty string is not allowed.

2691

"A String",

2692

],

2693

"longValues": [ # Optional but exactly one of string_values or long_values must

2694

# be specified.

2695

#

2696

# This field is used to perform number range search.

2697

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

2698

#

2699

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

2705

#

2706

# The experience level associated with the job, such as "Entry Level".

2707

},

2708

],

2709

"metadata": { # Output only. # Additional information for the API invocation, such as the request

2710

# tracking id.

2711

#

2712

# Additional information returned to client, such as debugging information.

2713

"requestId": "A String", # A unique id associated with this call.

2714

# This id is logged for tracking purposes.

},

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2721

<pre>Retrieves the next page of results.

2722

2723

Args:

2724

previous_request: The request for the previous page. (required)

2725

previous_response: The response from the request for the previous page. (required)

2726

2727

Returns:

2728

A request object that you can call 'execute()' on to request the next

2729

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body, x__xgafv=None)</code>

2735

<pre>Updates specified job.

2736

2737

Typically, updated contents become visible in search results within 10

2738

seconds, but it may take up to 5 minutes.

Args:

The resource name for the job. This is generated by the service when a

2744

job is created.

2745

2746

The format is "projects/{project_id}/jobs/{job_id}",

2747

for example, "projects/api-test-project/jobs/1234".

2748

2749

Use of this field in job queries and API calls is preferred over the use of

2750

requisition_id since this value is unique. (required)

2751

body: object, The request body. (required)

2752

The object takes the form of:

{ # Input only.

#

# Update job request.

2757

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required.

2758

#

2759

# The Job to be updated.

2760

# or "job requisition"). A job belongs to a Company, which is the hiring

2761

# entity responsible for the job.

2762

"languageCode": "A String", # Optional.

2763

#

2764

# The language of the posting. This field is distinct from

2765

# any requirements for fluency that are associated with the job.

2766

#

2767

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

2768

# For more information, see

2769

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

2770

# class="external" target="_blank" }.

2771

#

2772

# If this field is unspecified and Job.description is present, detected

2773

# language code based on Job.description is assigned, otherwise

2774

# defaults to 'en_US'.

2775

"addresses": [ # Optional but strongly recommended for the best service experience.

2776

#

2777

# Location(s) where the employer is looking to hire for this job posting.

2778

#

2779

# Specifying the full street address(es) of the hiring location enables

2780

# better API results, especially job searches by commute time.

2781

#

2782

# At most 50 locations are allowed for best search performance. If a job has

2783

# more locations, it is suggested to split it into multiple jobs with unique

2784

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

2785

# multiple jobs with the same company_name, language_code and

2786

# requisition_id are not allowed. If the original requisition_id must

2787

# be preserved, a custom field should be used for storage. It is also

2788

# suggested to group the locations that close to each other in the same job

2789

# for better search experience.

2790

#

2791

# The maximum number of allowed characters is 500.

2792

"A String",

2793

],

2794

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

2795

"promotionValue": 42, # Optional.

2796

#

2797

# A promotion value of the job, as determined by the client.

2798

# The value determines the sort order of the jobs returned when searching for

2799

# jobs using the featured jobs search call, with higher promotional values

2800

# being returned first and ties being resolved by relevance sort. Only the

2801

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

2802

#

2803

# Default value is 0, and negative values are treated as 0.

2804

"employmentTypes": [ # Optional.

2805

#

2806

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

2812

#

2813

# The end timestamp of the job. Typically this field is used for contracting

2814

# engagements. Invalid timestamps are ignored.

2815

"description": "A String", # Required.

2816

#

2817

# The description of the job, which typically includes a multi-paragraph

2818

# description of the company and related information. Separate fields are

2819

# provided on the job object for responsibilities,

2820

# qualifications, and other job characteristics. Use of

2821

# these separate job fields is recommended.

2822

#

2823

# This field accepts and sanitizes HTML input, and also accepts

2824

# bold, italic, ordered list, and unordered list markup tags.

2825

#

2826

# The maximum number of allowed characters is 100,000.

2827

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

2828

# experience.

2829

#

2830

# The expiration timestamp of the job. After this timestamp, the

2831

# job is marked as expired, and it no longer appears in search results. The

2832

# expired job can't be deleted or listed by the DeleteJob and

2833

# ListJobs APIs, but it can be retrieved with the GetJob API or

2834

# updated with the UpdateJob API. An expired job can be updated and

2835

# opened again by using a future expiration timestamp. Updating an expired

2836

# job fails if there is another existing open job with same company_name,

2837

# language_code and requisition_id.

2838

#

2839

# The expired jobs are retained in our system for 90 days. However, the

2840

# overall expired job count cannot exceed 3 times the maximum of open jobs

2841

# count over the past week, otherwise jobs with earlier expire time are

2842

# cleaned first. Expired jobs are no longer accessible after they are cleaned

2843

# out.

2844

#

2845

# Invalid timestamps are ignored, and treated as expire time not provided.

2846

#

2847

# Timestamp before the instant request is made is considered valid, the job

2848

# will be treated as expired immediately.

2849

#

2850

# If this value is not provided at the time of job creation or is invalid,

2851

# the job posting expires after 30 days from the job's creation time. For

2852

# example, if the job was created on 2017/01/01 13:00AM UTC with an

2853

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

2854

#

2855

# If this value is not provided on job update, it depends on the field masks

2856

# set by UpdateJobRequest.update_mask. If the field masks include

2857

# expiry_time, or the masks are empty meaning that every field is

2858

# updated, the job posting expires after 30 days from the job's last

2859

# update time. Otherwise the expiration date isn't updated.

2860

"title": "A String", # Required.

2861

#

2862

# The title of the job, such as "Software Engineer"

2863

#

2864

# The maximum number of allowed characters is 500.

2865

"responsibilities": "A String", # Optional.

2866

#

2867

# A description of job responsibilities. The use of this field is

2868

# recommended as an alternative to using the more general description

2869

# field.

2870

#

2871

# This field accepts and sanitizes HTML input, and also accepts

2872

# bold, italic, ordered list, and unordered list markup tags.

2873

#

2874

# The maximum number of allowed characters is 10,000.

2875

"jobStartTime": "A String", # Optional.

2876

#

2877

# The start timestamp of the job in UTC time zone. Typically this field

2878

# is used for contracting engagements. Invalid timestamps are ignored.

2879

"compensationInfo": { # Job compensation details. # Optional.

2880

#

2881

# Job compensation information.

2882

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

2883

# all compensation entries' CompensationEntry.compensation times

2884

# CompensationEntry.expected_units_per_year.

2885

#

2886

# See CompensationEntry for explanation on compensation annualization.

2887

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

2888

#

2889

# The minimum amount of compensation. If left empty, the value is set

2890

# to zero and the currency code is set to match the

2891

# currency code of max_compensation.

2892

"nanos": 42, # Number of nano (10^-9) units of the amount.

2893

# The value must be between -999,999,999 and +999,999,999 inclusive.

2894

# If `units` is positive, `nanos` must be positive or zero.

2895

# If `units` is zero, `nanos` can be positive, zero, or negative.

2896

# If `units` is negative, `nanos` must be negative or zero.

2897

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2898

"units": "A String", # The whole units of the amount.

2899

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2900

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2901

},

2902

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

2903

#

2904

# The maximum amount of compensation. If left empty, the value is set

2905

# to a maximal compensation value and the currency code is set to

2906

# match the currency code of

2907

# min_compensation.

2908

"nanos": 42, # Number of nano (10^-9) units of the amount.

2909

# The value must be between -999,999,999 and +999,999,999 inclusive.

2910

# If `units` is positive, `nanos` must be positive or zero.

2911

# If `units` is zero, `nanos` can be positive, zero, or negative.

2912

# If `units` is negative, `nanos` must be negative or zero.

2913

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

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

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2917

},

2918

},

2919

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

2920

# base compensation entry's CompensationEntry.compensation times

2921

# CompensationEntry.expected_units_per_year.

2922

#

2923

# See CompensationEntry for explanation on compensation annualization.

2924

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

2925

#

2926

# The minimum amount of compensation. If left empty, the value is set

2927

# to zero and the currency code is set to match the

2928

# currency code of max_compensation.

2929

"nanos": 42, # Number of nano (10^-9) units of the amount.

2930

# The value must be between -999,999,999 and +999,999,999 inclusive.

2931

# If `units` is positive, `nanos` must be positive or zero.

2932

# If `units` is zero, `nanos` can be positive, zero, or negative.

2933

# If `units` is negative, `nanos` must be negative or zero.

2934

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2935

"units": "A String", # The whole units of the amount.

2936

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2937

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2938

},

2939

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

2940

#

2941

# The maximum amount of compensation. If left empty, the value is set

2942

# to a maximal compensation value and the currency code is set to

2943

# match the currency code of

2944

# min_compensation.

2945

"nanos": 42, # Number of nano (10^-9) units of the amount.

2946

# The value must be between -999,999,999 and +999,999,999 inclusive.

2947

# If `units` is positive, `nanos` must be positive or zero.

2948

# If `units` is zero, `nanos` can be positive, zero, or negative.

2949

# If `units` is negative, `nanos` must be negative or zero.

2950

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2951

"units": "A String", # The whole units of the amount.

2952

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2953

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2954

},

2955

},

2956

"entries": [ # Optional.

2957

#

2958

# Job compensation information.

2959

#

2960

# At most one entry can be of type

2961

# CompensationInfo.CompensationType.BASE, which is

2962

# referred as ** base compensation entry ** for the job.

2963

{ # A compensation entry that represents one component of compensation, such

2964

# as base pay, bonus, or other compensation type.

2965

#

2966

# Annualization: One compensation entry can be annualized if

2967

# - it contains valid amount or range.

2968

# - and its expected_units_per_year is set or can be derived.

2969

# Its annualized range is determined as (amount or range) times

2970

# expected_units_per_year.

2971

"description": "A String", # Optional.

2972

#

2973

# Compensation description. For example, could

2974

# indicate equity terms or provide additional context to an estimated

2975

# bonus.

2976

"range": { # Compensation range. # Optional.

2977

#

2978

# Compensation range.

2979

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

2980

#

2981

# The minimum amount of compensation. If left empty, the value is set

2982

# to zero and the currency code is set to match the

2983

# currency code of max_compensation.

2984

"nanos": 42, # Number of nano (10^-9) units of the amount.

2985

# The value must be between -999,999,999 and +999,999,999 inclusive.

2986

# If `units` is positive, `nanos` must be positive or zero.

2987

# If `units` is zero, `nanos` can be positive, zero, or negative.

2988

# If `units` is negative, `nanos` must be negative or zero.

2989

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2990

"units": "A String", # The whole units of the amount.

2991

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2992

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2993

},

2994

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

2995

#

2996

# The maximum amount of compensation. If left empty, the value is set

2997

# to a maximal compensation value and the currency code is set to

2998

# match the currency code of

2999

# min_compensation.

3000

"nanos": 42, # Number of nano (10^-9) units of the amount.

3001

# The value must be between -999,999,999 and +999,999,999 inclusive.

3002

# If `units` is positive, `nanos` must be positive or zero.

3003

# If `units` is zero, `nanos` can be positive, zero, or negative.

3004

# If `units` is negative, `nanos` must be negative or zero.

3005

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3006

"units": "A String", # The whole units of the amount.

3007

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3008

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3009

},

3010

},

3011

"expectedUnitsPerYear": 3.14, # Optional.

3012

#

3013

# Expected number of units paid each year. If not specified, when

3014

# Job.employment_types is FULLTIME, a default value is inferred

3015

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"amount": { # Represents an amount of money with its currency type. # Optional.

3022

#

3023

# Compensation amount.

3024

"nanos": 42, # Number of nano (10^-9) units of the amount.

3025

# The value must be between -999,999,999 and +999,999,999 inclusive.

3026

# If `units` is positive, `nanos` must be positive or zero.

3027

# If `units` is zero, `nanos` can be positive, zero, or negative.

3028

# If `units` is negative, `nanos` must be negative or zero.

3029

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3030

"units": "A String", # The whole units of the amount.

3031

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3032

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3033

},

3034

"type": "A String", # Optional.

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

3039

"unit": "A String", # Optional.

3040

#

3041

# Frequency of the specified amount.

3042

#

3043

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

3048

#

3049

# The department or functional area within the company with the open

3050

# position.

3051

#

3052

# The maximum number of allowed characters is 255.

3053

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

3054

"requisitionId": "A String", # Required.

3055

#

3056

# The requisition ID, also referred to as the posting ID, assigned by the

3057

# client to identify a job. This field is intended to be used by clients

3058

# for client identification and tracking of postings. A job is not allowed

3059

# to be created if there is another job with the same [company_name],

3060

# language_code and requisition_id.

3061

#

3062

# The maximum number of allowed characters is 255.

3063

"postingPublishTime": "A String", # Optional.

3064

#

3065

# The timestamp this job posting was most recently published. The default

3066

# value is the time the request arrives at the server. Invalid timestamps are

3067

# ignored.

3068

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

3069

#

3070

# Job application information.

3071

"instruction": "A String", # Optional but at least one of uris,

3072

# emails or instruction must be

3073

# specified.

3074

#

3075

# Use this field to provide instructions, such as "Mail your application

3076

# to ...", that a candidate can follow to apply for the job.

3077

#

3078

# This field accepts and sanitizes HTML input, and also accepts

3079

# bold, italic, ordered list, and unordered list markup tags.

3080

#

3081

# The maximum number of allowed characters is 3,000.

3082

"emails": [ # Optional but at least one of uris,

3083

# emails or instruction must be

3084

# specified.

3085

#

3086

# Use this field to specify email address(es) to which resumes or

3087

# applications can be sent.

3088

#

3089

# The maximum number of allowed characters for each entry is 255.

3090

"A String",

3091

],

3092

"uris": [ # Optional but at least one of uris,

3093

# emails or instruction must be

3094

# specified.

3095

#

3096

# Use this URI field to direct an applicant to a website, for example to

3097

# link to an online application form.

3098

#

3099

# The maximum number of allowed characters for each entry is 2,000.

"A String",

],

},

"companyName": "A String", # Required.

3104

#

3105

# The resource name of the company listing the job, such as

3106

# "projects/api-test-project/companies/foo".

3107

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

3108

#

3109

# Derived details about the job posting.

3110

"jobCategories": [ # Job categories derived from Job.title and Job.description.

3111

"A String",

3112

],

3113

"locations": [ # Structured locations of the job, resolved from Job.addresses.

3114

#

3115

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

3120

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

3121

# location bounding box in which a circle with the specified radius

3122

# centered from LatLng covers the area associated with the job location.

3123

# For example, currently, "Mountain View, CA, USA" has a radius of

3124

# 6.17 miles.

3125

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

3126

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

3127

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

3128

# LocationType#LOCALITY.

3129

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

3130

# of doubles representing degrees latitude and degrees longitude. Unless

3131

# specified otherwise, this must conform to the

3132

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3133

# standard</a>. Values must be within normalized ranges.

3134

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3135

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3136

},

3137

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

3138

# such as postal delivery and payments addresses. Given a postal address,

3139

# a postal service can deliver items to a premises, P.O. Box, or other

3140

# delivery location.

3141

# Given a postal address, a postal service can deliver items to a premise, P.O.

3142

# Box or similar.

3143

# It is not intended to model geographical locations (roads, towns,

3144

# mountains).

3145

#

3146

# In typical usage an address would be created via user input or from importing

3147

# existing data, depending on the type of process.

3148

#

3149

# Advice on address input / editing:

3150

# - Use an i18n-ready address widget such as

3151

# https://github.com/googlei18n/libaddressinput)

3152

# - Users should not be presented with UI elements for input or editing of

3153

# fields outside countries where that field is used.

3154

#

3155

# For more guidance on how to use this schema, please see:

3156

# https://support.google.com/business/answer/6397478

3157

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

3158

# known). This is often the UI language of the input form or is expected

3159

# to match one of the languages used in the address' country/region, or their

3160

# transliterated equivalents.

3161

# This can affect formatting in certain countries, but is not critical

3162

# to the correctness of the data and will never affect any validation or

3163

# other non-formatting related operations.

3164

#

3165

# If this value is not known, it should be omitted (rather than specifying a

3166

# possibly incorrect default).

3167

#

3168

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

3169

"recipients": [ # Optional. The recipient at the address.

3170

# This field may, under certain circumstances, contain multiline information.

3171

# For example, it might contain "care of" information.

3172

"A String",

3173

],

3174

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

3175

# Examples: US city, IT comune, UK post town.

3176

# In regions of the world where localities are not well defined or do not fit

3177

# into this structure well, leave locality empty and use address_lines.

3178

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

3179

# in most regions. Where it is used, the value is either a string like

3180

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

3181

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

3182

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

3183

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

3184

# is never inferred and it is up to the user to ensure the value is

3185

# correct. See http://cldr.unicode.org/ and

3186

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3187

# for details. Example: "CH" for Switzerland.

3188

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

3189

# addresses of a country or region.

3190

# For example, this can be a state, a province, an oblast, or a prefecture.

3191

# Specifically, for Spain this is the province and not the autonomous

3192

# community (e.g. "Barcelona" and not "Catalonia").

3193

# Many countries don't use an administrative area in postal addresses. E.g.

3194

# in Switzerland this should be left unpopulated.

3195

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

3196

#

3197

# Because values in address_lines do not have type information and may

3198

# sometimes contain multiple values in a single field (e.g.

3199

# "Austin, TX"), it is important that the line order is clear. The order of

3200

# address lines should be "envelope order" for the country/region of the

3201

# address. In places where this can vary (e.g. Japan), address_language is

3202

# used to make it explicit (e.g. "ja" for large-to-small ordering and

3203

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

3204

# an address can be selected based on the language.

3205

#

3206

# The minimum permitted structural representation of an address consists

3207

# of a region_code with all remaining information placed in the

3208

# address_lines. It would be possible to format such an address very

3209

# approximately without geocoding, but no semantic reasoning could be

3210

# made about any of the address components until it was at least

3211

# partially resolved.

3212

#

3213

# Creating an address only containing a region_code and address_lines, and

3214

# then geocoding is the recommended way to handle completely unstructured

3215

# addresses (as opposed to guessing which parts of the address should be

3216

# localities or administrative areas).

3217

"A String",

3218

],

3219

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

3220

# postal codes to be present, but where they are used, they may trigger

3221

# additional validation with other parts of the address (e.g. state/zip

3222

# validation in the U.S.A.).

3223

"organization": "A String", # Optional. The name of the organization at the address.

3224

"sublocality": "A String", # Optional. Sublocality of the address.

3225

# For example, this can be neighborhoods, boroughs, districts.

3226

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

3227

# the latest revision.

3228

#

3229

# All new revisions **must** be backward compatible with old revisions.

},

},

],

},

"incentives": "A String", # Optional.

3235

#

3236

# A description of bonus, commission, and other compensation

3237

# incentives associated with the job not including salary or pay.

3238

#

3239

# The maximum number of allowed characters is 10,000.

3240

"jobBenefits": [ # Optional.

3241

#

3242

# The benefits included with the job.

3243

"A String",

3244

],

3245

"qualifications": "A String", # Optional.

3246

#

3247

# A description of the qualifications required to perform the

3248

# job. The use of this field is recommended

3249

# as an alternative to using the more general description field.

3250

#

3251

# This field accepts and sanitizes HTML input, and also accepts

3252

# bold, italic, ordered list, and unordered list markup tags.

3253

#

3254

# The maximum number of allowed characters is 10,000.

3255

"visibility": "A String", # Optional.

3256

#

3257

# The visibility of the job.

3258

#

3259

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

3260

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

3261

"postingRegion": "A String", # Optional.

3262

#

3263

# The job PostingRegion (for example, state, country) throughout which

3264

# the job is available. If this field is set, a

3265

# LocationFilter in a search query within the job region

3266

# finds this job posting if an exact location match isn't specified.

3267

# If this field is set to PostingRegion.NATION or

3268

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

3269

# to the same location level as this field is strongly recommended.

3270

"name": "A String", # Required during job update.

3271

#

3272

# The resource name for the job. This is generated by the service when a

3273

# job is created.

3274

#

3275

# The format is "projects/{project_id}/jobs/{job_id}",

3276

# for example, "projects/api-test-project/jobs/1234".

3277

#

3278

# Use of this field in job queries and API calls is preferred over the use of

3279

# requisition_id since this value is unique.

3280

"processingOptions": { # Input only. # Optional.

3281

#

3282

# Options for job processing.

3283

#

3284

# Options for job processing.

3285

"htmlSanitization": "A String", # Optional.

3286

#

3287

# Option for job HTML content sanitization. Applied fields are:

3288

#

3289

# * description

3290

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

3296

# disabled.

3297

#

3298

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

3299

"disableStreetAddressResolution": True or False, # Optional.

3300

#

3301

# If set to `true`, the service does not attempt to resolve a

3302

# more precise address for the job.

3303

},

3304

"degreeTypes": [ # Optional.

3305

#

3306

# The desired education degrees for the job, such as Bachelors, Masters.

3307

"A String",

3308

],

3309

"customAttributes": { # Optional.

3310

#

3311

# A map of fields to hold both filterable and non-filterable custom job

3312

# attributes that are not covered by the provided structured fields.

3313

#

3314

# The keys of the map are strings up to 64 bytes and must match the

3315

# pattern: a-zA-Z*. For example, key0LikeThis or

3316

# KEY_1_LIKE_THIS.

3317

#

3318

# At most 100 filterable and at most 100 unfilterable keys are supported.

3319

# For filterable `string_values`, across all keys at most 200 values are

3320

# allowed, with each string no more than 255 characters. For unfilterable

3321

# `string_values`, the maximum total size of `string_values` across all keys

3322

# is 50KB.

3323

"a_key": { # Custom attribute values that are either filterable or non-filterable.

3324

"filterable": True or False, # Optional.

3325

#

3326

# If the `filterable` flag is true, custom field values are searchable.

3327

# If false, values are not searchable.

3328

#

3329

# Default is false.

3330

"stringValues": [ # Optional but exactly one of string_values or long_values must

3331

# be specified.

3332

#

3333

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

3334

# `CASE_INSENSITIVE_MATCH`) search.

3335

# For filterable `string_value`s, a maximum total number of 200 values

3336

# is allowed, with each `string_value` has a byte size of no more than

3337

# 255B. For unfilterable `string_values`, the maximum total byte size of

3338

# unfilterable `string_values` is 50KB.

3339

#

3340

# Empty string is not allowed.

3341

"A String",

3342

],

3343

"longValues": [ # Optional but exactly one of string_values or long_values must

3344

# be specified.

3345

#

3346

# This field is used to perform number range search.

3347

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

3348

#

3349

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

3355

#

3356

# The experience level associated with the job, such as "Entry Level".

3357

},

3358

"updateMask": "A String", # Optional but strongly recommended to be provided for the best service

3359

# experience.

3360

#

3361

# If update_mask is provided, only the specified fields in

3362

# job are updated. Otherwise all the fields are updated.

3363

#

3364

# A field mask to restrict the fields that are updated. Only

3365

# top level fields of Job are supported.

3366

}

3367

3368

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3375

3376

{ # A Job resource represents a job posting (also referred to as a "job listing"

3377

# or "job requisition"). A job belongs to a Company, which is the hiring

3378

# entity responsible for the job.

3379

"languageCode": "A String", # Optional.

3380

#

3381

# The language of the posting. This field is distinct from

3382

# any requirements for fluency that are associated with the job.

3383

#

3384

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

3385

# For more information, see

3386

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

3387

# class="external" target="_blank" }.

3388

#

3389

# If this field is unspecified and Job.description is present, detected

3390

# language code based on Job.description is assigned, otherwise

3391

# defaults to 'en_US'.

3392

"addresses": [ # Optional but strongly recommended for the best service experience.

3393

#

3394

# Location(s) where the employer is looking to hire for this job posting.

3395

#

3396

# Specifying the full street address(es) of the hiring location enables

3397

# better API results, especially job searches by commute time.

3398

#

3399

# At most 50 locations are allowed for best search performance. If a job has

3400

# more locations, it is suggested to split it into multiple jobs with unique

3401

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

3402

# multiple jobs with the same company_name, language_code and

3403

# requisition_id are not allowed. If the original requisition_id must

3404

# be preserved, a custom field should be used for storage. It is also

3405

# suggested to group the locations that close to each other in the same job

3406

# for better search experience.

3407

#

3408

# The maximum number of allowed characters is 500.

3409

"A String",

3410

],

3411

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

3412

"promotionValue": 42, # Optional.

3413

#

3414

# A promotion value of the job, as determined by the client.

3415

# The value determines the sort order of the jobs returned when searching for

3416

# jobs using the featured jobs search call, with higher promotional values

3417

# being returned first and ties being resolved by relevance sort. Only the

3418

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

3419

#

3420

# Default value is 0, and negative values are treated as 0.

3421

"employmentTypes": [ # Optional.

3422

#

3423

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

3429

#

3430

# The end timestamp of the job. Typically this field is used for contracting

3431

# engagements. Invalid timestamps are ignored.

3432

"description": "A String", # Required.

3433

#

3434

# The description of the job, which typically includes a multi-paragraph

3435

# description of the company and related information. Separate fields are

3436

# provided on the job object for responsibilities,

3437

# qualifications, and other job characteristics. Use of

3438

# these separate job fields is recommended.

3439

#

3440

# This field accepts and sanitizes HTML input, and also accepts

3441

# bold, italic, ordered list, and unordered list markup tags.

3442

#

3443

# The maximum number of allowed characters is 100,000.

3444

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

3445

# experience.

3446

#

3447

# The expiration timestamp of the job. After this timestamp, the

3448

# job is marked as expired, and it no longer appears in search results. The

3449

# expired job can't be deleted or listed by the DeleteJob and

3450

# ListJobs APIs, but it can be retrieved with the GetJob API or

3451

# updated with the UpdateJob API. An expired job can be updated and

3452

# opened again by using a future expiration timestamp. Updating an expired

3453

# job fails if there is another existing open job with same company_name,

3454

# language_code and requisition_id.

3455

#

3456

# The expired jobs are retained in our system for 90 days. However, the

3457

# overall expired job count cannot exceed 3 times the maximum of open jobs

3458

# count over the past week, otherwise jobs with earlier expire time are

3459

# cleaned first. Expired jobs are no longer accessible after they are cleaned

3460

# out.

3461

#

3462

# Invalid timestamps are ignored, and treated as expire time not provided.

3463

#

3464

# Timestamp before the instant request is made is considered valid, the job

3465

# will be treated as expired immediately.

3466

#

3467

# If this value is not provided at the time of job creation or is invalid,

3468

# the job posting expires after 30 days from the job's creation time. For

3469

# example, if the job was created on 2017/01/01 13:00AM UTC with an

3470

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

3471

#

3472

# If this value is not provided on job update, it depends on the field masks

3473

# set by UpdateJobRequest.update_mask. If the field masks include

3474

# expiry_time, or the masks are empty meaning that every field is

3475

# updated, the job posting expires after 30 days from the job's last

3476

# update time. Otherwise the expiration date isn't updated.

3477

"title": "A String", # Required.

3478

#

3479

# The title of the job, such as "Software Engineer"

3480

#

3481

# The maximum number of allowed characters is 500.

3482

"responsibilities": "A String", # Optional.

3483

#

3484

# A description of job responsibilities. The use of this field is

3485

# recommended as an alternative to using the more general description

3486

# field.

3487

#

3488

# This field accepts and sanitizes HTML input, and also accepts

3489

# bold, italic, ordered list, and unordered list markup tags.

3490

#

3491

# The maximum number of allowed characters is 10,000.

3492

"jobStartTime": "A String", # Optional.

3493

#

3494

# The start timestamp of the job in UTC time zone. Typically this field

3495

# is used for contracting engagements. Invalid timestamps are ignored.

3496

"compensationInfo": { # Job compensation details. # Optional.

3497

#

3498

# Job compensation information.

3499

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

3500

# all compensation entries' CompensationEntry.compensation times

3501

# CompensationEntry.expected_units_per_year.

3502

#

3503

# See CompensationEntry for explanation on compensation annualization.

3504

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

3505

#

3506

# The minimum amount of compensation. If left empty, the value is set

3507

# to zero and the currency code is set to match the

3508

# currency code of max_compensation.

3509

"nanos": 42, # Number of nano (10^-9) units of the amount.

3510

# The value must be between -999,999,999 and +999,999,999 inclusive.

3511

# If `units` is positive, `nanos` must be positive or zero.

3512

# If `units` is zero, `nanos` can be positive, zero, or negative.

3513

# If `units` is negative, `nanos` must be negative or zero.

3514

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3515

"units": "A String", # The whole units of the amount.

3516

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3517

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3518

},

3519

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

3520

#

3521

# The maximum amount of compensation. If left empty, the value is set

3522

# to a maximal compensation value and the currency code is set to

3523

# match the currency code of

3524

# min_compensation.

3525

"nanos": 42, # Number of nano (10^-9) units of the amount.

3526

# The value must be between -999,999,999 and +999,999,999 inclusive.

3527

# If `units` is positive, `nanos` must be positive or zero.

3528

# If `units` is zero, `nanos` can be positive, zero, or negative.

3529

# If `units` is negative, `nanos` must be negative or zero.

3530

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3531

"units": "A String", # The whole units of the amount.

3532

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3533

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3534

},

3535

},

3536

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

3537

# base compensation entry's CompensationEntry.compensation times

3538

# CompensationEntry.expected_units_per_year.

3539

#

3540

# See CompensationEntry for explanation on compensation annualization.

3541

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

3542

#

3543

# The minimum amount of compensation. If left empty, the value is set

3544

# to zero and the currency code is set to match the

3545

# currency code of max_compensation.

3546

"nanos": 42, # Number of nano (10^-9) units of the amount.

3547

# The value must be between -999,999,999 and +999,999,999 inclusive.

3548

# If `units` is positive, `nanos` must be positive or zero.

3549

# If `units` is zero, `nanos` can be positive, zero, or negative.

3550

# If `units` is negative, `nanos` must be negative or zero.

3551

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3552

"units": "A String", # The whole units of the amount.

3553

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3554

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3555

},

3556

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

3557

#

3558

# The maximum amount of compensation. If left empty, the value is set

3559

# to a maximal compensation value and the currency code is set to

3560

# match the currency code of

3561

# min_compensation.

3562

"nanos": 42, # Number of nano (10^-9) units of the amount.

3563

# The value must be between -999,999,999 and +999,999,999 inclusive.

3564

# If `units` is positive, `nanos` must be positive or zero.

3565

# If `units` is zero, `nanos` can be positive, zero, or negative.

3566

# If `units` is negative, `nanos` must be negative or zero.

3567

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3568

"units": "A String", # The whole units of the amount.

3569

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3570

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3571

},

3572

},

3573

"entries": [ # Optional.

3574

#

3575

# Job compensation information.

3576

#

3577

# At most one entry can be of type

3578

# CompensationInfo.CompensationType.BASE, which is

3579

# referred as ** base compensation entry ** for the job.

3580

{ # A compensation entry that represents one component of compensation, such

3581

# as base pay, bonus, or other compensation type.

3582

#

3583

# Annualization: One compensation entry can be annualized if

3584

# - it contains valid amount or range.

3585

# - and its expected_units_per_year is set or can be derived.

3586

# Its annualized range is determined as (amount or range) times

3587

# expected_units_per_year.

3588

"description": "A String", # Optional.

3589

#

3590

# Compensation description. For example, could

3591

# indicate equity terms or provide additional context to an estimated

3592

# bonus.

3593

"range": { # Compensation range. # Optional.

3594

#

3595

# Compensation range.

3596

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

3597

#

3598

# The minimum amount of compensation. If left empty, the value is set

3599

# to zero and the currency code is set to match the

3600

# currency code of max_compensation.

3601

"nanos": 42, # Number of nano (10^-9) units of the amount.

3602

# The value must be between -999,999,999 and +999,999,999 inclusive.

3603

# If `units` is positive, `nanos` must be positive or zero.

3604

# If `units` is zero, `nanos` can be positive, zero, or negative.

3605

# If `units` is negative, `nanos` must be negative or zero.

3606

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3607

"units": "A String", # The whole units of the amount.

3608

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3609

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3610

},

3611

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

3612

#

3613

# The maximum amount of compensation. If left empty, the value is set

3614

# to a maximal compensation value and the currency code is set to

3615

# match the currency code of

3616

# min_compensation.

3617

"nanos": 42, # Number of nano (10^-9) units of the amount.

3618

# The value must be between -999,999,999 and +999,999,999 inclusive.

3619

# If `units` is positive, `nanos` must be positive or zero.

3620

# If `units` is zero, `nanos` can be positive, zero, or negative.

3621

# If `units` is negative, `nanos` must be negative or zero.

3622

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3623

"units": "A String", # The whole units of the amount.

3624

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3625

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3626

},

3627

},

3628

"expectedUnitsPerYear": 3.14, # Optional.

3629

#

3630

# Expected number of units paid each year. If not specified, when

3631

# Job.employment_types is FULLTIME, a default value is inferred

3632

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"amount": { # Represents an amount of money with its currency type. # Optional.

3639

#

3640

# Compensation amount.

3641

"nanos": 42, # Number of nano (10^-9) units of the amount.

3642

# The value must be between -999,999,999 and +999,999,999 inclusive.

3643

# If `units` is positive, `nanos` must be positive or zero.

3644

# If `units` is zero, `nanos` can be positive, zero, or negative.

3645

# If `units` is negative, `nanos` must be negative or zero.

3646

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3647

"units": "A String", # The whole units of the amount.

3648

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3649

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3650

},

3651

"type": "A String", # Optional.

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

3656

"unit": "A String", # Optional.

3657

#

3658

# Frequency of the specified amount.

3659

#

3660

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

3665

#

3666

# The department or functional area within the company with the open

3667

# position.

3668

#

3669

# The maximum number of allowed characters is 255.

3670

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

3671

"requisitionId": "A String", # Required.

3672

#

3673

# The requisition ID, also referred to as the posting ID, assigned by the

3674

# client to identify a job. This field is intended to be used by clients

3675

# for client identification and tracking of postings. A job is not allowed

3676

# to be created if there is another job with the same [company_name],

3677

# language_code and requisition_id.

3678

#

3679

# The maximum number of allowed characters is 255.

3680

"postingPublishTime": "A String", # Optional.

3681

#

3682

# The timestamp this job posting was most recently published. The default

3683

# value is the time the request arrives at the server. Invalid timestamps are

3684

# ignored.

3685

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

3686

#

3687

# Job application information.

3688

"instruction": "A String", # Optional but at least one of uris,

3689

# emails or instruction must be

3690

# specified.

3691

#

3692

# Use this field to provide instructions, such as "Mail your application

3693

# to ...", that a candidate can follow to apply for the job.

3694

#

3695

# This field accepts and sanitizes HTML input, and also accepts

3696

# bold, italic, ordered list, and unordered list markup tags.

3697

#

3698

# The maximum number of allowed characters is 3,000.

3699

"emails": [ # Optional but at least one of uris,

3700

# emails or instruction must be

3701

# specified.

3702

#

3703

# Use this field to specify email address(es) to which resumes or

3704

# applications can be sent.

3705

#

3706

# The maximum number of allowed characters for each entry is 255.

3707

"A String",

3708

],

3709

"uris": [ # Optional but at least one of uris,

3710

# emails or instruction must be

3711

# specified.

3712

#

3713

# Use this URI field to direct an applicant to a website, for example to

3714

# link to an online application form.

3715

#

3716

# The maximum number of allowed characters for each entry is 2,000.

"A String",

],

},

"companyName": "A String", # Required.

3721

#

3722

# The resource name of the company listing the job, such as

3723

# "projects/api-test-project/companies/foo".

3724

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

3725

#

3726

# Derived details about the job posting.

3727

"jobCategories": [ # Job categories derived from Job.title and Job.description.

3728

"A String",

3729

],

3730

"locations": [ # Structured locations of the job, resolved from Job.addresses.

3731

#

3732

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

3737

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

3738

# location bounding box in which a circle with the specified radius

3739

# centered from LatLng covers the area associated with the job location.

3740

# For example, currently, "Mountain View, CA, USA" has a radius of

3741

# 6.17 miles.

3742

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

3743

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

3744

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

3745

# LocationType#LOCALITY.

3746

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

3747

# of doubles representing degrees latitude and degrees longitude. Unless

3748

# specified otherwise, this must conform to the

3749

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3750

# standard</a>. Values must be within normalized ranges.

3751

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3752

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3753

},

3754

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

3755

# such as postal delivery and payments addresses. Given a postal address,

3756

# a postal service can deliver items to a premises, P.O. Box, or other

3757

# delivery location.

3758

# Given a postal address, a postal service can deliver items to a premise, P.O.

3759

# Box or similar.

3760

# It is not intended to model geographical locations (roads, towns,

3761

# mountains).

3762

#

3763

# In typical usage an address would be created via user input or from importing

3764

# existing data, depending on the type of process.

3765

#

3766

# Advice on address input / editing:

3767

# - Use an i18n-ready address widget such as

3768

# https://github.com/googlei18n/libaddressinput)

3769

# - Users should not be presented with UI elements for input or editing of

3770

# fields outside countries where that field is used.

3771

#

3772

# For more guidance on how to use this schema, please see:

3773

# https://support.google.com/business/answer/6397478

3774

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

3775

# known). This is often the UI language of the input form or is expected

3776

# to match one of the languages used in the address' country/region, or their

3777

# transliterated equivalents.

3778

# This can affect formatting in certain countries, but is not critical

3779

# to the correctness of the data and will never affect any validation or

3780

# other non-formatting related operations.

3781

#

3782

# If this value is not known, it should be omitted (rather than specifying a

3783

# possibly incorrect default).

3784

#

3785

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

3786

"recipients": [ # Optional. The recipient at the address.

3787

# This field may, under certain circumstances, contain multiline information.

3788

# For example, it might contain "care of" information.

3789

"A String",

3790

],

3791

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

3792

# Examples: US city, IT comune, UK post town.

3793

# In regions of the world where localities are not well defined or do not fit

3794

# into this structure well, leave locality empty and use address_lines.

3795

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

3796

# in most regions. Where it is used, the value is either a string like

3797

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

3798

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

3799

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

3800

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

3801

# is never inferred and it is up to the user to ensure the value is

3802

# correct. See http://cldr.unicode.org/ and

3803

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3804

# for details. Example: "CH" for Switzerland.

3805

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

3806

# addresses of a country or region.

3807

# For example, this can be a state, a province, an oblast, or a prefecture.

3808

# Specifically, for Spain this is the province and not the autonomous

3809

# community (e.g. "Barcelona" and not "Catalonia").

3810

# Many countries don't use an administrative area in postal addresses. E.g.

3811

# in Switzerland this should be left unpopulated.

3812

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

3813

#

3814

# Because values in address_lines do not have type information and may

3815

# sometimes contain multiple values in a single field (e.g.

3816

# "Austin, TX"), it is important that the line order is clear. The order of

3817

# address lines should be "envelope order" for the country/region of the

3818

# address. In places where this can vary (e.g. Japan), address_language is

3819

# used to make it explicit (e.g. "ja" for large-to-small ordering and

3820

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

3821

# an address can be selected based on the language.

3822

#

3823

# The minimum permitted structural representation of an address consists

3824

# of a region_code with all remaining information placed in the

3825

# address_lines. It would be possible to format such an address very

3826

# approximately without geocoding, but no semantic reasoning could be

3827

# made about any of the address components until it was at least

3828

# partially resolved.

3829

#

3830

# Creating an address only containing a region_code and address_lines, and

3831

# then geocoding is the recommended way to handle completely unstructured

3832

# addresses (as opposed to guessing which parts of the address should be

3833

# localities or administrative areas).

3834

"A String",

3835

],

3836

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

3837

# postal codes to be present, but where they are used, they may trigger

3838

# additional validation with other parts of the address (e.g. state/zip

3839

# validation in the U.S.A.).

3840

"organization": "A String", # Optional. The name of the organization at the address.

3841

"sublocality": "A String", # Optional. Sublocality of the address.

3842

# For example, this can be neighborhoods, boroughs, districts.

3843

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

3844

# the latest revision.

3845

#

3846

# All new revisions **must** be backward compatible with old revisions.

},

},

],

},

"incentives": "A String", # Optional.

3852

#

3853

# A description of bonus, commission, and other compensation

3854

# incentives associated with the job not including salary or pay.

3855

#

3856

# The maximum number of allowed characters is 10,000.

3857

"jobBenefits": [ # Optional.

3858

#

3859

# The benefits included with the job.

3860

"A String",

3861

],

3862

"qualifications": "A String", # Optional.

3863

#

3864

# A description of the qualifications required to perform the

3865

# job. The use of this field is recommended

3866

# as an alternative to using the more general description field.

3867

#

3868

# This field accepts and sanitizes HTML input, and also accepts

3869

# bold, italic, ordered list, and unordered list markup tags.

3870

#

3871

# The maximum number of allowed characters is 10,000.

3872

"visibility": "A String", # Optional.

3873

#

3874

# The visibility of the job.

3875

#

3876

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

3877

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

3878

"postingRegion": "A String", # Optional.

3879

#

3880

# The job PostingRegion (for example, state, country) throughout which

3881

# the job is available. If this field is set, a

3882

# LocationFilter in a search query within the job region

3883

# finds this job posting if an exact location match isn't specified.

3884

# If this field is set to PostingRegion.NATION or

3885

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

3886

# to the same location level as this field is strongly recommended.

3887

"name": "A String", # Required during job update.

3888

#

3889

# The resource name for the job. This is generated by the service when a

3890

# job is created.

3891

#

3892

# The format is "projects/{project_id}/jobs/{job_id}",

3893

# for example, "projects/api-test-project/jobs/1234".

3894

#

3895

# Use of this field in job queries and API calls is preferred over the use of

3896

# requisition_id since this value is unique.

3897

"processingOptions": { # Input only. # Optional.

3898

#

3899

# Options for job processing.

3900

#

3901

# Options for job processing.

3902

"htmlSanitization": "A String", # Optional.

3903

#

3904

# Option for job HTML content sanitization. Applied fields are:

3905

#

3906

# * description

3907

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

3913

# disabled.

3914

#

3915

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

3916

"disableStreetAddressResolution": True or False, # Optional.

3917

#

3918

# If set to `true`, the service does not attempt to resolve a

3919

# more precise address for the job.

3920

},

3921

"degreeTypes": [ # Optional.

3922

#

3923

# The desired education degrees for the job, such as Bachelors, Masters.

3924

"A String",

3925

],

3926

"customAttributes": { # Optional.

3927

#

3928

# A map of fields to hold both filterable and non-filterable custom job

3929

# attributes that are not covered by the provided structured fields.

3930

#

3931

# The keys of the map are strings up to 64 bytes and must match the

3932

# pattern: a-zA-Z*. For example, key0LikeThis or

3933

# KEY_1_LIKE_THIS.

3934

#

3935

# At most 100 filterable and at most 100 unfilterable keys are supported.

3936

# For filterable `string_values`, across all keys at most 200 values are

3937

# allowed, with each string no more than 255 characters. For unfilterable

3938

# `string_values`, the maximum total size of `string_values` across all keys

3939

# is 50KB.

3940

"a_key": { # Custom attribute values that are either filterable or non-filterable.

3941

"filterable": True or False, # Optional.

3942

#

3943

# If the `filterable` flag is true, custom field values are searchable.

3944

# If false, values are not searchable.

3945

#

3946

# Default is false.

3947

"stringValues": [ # Optional but exactly one of string_values or long_values must

3948

# be specified.

3949

#

3950

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

3951

# `CASE_INSENSITIVE_MATCH`) search.

3952

# For filterable `string_value`s, a maximum total number of 200 values

3953

# is allowed, with each `string_value` has a byte size of no more than

3954

# 255B. For unfilterable `string_values`, the maximum total byte size of

3955

# unfilterable `string_values` is 50KB.

3956

#

3957

# Empty string is not allowed.

3958

"A String",

3959

],

3960

"longValues": [ # Optional but exactly one of string_values or long_values must

3961

# be specified.

3962

#

3963

# This field is used to perform number range search.

3964

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

3965

#

3966

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

3972

#

3973

# The experience level associated with the job, such as "Entry Level".

}</pre>

</div>

<code class="details" id="search">search(parent, body, x__xgafv=None)</code>

3979

<pre>Searches for jobs using the provided SearchJobsRequest.

3980

3981

This call constrains the visibility of jobs

3982

present in the database, and only returns jobs that the caller has

3983

permission to search against.

3984

3985

Args:

3986

parent: string, Required.

3987

3988

The resource name of the project to search within.

3989

3990

The format is "projects/{project_id}", for example,

3991

"projects/api-test-project". (required)

3992

body: object, The request body. (required)

3993

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

3998

"orderBy": "A String", # Optional.

3999

#

4000

# The criteria determining how search results are sorted. Default is

4001

# "relevance desc".

4002

#

4003

# Supported options are:

4004

#

4005

# * "relevance desc": By relevance descending, as determined by the API

4006

# algorithms. Relevance thresholding of query results is only available

4007

# with this ordering.

4008

# * "posting`_`publish`_`time desc": By Job.posting_publish_time

4009

# descending.

4010

# * "posting`_`update`_`time desc": By Job.posting_update_time

4011

# descending.

4012

# * "title": By Job.title ascending.

4013

# * "title desc": By Job.title descending.

4014

# * "annualized`_`base`_`compensation": By job's

4015

# CompensationInfo.annualized_base_compensation_range ascending. Jobs

4016

# whose annualized base compensation is unspecified are put at the end of

4017

# search results.

4018

# * "annualized`_`base`_`compensation desc": By job's

4019

# CompensationInfo.annualized_base_compensation_range descending. Jobs

4020

# whose annualized base compensation is unspecified are put at the end of

4021

# search results.

4022

# * "annualized`_`total`_`compensation": By job's

4023

# CompensationInfo.annualized_total_compensation_range ascending. Jobs

4024

# whose annualized base compensation is unspecified are put at the end of

4025

# search results.

4026

# * "annualized`_`total`_`compensation desc": By job's

4027

# CompensationInfo.annualized_total_compensation_range descending. Jobs

4028

# whose annualized base compensation is unspecified are put at the end of

4029

# search results.

4030

"diversificationLevel": "A String", # Optional.

4031

#

4032

# Controls whether highly similar jobs are returned next to each other in

4033

# the search results. Jobs are identified as highly similar based on

4034

# their titles, job categories, and locations. Highly similar results are

4035

# clustered so that only one representative job of the cluster is

4036

# displayed to the job seeker higher up in the results, with the other jobs

4037

# being displayed lower down in the results.

4038

#

4039

# Defaults to DiversificationLevel.SIMPLE if no value

4040

# is specified.

4041

"disableKeywordMatch": True or False, # Optional.

4042

#

4043

# Controls whether to disable exact keyword match on Job.job_title,

4044

# Job.description, Job.company_display_name, Job.locations,

4045

# Job.qualifications. When disable keyword match is turned off, a

4046

# keyword match returns jobs that do not match given category filters when

4047

# there are matching keywords. For example, the query "program manager," a

4048

# result is returned even if the job posting has the title "software

4049

# developer," which does not fall into "program manager" ontology, but does

4050

# have "program manager" appearing in its description.

4051

#

4052

# For queries like "cloud" that does not contain title or

4053

# location specific ontology, jobs with "cloud" keyword matches are returned

4054

# regardless of this flag's value.

4055

#

4056

# Please use Company.keyword_searchable_custom_fields or

4057

# Company.keyword_searchable_custom_attributes if company specific

4058

# globally matched custom field/attribute string values is needed. Enabling

4059

# keyword match improves recall of subsequent search requests.

4060

#

4061

# Defaults to false.

4062

"jobQuery": { # Input only. # Optional.

4063

#

4064

# Query used to search against jobs, such as keyword, location filters, etc.

4065

#

4066

# The query required to perform a search query.

4067

"disableSpellCheck": True or False, # Optional.

4068

#

4069

# This flag controls the spell-check feature. If false, the

4070

# service attempts to correct a misspelled query,

4071

# for example, "enginee" is corrected to "engineer".

4072

#

4073

# Defaults to false: a spell check is performed.

4074

"customAttributeFilter": "A String", # Optional.

4075

#

4076

# This filter specifies a structured syntax to match against the

4077

# Job.custom_attributes marked as `filterable`.

4078

#

4079

# The syntax for this expression is a subset of SQL syntax.

4080

#

4081

# Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the

4082

# left of the operator is a custom field key and the right of the operator

4083

# is a number or a quoted string. You must escape backslash (\\) and

4084

# quote (\") characters.

4085

#

4086

# Supported functions are `LOWER([field_name])` to

4087

# perform a case insensitive match and `EMPTY([field_name])` to filter on the

4088

# existence of a key.

4089

#

4090

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

4091

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100

4092

# comparisons or functions are allowed in the expression. The expression

4093

# must be < 3000 bytes in length.

4094

#

4095

# Sample Query:

4096

# `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND

4097

# driving_years > 10`

4098

"employmentTypes": [ # Optional.

4099

#

4100

# The employment type filter specifies the employment type of jobs to

4101

# search against, such as EmploymentType.FULL_TIME.

4102

#

4103

# If a value is not specified, jobs in the search results includes any

4104

# employment type.

4105

#

4106

# If multiple values are specified, jobs in the search results include

4107

# any of the specified employment types.

4108

"A String",

4109

],

4110

"query": "A String", # Optional.

4111

#

4112

# The query string that matches against the job title, description, and

4113

# location fields.

4114

#

4115

# The maximum number of allowed characters is 255.

4116

"publishTimeRange": { # Message representing a period of time between two timestamps. # Optional.

4117

#

4118

# Jobs published within a range specified by this filter are searched

4119

# against.

4120

"endTime": "A String", # End of the period.

4121

"startTime": "A String", # Begin of the period.

4122

},

4123

"commuteFilter": { # Input only. # Optional.

4124

#

4125

# Allows filtering jobs by commute time with different travel methods (for

4126

# example, driving or public transit). Note: This only works with COMMUTE

4127

# MODE. When specified, [JobQuery.location_filters] is

4128

# ignored.

4129

#

4130

# Currently we don't support sorting by commute time.

4131

#

4132

# Parameters needed for commute search.

4133

"roadTraffic": "A String", # Optional.

4134

#

4135

# Specifies the traffic density to use when calculating commute time.

4136

"departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional.

4137

#

4138

# The departure time used to calculate traffic impact, represented as

4139

# google.type.TimeOfDay in local time zone.

4140

#

4141

# Currently traffic model is restricted to hour level resolution.

4142

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4143

# types are google.type.Date and `google.protobuf.Timestamp`.

4144

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4145

# allow the value 60 if it allows leap-seconds.

4146

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4147

# to allow the value "24:00:00" for scenarios like business closing time.

4148

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4149

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4150

},

4151

"startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required.

4152

#

4153

# The latitude and longitude of the location from which to calculate the

4154

# commute time.

4155

# of doubles representing degrees latitude and degrees longitude. Unless

4156

# specified otherwise, this must conform to the

4157

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4158

# standard</a>. Values must be within normalized ranges.

4159

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4160

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4161

},

4162

"allowImpreciseAddresses": True or False, # Optional.

4163

# If true, jobs without "precise" addresses (street level addresses or GPS

4164

# coordinates) might also be returned. For city and coarser level addresses,

4165

# text matching is used. If this field is set to false or is not specified,

4166

# only jobs that include precise addresses are returned by Commute

4167

# Search.

4168

#

4169

# Note: If `allow_imprecise_addresses` is set to true, Commute Search is not

4170

# able to calculate accurate commute times to jobs with city level and

4171

# coarser address information. Jobs with imprecise addresses will return a

4172

# `travel_duration` time of 0 regardless of distance from the job seeker.

4173

"travelDuration": "A String", # Required.

4174

#

4175

# The maximum travel time in seconds. The maximum allowed value is `3600s`

4176

# (one hour). Format is `123s`.

4177

"commuteMethod": "A String", # Required.

4178

#

4179

# The method of transportation for which to calculate the commute time.

4180

},

4181

"jobCategories": [ # Optional.

4182

#

4183

# The category filter specifies the categories of jobs to search against.

4184

# See Category for more information.

4185

#

4186

# If a value is not specified, jobs from any category are searched against.

4187

#

4188

# If multiple values are specified, jobs from any of the specified

4189

# categories are searched against.

4190

"A String",

4191

],

4192

"languageCodes": [ # Optional.

4193

#

4194

# This filter specifies the locale of jobs to search against,

4195

# for example, "en-US".

4196

#

4197

# 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".

4202

# For more information, see

4203

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

4204

#

4205

# At most 10 language code filters are allowed.

4206

"A String",

4207

],

4208

"companyNames": [ # Optional.

4209

#

4210

# This filter specifies the company entities to search against.

4211

#

4212

# If a value isn't specified, jobs are searched for against all

4213

# companies.

4214

#

4215

# If multiple values are specified, jobs are searched against the

4216

# companies specified.

4217

#

4218

# The format is "projects/{project_id}/companies/{company_id}", for example,

4219

# "projects/api-test-project/companies/foo".

4220

#

4221

# At most 20 company filters are allowed.

4222

"A String",

4223

],

4224

"companyDisplayNames": [ # Optional.

4225

#

4226

# This filter specifies the exact company display

4227

# name of the jobs to search against.

4228

#

4229

# If a value isn't specified, jobs within the search results are

4230

# associated with any company.

4231

#

4232

# If multiple values are specified, jobs within the search results may be

4233

# associated with any of the specified companies.

4234

#

4235

# At most 20 company display name filters are allowed.

4236

"A String",

4237

],

4238

"locationFilters": [ # Optional.

4239

#

4240

# The location filter specifies geo-regions containing the jobs to

4241

# search against. See LocationFilter for more information.

4242

#

4243

# If a location value isn't specified, jobs fitting the other search

4244

# criteria are retrieved regardless of where they're located.

4245

#

4246

# If multiple values are specified, jobs are retrieved from any of the

4247

# specified locations. If different values are specified for the

4248

# LocationFilter.distance_in_miles parameter, the maximum provided

4249

# distance is used for all locations.

4250

#

4251

# At most 5 location filters are allowed.

4252

{ # Input only.

4253

#

4254

# Geographic region of the search.

4255

"regionCode": "A String", # Optional.

4256

#

4257

# CLDR region code of the country/region of the address. This is used

4258

# to address ambiguity of the user-input location, for example, "Liverpool"

4259

# against "Liverpool, NY, US" or "Liverpool, UK".

4260

#

4261

# Set this field if all the jobs to search against are from a same region,

4262

# or jobs are world-wide, but the job seeker is from a specific region.

4263

#

4264

# See http://cldr.unicode.org/ and

4265

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4266

# for details. Example: "CH" for Switzerland.

4267

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional.

4268

#

4269

# The latitude and longitude of the geographic center from which to

4270

# search. This field's ignored if `address` is provided.

4271

# of doubles representing degrees latitude and degrees longitude. Unless

4272

# specified otherwise, this must conform to the

4273

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4274

# standard</a>. Values must be within normalized ranges.

4275

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4276

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4277

},

4278

"distanceInMiles": 3.14, # Optional.

4279

#

4280

#

4281

# The distance_in_miles is applied when the location being searched for is

4282

# identified as a city or smaller. When the location being searched for is a

4283

# state or larger, this field is ignored.

4284

"telecommutePreference": "A String", # Optional.

4285

#

4286

# Allows the client to return jobs without a

4287

# set location, specifically, telecommuting jobs (telecomuting is considered

4288

# by the service as a special location.

4289

# Job.posting_region indicates if a job permits telecommuting.

4290

# If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,

4291

# telecommuting jobs are searched, and address and lat_lng are

4292

# ignored. If not set or set to

4293

# TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not

4294

# searched.

4295

#

4296

# This filter can be used by itself to search exclusively for telecommuting

4297

# jobs, or it can be combined with another location

4298

# filter to search for a combination of job locations,

4299

# such as "Mountain View" or "telecommuting" jobs. However, when used in

4300

# combination with other location filters, telecommuting jobs can be

4301

# treated as less relevant than other jobs in the search response.

4302

"address": "A String", # Optional.

4303

#

4304

# The address name, such as "Mountain View" or "Bay Area".

4305

},

4306

],

4307

"compensationFilter": { # Input only. # Optional.

4308

#

4309

# This search filter is applied only to

4310

# Job.compensation_info. For example, if the filter is specified

4311

# as "Hourly job with per-hour compensation > $15", only jobs meeting

4312

# these criteria are searched. If a filter isn't defined, all open jobs

4313

# are searched.

4314

#

4315

# Filter on job compensation type and amount.

4316

"units": [ # Required.

4317

#

4318

# Specify desired `base compensation entry's`

4319

# CompensationInfo.CompensationUnit.

4320

"A String",

4321

],

4322

"range": { # Compensation range. # Optional.

4323

#

4324

# Compensation range.

4325

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

4326

#

4327

# The minimum amount of compensation. If left empty, the value is set

4328

# to zero and the currency code is set to match the

4329

# currency code of max_compensation.

4330

"nanos": 42, # Number of nano (10^-9) units of the amount.

4331

# The value must be between -999,999,999 and +999,999,999 inclusive.

4332

# If `units` is positive, `nanos` must be positive or zero.

4333

# If `units` is zero, `nanos` can be positive, zero, or negative.

4334

# If `units` is negative, `nanos` must be negative or zero.

4335

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4336

"units": "A String", # The whole units of the amount.

4337

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4338

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4339

},

4340

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

4341

#

4342

# The maximum amount of compensation. If left empty, the value is set

4343

# to a maximal compensation value and the currency code is set to

4344

# match the currency code of

4345

# min_compensation.

4346

"nanos": 42, # Number of nano (10^-9) units of the amount.

4347

# The value must be between -999,999,999 and +999,999,999 inclusive.

4348

# If `units` is positive, `nanos` must be positive or zero.

4349

# If `units` is zero, `nanos` can be positive, zero, or negative.

4350

# If `units` is negative, `nanos` must be negative or zero.

4351

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4352

"units": "A String", # The whole units of the amount.

4353

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4354

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4355

},

4356

},

4357

"type": "A String", # Required.

4358

#

4359

# Type of filter.

4360

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional.

4361

#

4362

# If set to true, jobs with unspecified compensation range fields are

# included.

},

},

"pageSize": 42, # Optional.

4367

#

4368

# A limit on the number of jobs returned in the search results.

4369

# Increasing this value above the default value of 10 can increase search

4370

# response time. The value can be between 1 and 100.

4371

"histogramFacets": { # Input only. # Optional.

4372

#

4373

# Histogram requests for jobs matching JobQuery.

4374

#

4375

# Histogram facets to be specified in SearchJobsRequest.

4376

"simpleHistogramFacets": [ # Optional.

4377

#

4378

# Specifies the simple type of histogram facets, for example,

4379

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.

4380

"A String",

4381

],

4382

"customAttributeHistogramFacets": [ # Optional.

4383

#

4384

# Specifies the custom attributes histogram requests.

4385

# Duplicate values of CustomAttributeHistogramRequest.key are not

4386

# allowed.

4387

{ # Custom attributes histogram request. An error is thrown if neither

4388

# string_value_histogram or long_value_histogram_bucketing_option has

4389

# been defined.

4390

"stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for

4391

# each key as a string.

4392

"longValueHistogramBucketingOption": { # Input only. # Optional.

4393

#

4394

# Specifies buckets used to perform a range histogram on Job's

4395

# filterable long custom field values, or min/max value requirements.

4396

#

4397

# Use this field to specify bucketing option for the histogram search response.

4398

"bucketBounds": [ # Required.

4399

#

4400

# Two adjacent values form a histogram bucket. Values should be in

4401

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

4402

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

4403

# [buckets_bound is supported.

4404

3.14,

4405

],

4406

"requiresMinMax": True or False, # Optional.

4407

#

4408

# If set to true, the histogram result includes minimum/maximum

4409

# value of the numeric field.

4410

},

4411

"key": "A String", # Required.

4412

#

4413

# Specifies the custom field key to perform a histogram on. If specified

4414

# without `long_value_histogram_bucketing_option`, histogram on string values

4415

# of the given `key` is triggered, otherwise histogram is performed on long

# values.

},

],

"compensationHistogramFacets": [ # Optional.

4420

#

4421

# Specifies compensation field-based histogram requests.

4422

# Duplicate values of CompensationHistogramRequest.type are not allowed.

4423

{ # Input only.

4424

#

4425

# Compensation based histogram request.

4426

"bucketingOption": { # Input only. # Required.

4427

#

4428

# Numeric histogram options, like buckets, whether include min or max value.

4429

#

4430

# Use this field to specify bucketing option for the histogram search response.

4431

"bucketBounds": [ # Required.

4432

#

4433

# Two adjacent values form a histogram bucket. Values should be in

4434

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

4435

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

4436

# [buckets_bound is supported.

4437

3.14,

4438

],

4439

"requiresMinMax": True or False, # Optional.

4440

#

4441

# If set to true, the histogram result includes minimum/maximum

4442

# value of the numeric field.

4443

},

4444

"type": "A String", # Required.

4445

#

4446

# Type of the request, representing which field the histogramming should be

4447

# performed over. A single request can only specify one histogram of each

4448

# `CompensationHistogramRequestType`.

},

],

},

"enableBroadening": True or False, # Optional.

4453

#

4454

# Controls whether to broaden the search when it produces sparse results.

4455

# Broadened queries append results to the end of the matching results

# list.

#

# Defaults to false.

"searchMode": "A String", # Optional.

#

# Mode of a search.

#

# Defaults to SearchMode.JOB_SEARCH.

4464

"pageToken": "A String", # Optional.

4465

#

4466

# The token specifying the current offset within

4467

# search results. See SearchJobsResponse.next_page_token for

4468

# an explanation of how to obtain the next set of query results.

4469

"requestMetadata": { # Input only. # Required.

4470

#

4471

# The meta information collected about the job searcher, used to improve the

4472

# search quality of the service.. The identifiers, (such as `user_id`) are

4473

# provided by users, and must be unique and consistent.

4474

#

4475

# Meta information related to the job searcher or entity

4476

# conducting the job search. This information is used to improve the

4477

# performance of the service.

4478

"userId": "A String", # Required.

4479

#

4480

# A unique user identification string, as determined by the client.

4481

# To have the strongest positive impact on search quality

4482

# make sure the client-level is unique.

4483

# Obfuscate this field for privacy concerns before

4484

# providing it to the service.

4485

#

4486

# If this field is not available for some reason, send "UNKNOWN". Note

4487

# that any improvements to the model for a particular tenant

4488

# site, rely on this field being set correctly to a unique user_id.

4489

#

4490

# The maximum number of allowed characters is 255.

4491

"sessionId": "A String", # Required.

4492

#

4493

# A unique session identification string. A session is defined as the

4494

# duration of an end user's interaction with the service over a certain

4495

# period.

4496

# Obfuscate this field for privacy concerns before

4497

# providing it to the service.

4498

#

4499

# If this field is not available for some reason, send "UNKNOWN". Note

4500

# that any improvements to the model for a particular tenant

4501

# site, rely on this field being set correctly to some unique session_id.

4502

#

4503

# The maximum number of allowed characters is 255.

4504

"deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional.

4505

#

4506

# The type of device used by the job seeker at the time of the call to the

4507

# service.

4508

# other entity conducting the job search. Providing this information improves

4509

# the quality of the search results across devices.

4510

"deviceType": "A String", # Optional.

4511

#

4512

# Type of the device.

4513

"id": "A String", # Optional.

4514

#

4515

# A device-specific ID. The ID must be a unique identifier that

4516

# distinguishes the device from other devices.

4517

},

4518

"domain": "A String", # Required.

4519

#

4520

# The client-defined scope or source of the service call, which typically

4521

# is the domain on

4522

# which the service has been implemented and is currently being run.

4523

#

4524

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

4525

# job board www.foo.com and career site www.bar.com, then this field is

4526

# set to "foo.com" for use on the job board, and "bar.com" for use on the

4527

# career site.

4528

#

4529

# If this field isn't available for some reason, send "UNKNOWN".

4530

# Any improvements to the model for a particular tenant site rely on this

4531

# field being set correctly to a domain.

4532

#

4533

# The maximum number of allowed characters is 255.

4534

},

4535

"requirePreciseResultSize": True or False, # Optional.

4536

#

4537

# Controls if the search job request requires the return of a precise

4538

# count of the first 300 results. Setting this to `true` ensures

4539

# consistency in the number of results per page. Best practice is to set this

4540

# value to true if a client allows users to jump directly to a

4541

# non-sequential search results page.

4542

#

4543

# Enabling this flag may adversely impact performance.

4544

#

4545

# Defaults to false.

4546

"jobView": "A String", # Optional.

4547

#

4548

# The desired job attributes returned for jobs in the

4549

# search response. Defaults to JobView.SMALL if no value is specified.

4550

"offset": 42, # Optional.

4551

#

4552

# An integer that specifies the current offset (that is, starting result

4553

# location, amongst the jobs deemed by the API as relevant) in search

4554

# results. This field is only considered if page_token is unset.

4555

#

4556

# For example, 0 means to return results starting from the first matching

4557

# job, and 10 means to return from the 11th job. This can be used for

4558

# pagination, (for example, pageSize = 10 and offset = 10 means to return

4559

# from the second page).

4560

}

4561

4562

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.

4573

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

4574

# This field is empty if there are no more results.

4575

"spellCorrection": { # Output only. # The spell checking result, and correction.

4576

#

4577

# Spell check result.

4578

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

4579

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

4580

},

4581

"totalSize": 42, # The precise result count, which is available only if the client set

4582

# enable_precise_result_size to `true`, or if the response

4583

# is the last page of results. Otherwise, the value is `-1`.

4584

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

4585

{ # Output only.

4586

#

4587

# Job entry with metadata inside SearchJobsResponse.

4588

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

4589

# fields that most closely match a search query's keywords, if available.

4590

# All HTML tags in the original fields are stripped when returned in this

4591

# field, and matching query keywords are enclosed in HTML bold tags.

4592

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

4593

# or "job requisition"). A job belongs to a Company, which is the hiring

4594

# entity responsible for the job.

4595

"languageCode": "A String", # Optional.

4596

#

4597

# The language of the posting. This field is distinct from

4598

# any requirements for fluency that are associated with the job.

4599

#

4600

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

4601

# For more information, see

4602

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

4603

# class="external" target="_blank" }.

4604

#

4605

# If this field is unspecified and Job.description is present, detected

4606

# language code based on Job.description is assigned, otherwise

4607

# defaults to 'en_US'.

4608

"addresses": [ # Optional but strongly recommended for the best service experience.

4609

#

4610

# Location(s) where the employer is looking to hire for this job posting.

4611

#

4612

# Specifying the full street address(es) of the hiring location enables

4613

# better API results, especially job searches by commute time.

4614

#

4615

# At most 50 locations are allowed for best search performance. If a job has

4616

# more locations, it is suggested to split it into multiple jobs with unique

4617

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

4618

# multiple jobs with the same company_name, language_code and

4619

# requisition_id are not allowed. If the original requisition_id must

4620

# be preserved, a custom field should be used for storage. It is also

4621

# suggested to group the locations that close to each other in the same job

4622

# for better search experience.

4623

#

4624

# The maximum number of allowed characters is 500.

4625

"A String",

4626

],

4627

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

4628

"promotionValue": 42, # Optional.

4629

#

4630

# A promotion value of the job, as determined by the client.

4631

# The value determines the sort order of the jobs returned when searching for

4632

# jobs using the featured jobs search call, with higher promotional values

4633

# being returned first and ties being resolved by relevance sort. Only the

4634

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

4635

#

4636

# Default value is 0, and negative values are treated as 0.

4637

"employmentTypes": [ # Optional.

4638

#

4639

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

4645

#

4646

# The end timestamp of the job. Typically this field is used for contracting

4647

# engagements. Invalid timestamps are ignored.

4648

"description": "A String", # Required.

4649

#

4650

# The description of the job, which typically includes a multi-paragraph

4651

# description of the company and related information. Separate fields are

4652

# provided on the job object for responsibilities,

4653

# qualifications, and other job characteristics. Use of

4654

# these separate job fields is recommended.

4655

#

4656

# This field accepts and sanitizes HTML input, and also accepts

4657

# bold, italic, ordered list, and unordered list markup tags.

4658

#

4659

# The maximum number of allowed characters is 100,000.

4660

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

4661

# experience.

4662

#

4663

# The expiration timestamp of the job. After this timestamp, the

4664

# job is marked as expired, and it no longer appears in search results. The

4665

# expired job can't be deleted or listed by the DeleteJob and

4666

# ListJobs APIs, but it can be retrieved with the GetJob API or

4667

# updated with the UpdateJob API. An expired job can be updated and

4668

# opened again by using a future expiration timestamp. Updating an expired

4669

# job fails if there is another existing open job with same company_name,

4670

# language_code and requisition_id.

4671

#

4672

# The expired jobs are retained in our system for 90 days. However, the

4673

# overall expired job count cannot exceed 3 times the maximum of open jobs

4674

# count over the past week, otherwise jobs with earlier expire time are

4675

# cleaned first. Expired jobs are no longer accessible after they are cleaned

4676

# out.

4677

#

4678

# Invalid timestamps are ignored, and treated as expire time not provided.

4679

#

4680

# Timestamp before the instant request is made is considered valid, the job

4681

# will be treated as expired immediately.

4682

#

4683

# If this value is not provided at the time of job creation or is invalid,

4684

# the job posting expires after 30 days from the job's creation time. For

4685

# example, if the job was created on 2017/01/01 13:00AM UTC with an

4686

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

4687

#

4688

# If this value is not provided on job update, it depends on the field masks

4689

# set by UpdateJobRequest.update_mask. If the field masks include

4690

# expiry_time, or the masks are empty meaning that every field is

4691

# updated, the job posting expires after 30 days from the job's last

4692

# update time. Otherwise the expiration date isn't updated.

4693

"title": "A String", # Required.

4694

#

4695

# The title of the job, such as "Software Engineer"

4696

#

4697

# The maximum number of allowed characters is 500.

4698

"responsibilities": "A String", # Optional.

4699

#

4700

# A description of job responsibilities. The use of this field is

4701

# recommended as an alternative to using the more general description

4702

# field.

4703

#

4704

# This field accepts and sanitizes HTML input, and also accepts

4705

# bold, italic, ordered list, and unordered list markup tags.

4706

#

4707

# The maximum number of allowed characters is 10,000.

4708

"jobStartTime": "A String", # Optional.

4709

#

4710

# The start timestamp of the job in UTC time zone. Typically this field

4711

# is used for contracting engagements. Invalid timestamps are ignored.

4712

"compensationInfo": { # Job compensation details. # Optional.

4713

#

4714

# Job compensation information.

4715

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

4716

# all compensation entries' CompensationEntry.compensation times

4717

# CompensationEntry.expected_units_per_year.

4718

#

4719

# See CompensationEntry for explanation on compensation annualization.

4720

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

4721

#

4722

# The minimum amount of compensation. If left empty, the value is set

4723

# to zero and the currency code is set to match the

4724

# currency code of max_compensation.

4725

"nanos": 42, # Number of nano (10^-9) units of the amount.

4726

# The value must be between -999,999,999 and +999,999,999 inclusive.

4727

# If `units` is positive, `nanos` must be positive or zero.

4728

# If `units` is zero, `nanos` can be positive, zero, or negative.

4729

# If `units` is negative, `nanos` must be negative or zero.

4730

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4731

"units": "A String", # The whole units of the amount.

4732

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4733

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4734

},

4735

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

4736

#

4737

# The maximum amount of compensation. If left empty, the value is set

4738

# to a maximal compensation value and the currency code is set to

4739

# match the currency code of

4740

# min_compensation.

4741

"nanos": 42, # Number of nano (10^-9) units of the amount.

4742

# The value must be between -999,999,999 and +999,999,999 inclusive.

4743

# If `units` is positive, `nanos` must be positive or zero.

4744

# If `units` is zero, `nanos` can be positive, zero, or negative.

4745

# If `units` is negative, `nanos` must be negative or zero.

4746

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4747

"units": "A String", # The whole units of the amount.

4748

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4749

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4750

},

4751

},

4752

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

4753

# base compensation entry's CompensationEntry.compensation times

4754

# CompensationEntry.expected_units_per_year.

4755

#

4756

# See CompensationEntry for explanation on compensation annualization.

4757

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

4758

#

4759

# The minimum amount of compensation. If left empty, the value is set

4760

# to zero and the currency code is set to match the

4761

# currency code of max_compensation.

4762

"nanos": 42, # Number of nano (10^-9) units of the amount.

4763

# The value must be between -999,999,999 and +999,999,999 inclusive.

4764

# If `units` is positive, `nanos` must be positive or zero.

4765

# If `units` is zero, `nanos` can be positive, zero, or negative.

4766

# If `units` is negative, `nanos` must be negative or zero.

4767

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4768

"units": "A String", # The whole units of the amount.

4769

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4770

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4771

},

4772

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

4773

#

4774

# The maximum amount of compensation. If left empty, the value is set

4775

# to a maximal compensation value and the currency code is set to

4776

# match the currency code of

4777

# min_compensation.

4778

"nanos": 42, # Number of nano (10^-9) units of the amount.

4779

# The value must be between -999,999,999 and +999,999,999 inclusive.

4780

# If `units` is positive, `nanos` must be positive or zero.

4781

# If `units` is zero, `nanos` can be positive, zero, or negative.

4782

# If `units` is negative, `nanos` must be negative or zero.

4783

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4784

"units": "A String", # The whole units of the amount.

4785

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4786

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4787

},

4788

},

4789

"entries": [ # Optional.

4790

#

4791

# Job compensation information.

4792

#

4793

# At most one entry can be of type

4794

# CompensationInfo.CompensationType.BASE, which is

4795

# referred as ** base compensation entry ** for the job.

4796

{ # A compensation entry that represents one component of compensation, such

4797

# as base pay, bonus, or other compensation type.

4798

#

4799

# Annualization: One compensation entry can be annualized if

4800

# - it contains valid amount or range.

4801

# - and its expected_units_per_year is set or can be derived.

4802

# Its annualized range is determined as (amount or range) times

4803

# expected_units_per_year.

4804

"description": "A String", # Optional.

4805

#

4806

# Compensation description. For example, could

4807

# indicate equity terms or provide additional context to an estimated

4808

# bonus.

4809

"range": { # Compensation range. # Optional.

4810

#

4811

# Compensation range.

4812

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

4813

#

4814

# The minimum amount of compensation. If left empty, the value is set

4815

# to zero and the currency code is set to match the

4816

# currency code of max_compensation.

4817

"nanos": 42, # Number of nano (10^-9) units of the amount.

4818

# The value must be between -999,999,999 and +999,999,999 inclusive.

4819

# If `units` is positive, `nanos` must be positive or zero.

4820

# If `units` is zero, `nanos` can be positive, zero, or negative.

4821

# If `units` is negative, `nanos` must be negative or zero.

4822

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4823

"units": "A String", # The whole units of the amount.

4824

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4825

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4826

},

4827

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

4828

#

4829

# The maximum amount of compensation. If left empty, the value is set

4830

# to a maximal compensation value and the currency code is set to

4831

# match the currency code of

4832

# min_compensation.

4833

"nanos": 42, # Number of nano (10^-9) units of the amount.

4834

# The value must be between -999,999,999 and +999,999,999 inclusive.

4835

# If `units` is positive, `nanos` must be positive or zero.

4836

# If `units` is zero, `nanos` can be positive, zero, or negative.

4837

# If `units` is negative, `nanos` must be negative or zero.

4838

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4839

"units": "A String", # The whole units of the amount.

4840

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4841

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4842

},

4843

},

4844

"expectedUnitsPerYear": 3.14, # Optional.

4845

#

4846

# Expected number of units paid each year. If not specified, when

4847

# Job.employment_types is FULLTIME, a default value is inferred

4848

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"amount": { # Represents an amount of money with its currency type. # Optional.

4855

#

4856

# Compensation amount.

4857

"nanos": 42, # Number of nano (10^-9) units of the amount.

4858

# The value must be between -999,999,999 and +999,999,999 inclusive.

4859

# If `units` is positive, `nanos` must be positive or zero.

4860

# If `units` is zero, `nanos` can be positive, zero, or negative.

4861

# If `units` is negative, `nanos` must be negative or zero.

4862

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4863

"units": "A String", # The whole units of the amount.

4864

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4865

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4866

},

4867

"type": "A String", # Optional.

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

4872

"unit": "A String", # Optional.

4873

#

4874

# Frequency of the specified amount.

4875

#

4876

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

4881

#

4882

# The department or functional area within the company with the open

4883

# position.

4884

#

4885

# The maximum number of allowed characters is 255.

4886

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

4887

"requisitionId": "A String", # Required.

4888

#

4889

# The requisition ID, also referred to as the posting ID, assigned by the

4890

# client to identify a job. This field is intended to be used by clients

4891

# for client identification and tracking of postings. A job is not allowed

4892

# to be created if there is another job with the same [company_name],

4893

# language_code and requisition_id.

4894

#

4895

# The maximum number of allowed characters is 255.

4896

"postingPublishTime": "A String", # Optional.

4897

#

4898

# The timestamp this job posting was most recently published. The default

4899

# value is the time the request arrives at the server. Invalid timestamps are

4900

# ignored.

4901

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

4902

#

4903

# Job application information.

4904

"instruction": "A String", # Optional but at least one of uris,

4905

# emails or instruction must be

4906

# specified.

4907

#

4908

# Use this field to provide instructions, such as "Mail your application

4909

# to ...", that a candidate can follow to apply for the job.

4910

#

4911

# This field accepts and sanitizes HTML input, and also accepts

4912

# bold, italic, ordered list, and unordered list markup tags.

4913

#

4914

# The maximum number of allowed characters is 3,000.

4915

"emails": [ # Optional but at least one of uris,

4916

# emails or instruction must be

4917

# specified.

4918

#

4919

# Use this field to specify email address(es) to which resumes or

4920

# applications can be sent.

4921

#

4922

# The maximum number of allowed characters for each entry is 255.

4923

"A String",

4924

],

4925

"uris": [ # Optional but at least one of uris,

4926

# emails or instruction must be

4927

# specified.

4928

#

4929

# Use this URI field to direct an applicant to a website, for example to

4930

# link to an online application form.

4931

#

4932

# The maximum number of allowed characters for each entry is 2,000.

"A String",

],

},

"companyName": "A String", # Required.

4937

#

4938

# The resource name of the company listing the job, such as

4939

# "projects/api-test-project/companies/foo".

4940

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

4941

#

4942

# Derived details about the job posting.

4943

"jobCategories": [ # Job categories derived from Job.title and Job.description.

4944

"A String",

4945

],

4946

"locations": [ # Structured locations of the job, resolved from Job.addresses.

4947

#

4948

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

4953

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

4954

# location bounding box in which a circle with the specified radius

4955

# centered from LatLng covers the area associated with the job location.

4956

# For example, currently, "Mountain View, CA, USA" has a radius of

4957

# 6.17 miles.

4958

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4959

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4960

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4961

# LocationType#LOCALITY.

4962

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4963

# of doubles representing degrees latitude and degrees longitude. Unless

4964

# specified otherwise, this must conform to the

4965

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4966

# standard</a>. Values must be within normalized ranges.

4967

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4968

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4969

},

4970

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4971

# such as postal delivery and payments addresses. Given a postal address,

4972

# a postal service can deliver items to a premises, P.O. Box, or other

4973

# delivery location.

4974

# Given a postal address, a postal service can deliver items to a premise, P.O.

4975

# Box or similar.

4976

# It is not intended to model geographical locations (roads, towns,

4977

# mountains).

4978

#

4979

# In typical usage an address would be created via user input or from importing

4980

# existing data, depending on the type of process.

4981

#

4982

# Advice on address input / editing:

4983

# - Use an i18n-ready address widget such as

4984

# https://github.com/googlei18n/libaddressinput)

4985

# - Users should not be presented with UI elements for input or editing of

4986

# fields outside countries where that field is used.

4987

#

4988

# For more guidance on how to use this schema, please see:

4989

# https://support.google.com/business/answer/6397478

4990

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4991

# known). This is often the UI language of the input form or is expected

4992

# to match one of the languages used in the address' country/region, or their

4993

# transliterated equivalents.

4994

# This can affect formatting in certain countries, but is not critical

4995

# to the correctness of the data and will never affect any validation or

4996

# other non-formatting related operations.

4997

#

4998

# If this value is not known, it should be omitted (rather than specifying a

4999

# possibly incorrect default).

5000

#

5001

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

5002

"recipients": [ # Optional. The recipient at the address.

5003

# This field may, under certain circumstances, contain multiline information.

5004

# For example, it might contain "care of" information.

5005

"A String",

5006

],

5007

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

5008

# Examples: US city, IT comune, UK post town.

5009

# In regions of the world where localities are not well defined or do not fit

5010

# into this structure well, leave locality empty and use address_lines.

5011

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

5012

# in most regions. Where it is used, the value is either a string like

5013

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

5014

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

5015

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

5016

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

5017

# is never inferred and it is up to the user to ensure the value is

5018

# correct. See http://cldr.unicode.org/ and

5019

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5020

# for details. Example: "CH" for Switzerland.

5021

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

5022

# addresses of a country or region.

5023

# For example, this can be a state, a province, an oblast, or a prefecture.

5024

# Specifically, for Spain this is the province and not the autonomous

5025

# community (e.g. "Barcelona" and not "Catalonia").

5026

# Many countries don't use an administrative area in postal addresses. E.g.

5027

# in Switzerland this should be left unpopulated.

5028

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

5029

#

5030

# Because values in address_lines do not have type information and may

5031

# sometimes contain multiple values in a single field (e.g.

5032

# "Austin, TX"), it is important that the line order is clear. The order of

5033

# address lines should be "envelope order" for the country/region of the

5034

# address. In places where this can vary (e.g. Japan), address_language is

5035

# used to make it explicit (e.g. "ja" for large-to-small ordering and

5036

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

5037

# an address can be selected based on the language.

5038

#

5039

# The minimum permitted structural representation of an address consists

5040

# of a region_code with all remaining information placed in the

5041

# address_lines. It would be possible to format such an address very

5042

# approximately without geocoding, but no semantic reasoning could be

5043

# made about any of the address components until it was at least

5044

# partially resolved.

5045

#

5046

# Creating an address only containing a region_code and address_lines, and

5047

# then geocoding is the recommended way to handle completely unstructured

5048

# addresses (as opposed to guessing which parts of the address should be

5049

# localities or administrative areas).

5050

"A String",

5051

],

5052

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

5053

# postal codes to be present, but where they are used, they may trigger

5054

# additional validation with other parts of the address (e.g. state/zip

5055

# validation in the U.S.A.).

5056

"organization": "A String", # Optional. The name of the organization at the address.

5057

"sublocality": "A String", # Optional. Sublocality of the address.

5058

# For example, this can be neighborhoods, boroughs, districts.

5059

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

5060

# the latest revision.

5061

#

5062

# All new revisions **must** be backward compatible with old revisions.

},

},

],

},

"incentives": "A String", # Optional.

5068

#

5069

# A description of bonus, commission, and other compensation

5070

# incentives associated with the job not including salary or pay.

5071

#

5072

# The maximum number of allowed characters is 10,000.

5073

"jobBenefits": [ # Optional.

5074

#

5075

# The benefits included with the job.

5076

"A String",

5077

],

5078

"qualifications": "A String", # Optional.

5079

#

5080

# A description of the qualifications required to perform the

5081

# job. The use of this field is recommended

5082

# as an alternative to using the more general description field.

5083

#

5084

# This field accepts and sanitizes HTML input, and also accepts

5085

# bold, italic, ordered list, and unordered list markup tags.

5086

#

5087

# The maximum number of allowed characters is 10,000.

5088

"visibility": "A String", # Optional.

5089

#

5090

# The visibility of the job.

5091

#

5092

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

5093

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

5094

"postingRegion": "A String", # Optional.

5095

#

5096

# The job PostingRegion (for example, state, country) throughout which

5097

# the job is available. If this field is set, a

5098

# LocationFilter in a search query within the job region

5099

# finds this job posting if an exact location match isn't specified.

5100

# If this field is set to PostingRegion.NATION or

5101

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

5102

# to the same location level as this field is strongly recommended.

5103

"name": "A String", # Required during job update.

5104

#

5105

# The resource name for the job. This is generated by the service when a

5106

# job is created.

5107

#

5108

# The format is "projects/{project_id}/jobs/{job_id}",

5109

# for example, "projects/api-test-project/jobs/1234".

5110

#

5111

# Use of this field in job queries and API calls is preferred over the use of

5112

# requisition_id since this value is unique.

5113

"processingOptions": { # Input only. # Optional.

5114

#

5115

# Options for job processing.

5116

#

5117

# Options for job processing.

5118

"htmlSanitization": "A String", # Optional.

5119

#

5120

# Option for job HTML content sanitization. Applied fields are:

5121

#

5122

# * description

5123

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

5129

# disabled.

5130

#

5131

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

5132

"disableStreetAddressResolution": True or False, # Optional.

5133

#

5134

# If set to `true`, the service does not attempt to resolve a

5135

# more precise address for the job.

5136

},

5137

"degreeTypes": [ # Optional.

5138

#

5139

# The desired education degrees for the job, such as Bachelors, Masters.

5140

"A String",

5141

],

5142

"customAttributes": { # Optional.

5143

#

5144

# A map of fields to hold both filterable and non-filterable custom job

5145

# attributes that are not covered by the provided structured fields.

5146

#

5147

# The keys of the map are strings up to 64 bytes and must match the

5148

# pattern: a-zA-Z*. For example, key0LikeThis or

5149

# KEY_1_LIKE_THIS.

5150

#

5151

# At most 100 filterable and at most 100 unfilterable keys are supported.

5152

# For filterable `string_values`, across all keys at most 200 values are

5153

# allowed, with each string no more than 255 characters. For unfilterable

5154

# `string_values`, the maximum total size of `string_values` across all keys

5155

# is 50KB.

5156

"a_key": { # Custom attribute values that are either filterable or non-filterable.

5157

"filterable": True or False, # Optional.

5158

#

5159

# If the `filterable` flag is true, custom field values are searchable.

5160

# If false, values are not searchable.

5161

#

5162

# Default is false.

5163

"stringValues": [ # Optional but exactly one of string_values or long_values must

5164

# be specified.

5165

#

5166

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

5167

# `CASE_INSENSITIVE_MATCH`) search.

5168

# For filterable `string_value`s, a maximum total number of 200 values

5169

# is allowed, with each `string_value` has a byte size of no more than

5170

# 255B. For unfilterable `string_values`, the maximum total byte size of

5171

# unfilterable `string_values` is 50KB.

5172

#

5173

# Empty string is not allowed.

5174

"A String",

5175

],

5176

"longValues": [ # Optional but exactly one of string_values or long_values must

5177

# be specified.

5178

#

5179

# This field is used to perform number range search.

5180

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

5181

#

5182

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

5188

#

5189

# The experience level associated with the job, such as "Entry Level".

5190

},

5191

"commuteInfo": { # Output only. # Commute information which is generated based on specified

5192

# CommuteFilter.

5193

#

5194

# Commute details related to this job.

5195

"travelDuration": "A String", # The number of seconds required to travel to the job location from the

5196

# query location. A duration of 0 seconds indicates that the job is not

5197

# reachable within the requested duration, but was returned as part of an

5198

# expanded query.

5199

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

5200

#

5201

# A resource that represents a location with full geographic information.

5202

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

5203

# location bounding box in which a circle with the specified radius

5204

# centered from LatLng covers the area associated with the job location.

5205

# For example, currently, "Mountain View, CA, USA" has a radius of

5206

# 6.17 miles.

5207

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

5208

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

5209

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

5210

# LocationType#LOCALITY.

5211

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

5212

# of doubles representing degrees latitude and degrees longitude. Unless

5213

# specified otherwise, this must conform to the

5214

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5215

# standard</a>. Values must be within normalized ranges.

5216

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5217

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5218

},

5219

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

5220

# such as postal delivery and payments addresses. Given a postal address,

5221

# a postal service can deliver items to a premises, P.O. Box, or other

5222

# delivery location.

5223

# Given a postal address, a postal service can deliver items to a premise, P.O.

5224

# Box or similar.

5225

# It is not intended to model geographical locations (roads, towns,

5226

# mountains).

5227

#

5228

# In typical usage an address would be created via user input or from importing

5229

# existing data, depending on the type of process.

5230

#

5231

# Advice on address input / editing:

5232

# - Use an i18n-ready address widget such as

5233

# https://github.com/googlei18n/libaddressinput)

5234

# - Users should not be presented with UI elements for input or editing of

5235

# fields outside countries where that field is used.

5236

#

5237

# For more guidance on how to use this schema, please see:

5238

# https://support.google.com/business/answer/6397478

5239

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

5240

# known). This is often the UI language of the input form or is expected

5241

# to match one of the languages used in the address' country/region, or their

5242

# transliterated equivalents.

5243

# This can affect formatting in certain countries, but is not critical

5244

# to the correctness of the data and will never affect any validation or

5245

# other non-formatting related operations.

5246

#

5247

# If this value is not known, it should be omitted (rather than specifying a

5248

# possibly incorrect default).

5249

#

5250

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

5251

"recipients": [ # Optional. The recipient at the address.

5252

# This field may, under certain circumstances, contain multiline information.

5253

# For example, it might contain "care of" information.

5254

"A String",

5255

],

5256

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

5257

# Examples: US city, IT comune, UK post town.

5258

# In regions of the world where localities are not well defined or do not fit

5259

# into this structure well, leave locality empty and use address_lines.

5260

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

5261

# in most regions. Where it is used, the value is either a string like

5262

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

5263

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

5264

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

5265

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

5266

# is never inferred and it is up to the user to ensure the value is

5267

# correct. See http://cldr.unicode.org/ and

5268

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5269

# for details. Example: "CH" for Switzerland.

5270

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

5271

# addresses of a country or region.

5272

# For example, this can be a state, a province, an oblast, or a prefecture.

5273

# Specifically, for Spain this is the province and not the autonomous

5274

# community (e.g. "Barcelona" and not "Catalonia").

5275

# Many countries don't use an administrative area in postal addresses. E.g.

5276

# in Switzerland this should be left unpopulated.

5277

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

5278

#

5279

# Because values in address_lines do not have type information and may

5280

# sometimes contain multiple values in a single field (e.g.

5281

# "Austin, TX"), it is important that the line order is clear. The order of

5282

# address lines should be "envelope order" for the country/region of the

5283

# address. In places where this can vary (e.g. Japan), address_language is

5284

# used to make it explicit (e.g. "ja" for large-to-small ordering and

5285

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

5286

# an address can be selected based on the language.

5287

#

5288

# The minimum permitted structural representation of an address consists

5289

# of a region_code with all remaining information placed in the

5290

# address_lines. It would be possible to format such an address very

5291

# approximately without geocoding, but no semantic reasoning could be

5292

# made about any of the address components until it was at least

5293

# partially resolved.

5294

#

5295

# Creating an address only containing a region_code and address_lines, and

5296

# then geocoding is the recommended way to handle completely unstructured

5297

# addresses (as opposed to guessing which parts of the address should be

5298

# localities or administrative areas).

5299

"A String",

5300

],

5301

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

5302

# postal codes to be present, but where they are used, they may trigger

5303

# additional validation with other parts of the address (e.g. state/zip

5304

# validation in the U.S.A.).

5305

"organization": "A String", # Optional. The name of the organization at the address.

5306

"sublocality": "A String", # Optional. Sublocality of the address.

5307

# For example, this can be neighborhoods, boroughs, districts.

5308

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

5309

# the latest revision.

5310

#

5311

# All new revisions **must** be backward compatible with old revisions.

},

},

},

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

5316

# results listing page.

5317

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

5318

# closely matching a search query's keywords, if available. The matching

5319

# query keywords are enclosed in HTML bold tags.

5320

},

5321

],

5322

"histogramResults": { # Output only. # The histogram results that match specified

5323

# SearchJobsRequest.histogram_facets.

5324

#

5325

# Histogram results that match HistogramFacets specified in

5326

# SearchJobsRequest.

5327

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match

5328

# HistogramFacets.custom_attribute_histogram_facets.

5329

{ # Output only.

5330

#

5331

# Custom attribute histogram result.

5332

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

5333

# custom attribute long values associated with `key`.

5334

#

5335

# Custom numeric bucketing result.

5336

"counts": [ # Count within each bucket. Its size is the length of

5337

# NumericBucketingOption.bucket_bounds plus 1.

5338

{ # Represents count of jobs within one bucket.

5339

"count": 42, # Number of jobs whose numeric field value fall into `range`.

5340

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

5341

# that is, the count represents number of jobs in this range.

5342

"to": 3.14, # Ending value of the bucket range.

5343

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

5348

# [NumericBucketingOption.requires_min_max] is set to true.

5349

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

5350

# [NumericBucketingOption.requires_min_max] is set to true.

5351

},

5352

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

5353

# with `key` to the number of jobs with that value in this histogram result.

5354

"a_key": 42,

5355

},

5356

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

5357

},

5358

],

5359

"simpleHistogramResults": [ # Specifies histogram results that matches

5360

# HistogramFacets.simple_histogram_facets.

5361

{ # Output only.

5362

#

5363

# Result of a histogram call. The response contains the histogram map for the

5364

# search type specified by HistogramResult.field.

5365

# The response is a map of each filter value to the corresponding count of

5366

# jobs for that filter.

5367

"values": { # A map from the values of field to the number of jobs with that value

5368

# in this search result.

5369

#

5370

# Key: search type (filter names, such as the companyName).

5371

#

5372

# Values: the count of jobs that match the filter for this search.

5373

"a_key": 42,

5374

},

5375

"searchType": "A String", # The Histogram search filters.

5376

},

5377

],

5378

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that match

5379

# HistogramFacets.compensation_histogram_requests.

5380

{ # Output only.

5381

#

5382

# Compensation based histogram result.

5383

"type": "A String", # Type of the request, corresponding to

5384

# CompensationHistogramRequest.type.

5385

"result": { # Output only. # Histogram result.

5386

#

5387

# Custom numeric bucketing result.

5388

"counts": [ # Count within each bucket. Its size is the length of

5389

# NumericBucketingOption.bucket_bounds plus 1.

5390

{ # Represents count of jobs within one bucket.

5391

"count": 42, # Number of jobs whose numeric field value fall into `range`.

5392

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

5393

# that is, the count represents number of jobs in this range.

5394

"to": 3.14, # Ending value of the bucket range.

5395

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

5400

# [NumericBucketingOption.requires_min_max] is set to true.

5401

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

5402

# [NumericBucketingOption.requires_min_max] is set to true.

},

},

],

},

"estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.

5408

#

5409

# This number is not guaranteed to be accurate. For accurate results,

5410

# see enable_precise_result_size.

5411

"broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the

5412

# broadened query. This number indicates how many of the jobs returned in the

5413

# jobs field are from the broadened query. These results are always at the

5414

# end of the jobs list. In particular, a value of 0, or if the field isn't

5415

# set, all the jobs in the jobs list are from the original

5416

# (without broadening) query. If this field is non-zero, subsequent requests

5417

# with offset after this result set should contain all broadened results.

5418

"locationFilters": [ # The location filters that the service applied to the specified query. If

5419

# any filters are lat-lng based, the JobLocation.location_type is

5420

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

5421

{ # Output only.

5422

#

5423

# A resource that represents a location with full geographic information.

5424

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

5425

# location bounding box in which a circle with the specified radius

5426

# centered from LatLng covers the area associated with the job location.

5427

# For example, currently, "Mountain View, CA, USA" has a radius of

5428

# 6.17 miles.

5429

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

5430

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

5431

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

5432

# LocationType#LOCALITY.

5433

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

5434

# of doubles representing degrees latitude and degrees longitude. Unless

5435

# specified otherwise, this must conform to the

5436

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5437

# standard</a>. Values must be within normalized ranges.

5438

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5439

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5440

},

5441

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

5442

# such as postal delivery and payments addresses. Given a postal address,

5443

# a postal service can deliver items to a premises, P.O. Box, or other

5444

# delivery location.

5445

# Given a postal address, a postal service can deliver items to a premise, P.O.

5446

# Box or similar.

5447

# It is not intended to model geographical locations (roads, towns,

5448

# mountains).

5449

#

5450

# In typical usage an address would be created via user input or from importing

5451

# existing data, depending on the type of process.

5452

#

5453

# Advice on address input / editing:

5454

# - Use an i18n-ready address widget such as

5455

# https://github.com/googlei18n/libaddressinput)

5456

# - Users should not be presented with UI elements for input or editing of

5457

# fields outside countries where that field is used.

5458

#

5459

# For more guidance on how to use this schema, please see:

5460

# https://support.google.com/business/answer/6397478

5461

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

5462

# known). This is often the UI language of the input form or is expected

5463

# to match one of the languages used in the address' country/region, or their

5464

# transliterated equivalents.

5465

# This can affect formatting in certain countries, but is not critical

5466

# to the correctness of the data and will never affect any validation or

5467

# other non-formatting related operations.

5468

#

5469

# If this value is not known, it should be omitted (rather than specifying a

5470

# possibly incorrect default).

5471

#

5472

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

5473

"recipients": [ # Optional. The recipient at the address.

5474

# This field may, under certain circumstances, contain multiline information.

5475

# For example, it might contain "care of" information.

5476

"A String",

5477

],

5478

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

5479

# Examples: US city, IT comune, UK post town.

5480

# In regions of the world where localities are not well defined or do not fit

5481

# into this structure well, leave locality empty and use address_lines.

5482

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

5483

# in most regions. Where it is used, the value is either a string like

5484

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

5485

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

5486

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

5487

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

5488

# is never inferred and it is up to the user to ensure the value is

5489

# correct. See http://cldr.unicode.org/ and

5490

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5491

# for details. Example: "CH" for Switzerland.

5492

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

5493

# addresses of a country or region.

5494

# For example, this can be a state, a province, an oblast, or a prefecture.

5495

# Specifically, for Spain this is the province and not the autonomous

5496

# community (e.g. "Barcelona" and not "Catalonia").

5497

# Many countries don't use an administrative area in postal addresses. E.g.

5498

# in Switzerland this should be left unpopulated.

5499

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

5500

#

5501

# Because values in address_lines do not have type information and may

5502

# sometimes contain multiple values in a single field (e.g.

5503

# "Austin, TX"), it is important that the line order is clear. The order of

5504

# address lines should be "envelope order" for the country/region of the

5505

# address. In places where this can vary (e.g. Japan), address_language is

5506

# used to make it explicit (e.g. "ja" for large-to-small ordering and

5507

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

5508

# an address can be selected based on the language.

5509

#

5510

# The minimum permitted structural representation of an address consists

5511

# of a region_code with all remaining information placed in the

5512

# address_lines. It would be possible to format such an address very

5513

# approximately without geocoding, but no semantic reasoning could be

5514

# made about any of the address components until it was at least

5515

# partially resolved.

5516

#

5517

# Creating an address only containing a region_code and address_lines, and

5518

# then geocoding is the recommended way to handle completely unstructured

5519

# addresses (as opposed to guessing which parts of the address should be

5520

# localities or administrative areas).

5521

"A String",

5522

],

5523

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

5524

# postal codes to be present, but where they are used, they may trigger

5525

# additional validation with other parts of the address (e.g. state/zip

5526

# validation in the U.S.A.).

5527

"organization": "A String", # Optional. The name of the organization at the address.

5528

"sublocality": "A String", # Optional. Sublocality of the address.

5529

# For example, this can be neighborhoods, boroughs, districts.

5530

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

5531

# the latest revision.

5532

#

5533

# All new revisions **must** be backward compatible with old revisions.

},

},

],

"metadata": { # Output only. # Additional information for the API invocation, such as the request

5538

# tracking id.

5539

#

5540

# Additional information returned to client, such as debugging information.

5541

"requestId": "A String", # A unique id associated with this call.

5542

# This id is logged for tracking purposes.

},

}</pre>

</div>

<code class="details" id="searchForAlert">searchForAlert(parent, body, x__xgafv=None)</code>

5549

<pre>Searches for jobs using the provided SearchJobsRequest.

5550

5551

This API call is intended for the use case of targeting passive job

5552

seekers (for example, job seekers who have signed up to receive email

5553

alerts about potential job opportunities), and has different algorithmic

5554

adjustments that are targeted to passive job seekers.

5555

5556

This call constrains the visibility of jobs

5557

present in the database, and only returns jobs the caller has

5558

permission to search against.

5559

5560

Args:

5561

parent: string, Required.

5562

5563

The resource name of the project to search within.

5564

5565

The format is "projects/{project_id}", for example,

5566

"projects/api-test-project". (required)

5567

body: object, The request body. (required)

5568

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

5573

"orderBy": "A String", # Optional.

5574

#

5575

# The criteria determining how search results are sorted. Default is

5576

# "relevance desc".

5577

#

5578

# Supported options are:

5579

#

5580

# * "relevance desc": By relevance descending, as determined by the API

5581

# algorithms. Relevance thresholding of query results is only available

5582

# with this ordering.

5583

# * "posting`_`publish`_`time desc": By Job.posting_publish_time

5584

# descending.

5585

# * "posting`_`update`_`time desc": By Job.posting_update_time

5586

# descending.

5587

# * "title": By Job.title ascending.

5588

# * "title desc": By Job.title descending.

5589

# * "annualized`_`base`_`compensation": By job's

5590

# CompensationInfo.annualized_base_compensation_range ascending. Jobs

5591

# whose annualized base compensation is unspecified are put at the end of

5592

# search results.

5593

# * "annualized`_`base`_`compensation desc": By job's

5594

# CompensationInfo.annualized_base_compensation_range descending. Jobs

5595

# whose annualized base compensation is unspecified are put at the end of

5596

# search results.

5597

# * "annualized`_`total`_`compensation": By job's

5598

# CompensationInfo.annualized_total_compensation_range ascending. Jobs

5599

# whose annualized base compensation is unspecified are put at the end of

5600

# search results.

5601

# * "annualized`_`total`_`compensation desc": By job's

5602

# CompensationInfo.annualized_total_compensation_range descending. Jobs

5603

# whose annualized base compensation is unspecified are put at the end of

5604

# search results.

5605

"diversificationLevel": "A String", # Optional.

5606

#

5607

# Controls whether highly similar jobs are returned next to each other in

5608

# the search results. Jobs are identified as highly similar based on

5609

# their titles, job categories, and locations. Highly similar results are

5610

# clustered so that only one representative job of the cluster is

5611

# displayed to the job seeker higher up in the results, with the other jobs

5612

# being displayed lower down in the results.

5613

#

5614

# Defaults to DiversificationLevel.SIMPLE if no value

5615

# is specified.

5616

"disableKeywordMatch": True or False, # Optional.

5617

#

5618

# Controls whether to disable exact keyword match on Job.job_title,

5619

# Job.description, Job.company_display_name, Job.locations,

5620

# Job.qualifications. When disable keyword match is turned off, a

5621

# keyword match returns jobs that do not match given category filters when

5622

# there are matching keywords. For example, the query "program manager," a

5623

# result is returned even if the job posting has the title "software

5624

# developer," which does not fall into "program manager" ontology, but does

5625

# have "program manager" appearing in its description.

5626

#

5627

# For queries like "cloud" that does not contain title or

5628

# location specific ontology, jobs with "cloud" keyword matches are returned

5629

# regardless of this flag's value.

5630

#

5631

# Please use Company.keyword_searchable_custom_fields or

5632

# Company.keyword_searchable_custom_attributes if company specific

5633

# globally matched custom field/attribute string values is needed. Enabling

5634

# keyword match improves recall of subsequent search requests.

5635

#

5636

# Defaults to false.

5637

"jobQuery": { # Input only. # Optional.

5638

#

5639

# Query used to search against jobs, such as keyword, location filters, etc.

5640

#

5641

# The query required to perform a search query.

5642

"disableSpellCheck": True or False, # Optional.

5643

#

5644

# This flag controls the spell-check feature. If false, the

5645

# service attempts to correct a misspelled query,

5646

# for example, "enginee" is corrected to "engineer".

5647

#

5648

# Defaults to false: a spell check is performed.

5649

"customAttributeFilter": "A String", # Optional.

5650

#

5651

# This filter specifies a structured syntax to match against the

5652

# Job.custom_attributes marked as `filterable`.

5653

#

5654

# The syntax for this expression is a subset of SQL syntax.

5655

#

5656

# Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the

5657

# left of the operator is a custom field key and the right of the operator

5658

# is a number or a quoted string. You must escape backslash (\\) and

5659

# quote (\") characters.

5660

#

5661

# Supported functions are `LOWER([field_name])` to

5662

# perform a case insensitive match and `EMPTY([field_name])` to filter on the

5663

# existence of a key.

5664

#

5665

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

5666

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100

5667

# comparisons or functions are allowed in the expression. The expression

5668

# must be < 3000 bytes in length.

5669

#

5670

# Sample Query:

5671

# `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND

5672

# driving_years > 10`

5673

"employmentTypes": [ # Optional.

5674

#

5675

# The employment type filter specifies the employment type of jobs to

5676

# search against, such as EmploymentType.FULL_TIME.

5677

#

5678

# If a value is not specified, jobs in the search results includes any

5679

# employment type.

5680

#

5681

# If multiple values are specified, jobs in the search results include

5682

# any of the specified employment types.

5683

"A String",

5684

],

5685

"query": "A String", # Optional.

5686

#

5687

# The query string that matches against the job title, description, and

5688

# location fields.

5689

#

5690

# The maximum number of allowed characters is 255.

5691

"publishTimeRange": { # Message representing a period of time between two timestamps. # Optional.

5692

#

5693

# Jobs published within a range specified by this filter are searched

5694

# against.

5695

"endTime": "A String", # End of the period.

5696

"startTime": "A String", # Begin of the period.

5697

},

5698

"commuteFilter": { # Input only. # Optional.

5699

#

5700

# Allows filtering jobs by commute time with different travel methods (for

5701

# example, driving or public transit). Note: This only works with COMMUTE

5702

# MODE. When specified, [JobQuery.location_filters] is

5703

# ignored.

5704

#

5705

# Currently we don't support sorting by commute time.

5706

#

5707

# Parameters needed for commute search.

5708

"roadTraffic": "A String", # Optional.

5709

#

5710

# Specifies the traffic density to use when calculating commute time.

5711

"departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional.

5712

#

5713

# The departure time used to calculate traffic impact, represented as

5714

# google.type.TimeOfDay in local time zone.

5715

#

5716

# Currently traffic model is restricted to hour level resolution.

5717

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5718

# types are google.type.Date and `google.protobuf.Timestamp`.

5719

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5720

# allow the value 60 if it allows leap-seconds.

5721

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5722

# to allow the value "24:00:00" for scenarios like business closing time.

5723

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5724

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5725

},

5726

"startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required.

5727

#

5728

# The latitude and longitude of the location from which to calculate the

5729

# commute time.

5730

# of doubles representing degrees latitude and degrees longitude. Unless

5731

# specified otherwise, this must conform to the

5732

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5733

# standard</a>. Values must be within normalized ranges.

5734

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5735

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5736

},

5737

"allowImpreciseAddresses": True or False, # Optional.

5738

# If true, jobs without "precise" addresses (street level addresses or GPS

5739

# coordinates) might also be returned. For city and coarser level addresses,

5740

# text matching is used. If this field is set to false or is not specified,

5741

# only jobs that include precise addresses are returned by Commute

5742

# Search.

5743

#

5744

# Note: If `allow_imprecise_addresses` is set to true, Commute Search is not

5745

# able to calculate accurate commute times to jobs with city level and

5746

# coarser address information. Jobs with imprecise addresses will return a

5747

# `travel_duration` time of 0 regardless of distance from the job seeker.

5748

"travelDuration": "A String", # Required.

5749

#

5750

# The maximum travel time in seconds. The maximum allowed value is `3600s`

5751

# (one hour). Format is `123s`.

5752

"commuteMethod": "A String", # Required.

5753

#

5754

# The method of transportation for which to calculate the commute time.

5755

},

5756

"jobCategories": [ # Optional.

5757

#

5758

# The category filter specifies the categories of jobs to search against.

5759

# See Category for more information.

5760

#

5761

# If a value is not specified, jobs from any category are searched against.

5762

#

5763

# If multiple values are specified, jobs from any of the specified

5764

# categories are searched against.

5765

"A String",

5766

],

5767

"languageCodes": [ # Optional.

5768

#

5769

# This filter specifies the locale of jobs to search against,

5770

# for example, "en-US".

5771

#

5772

# 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".

5777

# For more information, see

5778

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

5779

#

5780

# At most 10 language code filters are allowed.

5781

"A String",

5782

],

5783

"companyNames": [ # Optional.

5784

#

5785

# This filter specifies the company entities to search against.

5786

#

5787

# If a value isn't specified, jobs are searched for against all

5788

# companies.

5789

#

5790

# If multiple values are specified, jobs are searched against the

5791

# companies specified.

5792

#

5793

# The format is "projects/{project_id}/companies/{company_id}", for example,

5794

# "projects/api-test-project/companies/foo".

5795

#

5796

# At most 20 company filters are allowed.

5797

"A String",

5798

],

5799

"companyDisplayNames": [ # Optional.

5800

#

5801

# This filter specifies the exact company display

5802

# name of the jobs to search against.

5803

#

5804

# If a value isn't specified, jobs within the search results are

5805

# associated with any company.

5806

#

5807

# If multiple values are specified, jobs within the search results may be

5808

# associated with any of the specified companies.

5809

#

5810

# At most 20 company display name filters are allowed.

5811

"A String",

5812

],

5813

"locationFilters": [ # Optional.

5814

#

5815

# The location filter specifies geo-regions containing the jobs to

5816

# search against. See LocationFilter for more information.

5817

#

5818

# If a location value isn't specified, jobs fitting the other search

5819

# criteria are retrieved regardless of where they're located.

5820

#

5821

# If multiple values are specified, jobs are retrieved from any of the

5822

# specified locations. If different values are specified for the

5823

# LocationFilter.distance_in_miles parameter, the maximum provided

5824

# distance is used for all locations.

5825

#

5826

# At most 5 location filters are allowed.

5827

{ # Input only.

5828

#

5829

# Geographic region of the search.

5830

"regionCode": "A String", # Optional.

5831

#

5832

# CLDR region code of the country/region of the address. This is used

5833

# to address ambiguity of the user-input location, for example, "Liverpool"

5834

# against "Liverpool, NY, US" or "Liverpool, UK".

5835

#

5836

# Set this field if all the jobs to search against are from a same region,

5837

# or jobs are world-wide, but the job seeker is from a specific region.

5838

#

5839

# See http://cldr.unicode.org/ and

5840

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5841

# for details. Example: "CH" for Switzerland.

5842

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional.

5843

#

5844

# The latitude and longitude of the geographic center from which to

5845

# search. This field's ignored if `address` is provided.

5846

# of doubles representing degrees latitude and degrees longitude. Unless

5847

# specified otherwise, this must conform to the

5848

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5849

# standard</a>. Values must be within normalized ranges.

5850

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5851

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5852

},

5853

"distanceInMiles": 3.14, # Optional.

5854

#

5855

#

5856

# The distance_in_miles is applied when the location being searched for is

5857

# identified as a city or smaller. When the location being searched for is a

5858

# state or larger, this field is ignored.

5859

"telecommutePreference": "A String", # Optional.

5860

#

5861

# Allows the client to return jobs without a

5862

# set location, specifically, telecommuting jobs (telecomuting is considered

5863

# by the service as a special location.

5864

# Job.posting_region indicates if a job permits telecommuting.

5865

# If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,

5866

# telecommuting jobs are searched, and address and lat_lng are

5867

# ignored. If not set or set to

5868

# TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not

5869

# searched.

5870

#

5871

# This filter can be used by itself to search exclusively for telecommuting

5872

# jobs, or it can be combined with another location

5873

# filter to search for a combination of job locations,

5874

# such as "Mountain View" or "telecommuting" jobs. However, when used in

5875

# combination with other location filters, telecommuting jobs can be

5876

# treated as less relevant than other jobs in the search response.

5877

"address": "A String", # Optional.

5878

#

5879

# The address name, such as "Mountain View" or "Bay Area".

5880

},

5881

],

5882

"compensationFilter": { # Input only. # Optional.

5883

#

5884

# This search filter is applied only to

5885

# Job.compensation_info. For example, if the filter is specified

5886

# as "Hourly job with per-hour compensation > $15", only jobs meeting

5887

# these criteria are searched. If a filter isn't defined, all open jobs

5888

# are searched.

5889

#

5890

# Filter on job compensation type and amount.

5891

"units": [ # Required.

5892

#

5893

# Specify desired `base compensation entry's`

5894

# CompensationInfo.CompensationUnit.

5895

"A String",

5896

],

5897

"range": { # Compensation range. # Optional.

5898

#

5899

# Compensation range.

5900

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

5901

#

5902

# The minimum amount of compensation. If left empty, the value is set

5903

# to zero and the currency code is set to match the

5904

# currency code of max_compensation.

5905

"nanos": 42, # Number of nano (10^-9) units of the amount.

5906

# The value must be between -999,999,999 and +999,999,999 inclusive.

5907

# If `units` is positive, `nanos` must be positive or zero.

5908

# If `units` is zero, `nanos` can be positive, zero, or negative.

5909

# If `units` is negative, `nanos` must be negative or zero.

5910

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5911

"units": "A String", # The whole units of the amount.

5912

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5913

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5914

},

5915

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

5916

#

5917

# The maximum amount of compensation. If left empty, the value is set

5918

# to a maximal compensation value and the currency code is set to

5919

# match the currency code of

5920

# min_compensation.

5921

"nanos": 42, # Number of nano (10^-9) units of the amount.

5922

# The value must be between -999,999,999 and +999,999,999 inclusive.

5923

# If `units` is positive, `nanos` must be positive or zero.

5924

# If `units` is zero, `nanos` can be positive, zero, or negative.

5925

# If `units` is negative, `nanos` must be negative or zero.

5926

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5927

"units": "A String", # The whole units of the amount.

5928

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5929

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5930

},

5931

},

5932

"type": "A String", # Required.

5933

#

5934

# Type of filter.

5935

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional.

5936

#

5937

# If set to true, jobs with unspecified compensation range fields are

# included.

},

},

"pageSize": 42, # Optional.

5942

#

5943

# A limit on the number of jobs returned in the search results.

5944

# Increasing this value above the default value of 10 can increase search

5945

# response time. The value can be between 1 and 100.

5946

"histogramFacets": { # Input only. # Optional.

5947

#

5948

# Histogram requests for jobs matching JobQuery.

5949

#

5950

# Histogram facets to be specified in SearchJobsRequest.

5951

"simpleHistogramFacets": [ # Optional.

5952

#

5953

# Specifies the simple type of histogram facets, for example,

5954

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.

5955

"A String",

5956

],

5957

"customAttributeHistogramFacets": [ # Optional.

5958

#

5959

# Specifies the custom attributes histogram requests.

5960

# Duplicate values of CustomAttributeHistogramRequest.key are not

5961

# allowed.

5962

{ # Custom attributes histogram request. An error is thrown if neither

5963

# string_value_histogram or long_value_histogram_bucketing_option has

5964

# been defined.

5965

"stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for

5966

# each key as a string.

5967

"longValueHistogramBucketingOption": { # Input only. # Optional.

5968

#

5969

# Specifies buckets used to perform a range histogram on Job's

5970

# filterable long custom field values, or min/max value requirements.

5971

#

5972

# Use this field to specify bucketing option for the histogram search response.

5973

"bucketBounds": [ # Required.

5974

#

5975

# Two adjacent values form a histogram bucket. Values should be in

5976

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

5977

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

5978

# [buckets_bound is supported.

5979

3.14,

5980

],

5981

"requiresMinMax": True or False, # Optional.

5982

#

5983

# If set to true, the histogram result includes minimum/maximum

5984

# value of the numeric field.

5985

},

5986

"key": "A String", # Required.

5987

#

5988

# Specifies the custom field key to perform a histogram on. If specified

5989

# without `long_value_histogram_bucketing_option`, histogram on string values

5990

# of the given `key` is triggered, otherwise histogram is performed on long

# values.

},

],

"compensationHistogramFacets": [ # Optional.

5995

#

5996

# Specifies compensation field-based histogram requests.

5997

# Duplicate values of CompensationHistogramRequest.type are not allowed.

5998

{ # Input only.

5999

#

6000

# Compensation based histogram request.

6001

"bucketingOption": { # Input only. # Required.

6002

#

6003

# Numeric histogram options, like buckets, whether include min or max value.

6004

#

6005

# Use this field to specify bucketing option for the histogram search response.

6006

"bucketBounds": [ # Required.

6007

#

6008

# Two adjacent values form a histogram bucket. Values should be in

6009

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

6010

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

6011

# [buckets_bound is supported.

6012

3.14,

6013

],

6014

"requiresMinMax": True or False, # Optional.

6015

#

6016

# If set to true, the histogram result includes minimum/maximum

6017

# value of the numeric field.

6018

},

6019

"type": "A String", # Required.

6020

#

6021

# Type of the request, representing which field the histogramming should be

6022

# performed over. A single request can only specify one histogram of each

6023

# `CompensationHistogramRequestType`.

},

],

},

"enableBroadening": True or False, # Optional.

6028

#

6029

# Controls whether to broaden the search when it produces sparse results.

6030

# Broadened queries append results to the end of the matching results

# list.

#

# Defaults to false.

"searchMode": "A String", # Optional.

#

# Mode of a search.

#

# Defaults to SearchMode.JOB_SEARCH.

6039

"pageToken": "A String", # Optional.

6040

#

6041

# The token specifying the current offset within

6042

# search results. See SearchJobsResponse.next_page_token for

6043

# an explanation of how to obtain the next set of query results.

6044

"requestMetadata": { # Input only. # Required.

6045

#

6046

# The meta information collected about the job searcher, used to improve the

6047

# search quality of the service.. The identifiers, (such as `user_id`) are

6048

# provided by users, and must be unique and consistent.

6049

#

6050

# Meta information related to the job searcher or entity

6051

# conducting the job search. This information is used to improve the

6052

# performance of the service.

6053

"userId": "A String", # Required.

6054

#

6055

# A unique user identification string, as determined by the client.

6056

# To have the strongest positive impact on search quality

6057

# make sure the client-level is unique.

6058

# Obfuscate this field for privacy concerns before

6059

# providing it to the service.

6060

#

6061

# If this field is not available for some reason, send "UNKNOWN". Note

6062

# that any improvements to the model for a particular tenant

6063

# site, rely on this field being set correctly to a unique user_id.

6064

#

6065

# The maximum number of allowed characters is 255.

6066

"sessionId": "A String", # Required.

6067

#

6068

# A unique session identification string. A session is defined as the

6069

# duration of an end user's interaction with the service over a certain

6070

# period.

6071

# Obfuscate this field for privacy concerns before

6072

# providing it to the service.

6073

#

6074

# If this field is not available for some reason, send "UNKNOWN". Note

6075

# that any improvements to the model for a particular tenant

6076

# site, rely on this field being set correctly to some unique session_id.

6077

#

6078

# The maximum number of allowed characters is 255.

6079

"deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional.

6080

#

6081

# The type of device used by the job seeker at the time of the call to the

6082

# service.

6083

# other entity conducting the job search. Providing this information improves

6084

# the quality of the search results across devices.

6085

"deviceType": "A String", # Optional.

6086

#

6087

# Type of the device.

6088

"id": "A String", # Optional.

6089

#

6090

# A device-specific ID. The ID must be a unique identifier that

6091

# distinguishes the device from other devices.

6092

},

6093

"domain": "A String", # Required.

6094

#

6095

# The client-defined scope or source of the service call, which typically

6096

# is the domain on

6097

# which the service has been implemented and is currently being run.

6098

#

6099

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

6100

# job board www.foo.com and career site www.bar.com, then this field is

6101

# set to "foo.com" for use on the job board, and "bar.com" for use on the

6102

# career site.

6103

#

6104

# If this field isn't available for some reason, send "UNKNOWN".

6105

# Any improvements to the model for a particular tenant site rely on this

6106

# field being set correctly to a domain.

6107

#

6108

# The maximum number of allowed characters is 255.

6109

},

6110

"requirePreciseResultSize": True or False, # Optional.

6111

#

6112

# Controls if the search job request requires the return of a precise

6113

# count of the first 300 results. Setting this to `true` ensures

6114

# consistency in the number of results per page. Best practice is to set this

6115

# value to true if a client allows users to jump directly to a

6116

# non-sequential search results page.

6117

#

6118

# Enabling this flag may adversely impact performance.

6119

#

6120

# Defaults to false.

6121

"jobView": "A String", # Optional.

6122

#

6123

# The desired job attributes returned for jobs in the

6124

# search response. Defaults to JobView.SMALL if no value is specified.

6125

"offset": 42, # Optional.

6126

#

6127

# An integer that specifies the current offset (that is, starting result

6128

# location, amongst the jobs deemed by the API as relevant) in search

6129

# results. This field is only considered if page_token is unset.

6130

#

6131

# For example, 0 means to return results starting from the first matching

6132

# job, and 10 means to return from the 11th job. This can be used for

6133

# pagination, (for example, pageSize = 10 and offset = 10 means to return

6134

# from the second page).

6135

}

6136

6137

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.

6148

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

6149

# This field is empty if there are no more results.

6150

"spellCorrection": { # Output only. # The spell checking result, and correction.

6151

#

6152

# Spell check result.

6153

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

6154

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

6155

},

6156

"totalSize": 42, # The precise result count, which is available only if the client set

6157

# enable_precise_result_size to `true`, or if the response

6158

# is the last page of results. Otherwise, the value is `-1`.

6159

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

6160

{ # Output only.

6161

#

6162

# Job entry with metadata inside SearchJobsResponse.

6163

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

6164

# fields that most closely match a search query's keywords, if available.

6165

# All HTML tags in the original fields are stripped when returned in this

6166

# field, and matching query keywords are enclosed in HTML bold tags.

6167

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

6168

# or "job requisition"). A job belongs to a Company, which is the hiring

6169

# entity responsible for the job.

6170

"languageCode": "A String", # Optional.

6171

#

6172

# The language of the posting. This field is distinct from

6173

# any requirements for fluency that are associated with the job.

6174

#

6175

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

6176

# For more information, see

6177

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

6178

# class="external" target="_blank" }.

6179

#

6180

# If this field is unspecified and Job.description is present, detected

6181

# language code based on Job.description is assigned, otherwise

6182

# defaults to 'en_US'.

6183

"addresses": [ # Optional but strongly recommended for the best service experience.

6184

#

6185

# Location(s) where the employer is looking to hire for this job posting.

6186

#

6187

# Specifying the full street address(es) of the hiring location enables

6188

# better API results, especially job searches by commute time.

6189

#

6190

# At most 50 locations are allowed for best search performance. If a job has

6191

# more locations, it is suggested to split it into multiple jobs with unique

6192

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

6193

# multiple jobs with the same company_name, language_code and

6194

# requisition_id are not allowed. If the original requisition_id must

6195

# be preserved, a custom field should be used for storage. It is also

6196

# suggested to group the locations that close to each other in the same job

6197

# for better search experience.

6198

#

6199

# The maximum number of allowed characters is 500.

6200

"A String",

6201

],

6202

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

6203

"promotionValue": 42, # Optional.

6204

#

6205

# A promotion value of the job, as determined by the client.

6206

# The value determines the sort order of the jobs returned when searching for

6207

# jobs using the featured jobs search call, with higher promotional values

6208

# being returned first and ties being resolved by relevance sort. Only the

6209

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

6210

#

6211

# Default value is 0, and negative values are treated as 0.

6212

"employmentTypes": [ # Optional.

6213

#

6214

# The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"jobEndTime": "A String", # Optional.

6220

#

6221

# The end timestamp of the job. Typically this field is used for contracting

6222

# engagements. Invalid timestamps are ignored.

6223

"description": "A String", # Required.

6224

#

6225

# The description of the job, which typically includes a multi-paragraph

6226

# description of the company and related information. Separate fields are

6227

# provided on the job object for responsibilities,

6228

# qualifications, and other job characteristics. Use of

6229

# these separate job fields is recommended.

6230

#

6231

# This field accepts and sanitizes HTML input, and also accepts

6232

# bold, italic, ordered list, and unordered list markup tags.

6233

#

6234

# The maximum number of allowed characters is 100,000.

6235

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

6236

# experience.

6237

#

6238

# The expiration timestamp of the job. After this timestamp, the

6239

# job is marked as expired, and it no longer appears in search results. The

6240

# expired job can't be deleted or listed by the DeleteJob and

6241

# ListJobs APIs, but it can be retrieved with the GetJob API or

6242

# updated with the UpdateJob API. An expired job can be updated and

6243

# opened again by using a future expiration timestamp. Updating an expired

6244

# job fails if there is another existing open job with same company_name,

6245

# language_code and requisition_id.

6246

#

6247

# The expired jobs are retained in our system for 90 days. However, the

6248

# overall expired job count cannot exceed 3 times the maximum of open jobs

6249

# count over the past week, otherwise jobs with earlier expire time are

6250

# cleaned first. Expired jobs are no longer accessible after they are cleaned

6251

# out.

6252

#

6253

# Invalid timestamps are ignored, and treated as expire time not provided.

6254

#

6255

# Timestamp before the instant request is made is considered valid, the job

6256

# will be treated as expired immediately.

6257

#

6258

# If this value is not provided at the time of job creation or is invalid,

6259

# the job posting expires after 30 days from the job's creation time. For

6260

# example, if the job was created on 2017/01/01 13:00AM UTC with an

6261

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

6262

#

6263

# If this value is not provided on job update, it depends on the field masks

6264

# set by UpdateJobRequest.update_mask. If the field masks include

6265

# expiry_time, or the masks are empty meaning that every field is

6266

# updated, the job posting expires after 30 days from the job's last

6267

# update time. Otherwise the expiration date isn't updated.

6268

"title": "A String", # Required.

6269

#

6270

# The title of the job, such as "Software Engineer"

6271

#

6272

# The maximum number of allowed characters is 500.

6273

"responsibilities": "A String", # Optional.

6274

#

6275

# A description of job responsibilities. The use of this field is

6276

# recommended as an alternative to using the more general description

6277

# field.

6278

#

6279

# This field accepts and sanitizes HTML input, and also accepts

6280

# bold, italic, ordered list, and unordered list markup tags.

6281

#

6282

# The maximum number of allowed characters is 10,000.

6283

"jobStartTime": "A String", # Optional.

6284

#

6285

# The start timestamp of the job in UTC time zone. Typically this field

6286

# is used for contracting engagements. Invalid timestamps are ignored.

6287

"compensationInfo": { # Job compensation details. # Optional.

6288

#

6289

# Job compensation information.

6290

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

6291

# all compensation entries' CompensationEntry.compensation times

6292

# CompensationEntry.expected_units_per_year.

6293

#

6294

# See CompensationEntry for explanation on compensation annualization.

6295

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

6296

#

6297

# The minimum amount of compensation. If left empty, the value is set

6298

# to zero and the currency code is set to match the

6299

# currency code of max_compensation.

6300

"nanos": 42, # Number of nano (10^-9) units of the amount.

6301

# The value must be between -999,999,999 and +999,999,999 inclusive.

6302

# If `units` is positive, `nanos` must be positive or zero.

6303

# If `units` is zero, `nanos` can be positive, zero, or negative.

6304

# If `units` is negative, `nanos` must be negative or zero.

6305

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6306

"units": "A String", # The whole units of the amount.

6307

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6308

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6309

},

6310

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

6311

#

6312

# The maximum amount of compensation. If left empty, the value is set

6313

# to a maximal compensation value and the currency code is set to

6314

# match the currency code of

6315

# min_compensation.

6316

"nanos": 42, # Number of nano (10^-9) units of the amount.

6317

# The value must be between -999,999,999 and +999,999,999 inclusive.

6318

# If `units` is positive, `nanos` must be positive or zero.

6319

# If `units` is zero, `nanos` can be positive, zero, or negative.

6320

# If `units` is negative, `nanos` must be negative or zero.

6321

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6322

"units": "A String", # The whole units of the amount.

6323

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6324

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6325

},

6326

},

6327

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

6328

# base compensation entry's CompensationEntry.compensation times

6329

# CompensationEntry.expected_units_per_year.

6330

#

6331

# See CompensationEntry for explanation on compensation annualization.

6332

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

6333

#

6334

# The minimum amount of compensation. If left empty, the value is set

6335

# to zero and the currency code is set to match the

6336

# currency code of max_compensation.

6337

"nanos": 42, # Number of nano (10^-9) units of the amount.

6338

# The value must be between -999,999,999 and +999,999,999 inclusive.

6339

# If `units` is positive, `nanos` must be positive or zero.

6340

# If `units` is zero, `nanos` can be positive, zero, or negative.

6341

# If `units` is negative, `nanos` must be negative or zero.

6342

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6343

"units": "A String", # The whole units of the amount.

6344

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6345

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6346

},

6347

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

6348

#

6349

# The maximum amount of compensation. If left empty, the value is set

6350

# to a maximal compensation value and the currency code is set to

6351

# match the currency code of

6352

# min_compensation.

6353

"nanos": 42, # Number of nano (10^-9) units of the amount.

6354

# The value must be between -999,999,999 and +999,999,999 inclusive.

6355

# If `units` is positive, `nanos` must be positive or zero.

6356

# If `units` is zero, `nanos` can be positive, zero, or negative.

6357

# If `units` is negative, `nanos` must be negative or zero.

6358

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6359

"units": "A String", # The whole units of the amount.

6360

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6361

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6362

},

6363

},

6364

"entries": [ # Optional.

6365

#

6366

# Job compensation information.

6367

#

6368

# At most one entry can be of type

6369

# CompensationInfo.CompensationType.BASE, which is

6370

# referred as ** base compensation entry ** for the job.

6371

{ # A compensation entry that represents one component of compensation, such

6372

# as base pay, bonus, or other compensation type.

6373

#

6374

# Annualization: One compensation entry can be annualized if

6375

# - it contains valid amount or range.

6376

# - and its expected_units_per_year is set or can be derived.

6377

# Its annualized range is determined as (amount or range) times

6378

# expected_units_per_year.

6379

"description": "A String", # Optional.

6380

#

6381

# Compensation description. For example, could

6382

# indicate equity terms or provide additional context to an estimated

6383

# bonus.

6384

"range": { # Compensation range. # Optional.

6385

#

6386

# Compensation range.

6387

"minCompensation": { # Represents an amount of money with its currency type. # Optional.

6388

#

6389

# The minimum amount of compensation. If left empty, the value is set

6390

# to zero and the currency code is set to match the

6391

# currency code of max_compensation.

6392

"nanos": 42, # Number of nano (10^-9) units of the amount.

6393

# The value must be between -999,999,999 and +999,999,999 inclusive.

6394

# If `units` is positive, `nanos` must be positive or zero.

6395

# If `units` is zero, `nanos` can be positive, zero, or negative.

6396

# If `units` is negative, `nanos` must be negative or zero.

6397

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6398

"units": "A String", # The whole units of the amount.

6399

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6400

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6401

},

6402

"maxCompensation": { # Represents an amount of money with its currency type. # Optional.

6403

#

6404

# The maximum amount of compensation. If left empty, the value is set

6405

# to a maximal compensation value and the currency code is set to

6406

# match the currency code of

6407

# min_compensation.

6408

"nanos": 42, # Number of nano (10^-9) units of the amount.

6409

# The value must be between -999,999,999 and +999,999,999 inclusive.

6410

# If `units` is positive, `nanos` must be positive or zero.

6411

# If `units` is zero, `nanos` can be positive, zero, or negative.

6412

# If `units` is negative, `nanos` must be negative or zero.

6413

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6414

"units": "A String", # The whole units of the amount.

6415

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6416

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6417

},

6418

},

6419

"expectedUnitsPerYear": 3.14, # Optional.

6420

#

6421

# Expected number of units paid each year. If not specified, when

6422

# Job.employment_types is FULLTIME, a default value is inferred

6423

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"amount": { # Represents an amount of money with its currency type. # Optional.

6430

#

6431

# Compensation amount.

6432

"nanos": 42, # Number of nano (10^-9) units of the amount.

6433

# The value must be between -999,999,999 and +999,999,999 inclusive.

6434

# If `units` is positive, `nanos` must be positive or zero.

6435

# If `units` is zero, `nanos` can be positive, zero, or negative.

6436

# If `units` is negative, `nanos` must be negative or zero.

6437

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6438

"units": "A String", # The whole units of the amount.

6439

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6440

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6441

},

6442

"type": "A String", # Optional.

#

# Compensation type.

#

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

6447

"unit": "A String", # Optional.

6448

#

6449

# Frequency of the specified amount.

6450

#

6451

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

},

],

},

"department": "A String", # Optional.

6456

#

6457

# The department or functional area within the company with the open

6458

# position.

6459

#

6460

# The maximum number of allowed characters is 255.

6461

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

6462

"requisitionId": "A String", # Required.

6463

#

6464

# The requisition ID, also referred to as the posting ID, assigned by the

6465

# client to identify a job. This field is intended to be used by clients

6466

# for client identification and tracking of postings. A job is not allowed

6467

# to be created if there is another job with the same [company_name],

6468

# language_code and requisition_id.

6469

#

6470

# The maximum number of allowed characters is 255.

6471

"postingPublishTime": "A String", # Optional.

6472

#

6473

# The timestamp this job posting was most recently published. The default

6474

# value is the time the request arrives at the server. Invalid timestamps are

6475

# ignored.

6476

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

6477

#

6478

# Job application information.

6479

"instruction": "A String", # Optional but at least one of uris,

6480

# emails or instruction must be

6481

# specified.

6482

#

6483

# Use this field to provide instructions, such as "Mail your application

6484

# to ...", that a candidate can follow to apply for the job.

6485

#

6486

# This field accepts and sanitizes HTML input, and also accepts

6487

# bold, italic, ordered list, and unordered list markup tags.

6488

#

6489

# The maximum number of allowed characters is 3,000.

6490

"emails": [ # Optional but at least one of uris,

6491

# emails or instruction must be

6492

# specified.

6493

#

6494

# Use this field to specify email address(es) to which resumes or

6495

# applications can be sent.

6496

#

6497

# The maximum number of allowed characters for each entry is 255.

6498

"A String",

6499

],

6500

"uris": [ # Optional but at least one of uris,

6501

# emails or instruction must be

6502

# specified.

6503

#

6504

# Use this URI field to direct an applicant to a website, for example to

6505

# link to an online application form.

6506

#

6507

# The maximum number of allowed characters for each entry is 2,000.

"A String",

],

},

"companyName": "A String", # Required.

6512

#

6513

# The resource name of the company listing the job, such as

6514

# "projects/api-test-project/companies/foo".

6515

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

6516

#

6517

# Derived details about the job posting.

6518

"jobCategories": [ # Job categories derived from Job.title and Job.description.

6519

"A String",

6520

],

6521

"locations": [ # Structured locations of the job, resolved from Job.addresses.

6522

#

6523

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

6528

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

6529

# location bounding box in which a circle with the specified radius

6530

# centered from LatLng covers the area associated with the job location.

6531

# For example, currently, "Mountain View, CA, USA" has a radius of

6532

# 6.17 miles.

6533

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

6534

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

6535

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

6536

# LocationType#LOCALITY.

6537

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

6538

# of doubles representing degrees latitude and degrees longitude. Unless

6539

# specified otherwise, this must conform to the

6540

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6541

# standard</a>. Values must be within normalized ranges.

6542

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6543

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6544

},

6545

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

6546

# such as postal delivery and payments addresses. Given a postal address,

6547

# a postal service can deliver items to a premises, P.O. Box, or other

6548

# delivery location.

6549

# Given a postal address, a postal service can deliver items to a premise, P.O.

6550

# Box or similar.

6551

# It is not intended to model geographical locations (roads, towns,

6552

# mountains).

6553

#

6554

# In typical usage an address would be created via user input or from importing

6555

# existing data, depending on the type of process.

6556

#

6557

# Advice on address input / editing:

6558

# - Use an i18n-ready address widget such as

6559

# https://github.com/googlei18n/libaddressinput)

6560

# - Users should not be presented with UI elements for input or editing of

6561

# fields outside countries where that field is used.

6562

#

6563

# For more guidance on how to use this schema, please see:

6564

# https://support.google.com/business/answer/6397478

6565

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

6566

# known). This is often the UI language of the input form or is expected

6567

# to match one of the languages used in the address' country/region, or their

6568

# transliterated equivalents.

6569

# This can affect formatting in certain countries, but is not critical

6570

# to the correctness of the data and will never affect any validation or

6571

# other non-formatting related operations.

6572

#

6573

# If this value is not known, it should be omitted (rather than specifying a

6574

# possibly incorrect default).

6575

#

6576

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

6577

"recipients": [ # Optional. The recipient at the address.

6578

# This field may, under certain circumstances, contain multiline information.

6579

# For example, it might contain "care of" information.

6580

"A String",

6581

],

6582

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

6583

# Examples: US city, IT comune, UK post town.

6584

# In regions of the world where localities are not well defined or do not fit

6585

# into this structure well, leave locality empty and use address_lines.

6586

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

6587

# in most regions. Where it is used, the value is either a string like

6588

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

6589

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

6590

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

6591

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

6592

# is never inferred and it is up to the user to ensure the value is

6593

# correct. See http://cldr.unicode.org/ and

6594

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6595

# for details. Example: "CH" for Switzerland.

6596

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

6597

# addresses of a country or region.

6598

# For example, this can be a state, a province, an oblast, or a prefecture.

6599

# Specifically, for Spain this is the province and not the autonomous

6600

# community (e.g. "Barcelona" and not "Catalonia").

6601

# Many countries don't use an administrative area in postal addresses. E.g.

6602

# in Switzerland this should be left unpopulated.

6603

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

6604

#

6605

# Because values in address_lines do not have type information and may

6606

# sometimes contain multiple values in a single field (e.g.

6607

# "Austin, TX"), it is important that the line order is clear. The order of

6608

# address lines should be "envelope order" for the country/region of the

6609

# address. In places where this can vary (e.g. Japan), address_language is

6610

# used to make it explicit (e.g. "ja" for large-to-small ordering and

6611

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

6612

# an address can be selected based on the language.

6613

#

6614

# The minimum permitted structural representation of an address consists

6615

# of a region_code with all remaining information placed in the

6616

# address_lines. It would be possible to format such an address very

6617

# approximately without geocoding, but no semantic reasoning could be

6618

# made about any of the address components until it was at least

6619

# partially resolved.

6620

#

6621

# Creating an address only containing a region_code and address_lines, and

6622

# then geocoding is the recommended way to handle completely unstructured

6623

# addresses (as opposed to guessing which parts of the address should be

6624

# localities or administrative areas).

6625

"A String",

6626

],

6627

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

6628

# postal codes to be present, but where they are used, they may trigger

6629

# additional validation with other parts of the address (e.g. state/zip

6630

# validation in the U.S.A.).

6631

"organization": "A String", # Optional. The name of the organization at the address.

6632

"sublocality": "A String", # Optional. Sublocality of the address.

6633

# For example, this can be neighborhoods, boroughs, districts.

6634

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

6635

# the latest revision.

6636

#

6637

# All new revisions **must** be backward compatible with old revisions.

},

},

],

},

"incentives": "A String", # Optional.

6643

#

6644

# A description of bonus, commission, and other compensation

6645

# incentives associated with the job not including salary or pay.

6646

#

6647

# The maximum number of allowed characters is 10,000.

6648

"jobBenefits": [ # Optional.

6649

#

6650

# The benefits included with the job.

6651

"A String",

6652

],

6653

"qualifications": "A String", # Optional.

6654

#

6655

# A description of the qualifications required to perform the

6656

# job. The use of this field is recommended

6657

# as an alternative to using the more general description field.

6658

#

6659

# This field accepts and sanitizes HTML input, and also accepts

6660

# bold, italic, ordered list, and unordered list markup tags.

6661

#

6662

# The maximum number of allowed characters is 10,000.

6663

"visibility": "A String", # Optional.

6664

#

6665

# The visibility of the job.

6666

#

6667

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

6668

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

6669

"postingRegion": "A String", # Optional.

6670

#

6671

# The job PostingRegion (for example, state, country) throughout which

6672

# the job is available. If this field is set, a

6673

# LocationFilter in a search query within the job region

6674

# finds this job posting if an exact location match isn't specified.

6675

# If this field is set to PostingRegion.NATION or

6676

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

6677

# to the same location level as this field is strongly recommended.

6678

"name": "A String", # Required during job update.

6679

#

6680

# The resource name for the job. This is generated by the service when a

6681

# job is created.

6682

#

6683

# The format is "projects/{project_id}/jobs/{job_id}",

6684

# for example, "projects/api-test-project/jobs/1234".

6685

#

6686

# Use of this field in job queries and API calls is preferred over the use of

6687

# requisition_id since this value is unique.

6688

"processingOptions": { # Input only. # Optional.

6689

#

6690

# Options for job processing.

6691

#

6692

# Options for job processing.

6693

"htmlSanitization": "A String", # Optional.

6694

#

6695

# Option for job HTML content sanitization. Applied fields are:

6696

#

6697

# * description

6698

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

6704

# disabled.

6705

#

6706

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

6707

"disableStreetAddressResolution": True or False, # Optional.

6708

#

6709

# If set to `true`, the service does not attempt to resolve a

6710

# more precise address for the job.

6711

},

6712

"degreeTypes": [ # Optional.

6713

#

6714

# The desired education degrees for the job, such as Bachelors, Masters.

6715

"A String",

6716

],

6717

"customAttributes": { # Optional.

6718

#

6719

# A map of fields to hold both filterable and non-filterable custom job

6720

# attributes that are not covered by the provided structured fields.

6721

#

6722

# The keys of the map are strings up to 64 bytes and must match the

6723

# pattern: a-zA-Z*. For example, key0LikeThis or

6724

# KEY_1_LIKE_THIS.

6725

#

6726

# At most 100 filterable and at most 100 unfilterable keys are supported.

6727

# For filterable `string_values`, across all keys at most 200 values are

6728

# allowed, with each string no more than 255 characters. For unfilterable

6729

# `string_values`, the maximum total size of `string_values` across all keys

6730

# is 50KB.

6731

"a_key": { # Custom attribute values that are either filterable or non-filterable.

6732

"filterable": True or False, # Optional.

6733

#

6734

# If the `filterable` flag is true, custom field values are searchable.

6735

# If false, values are not searchable.

6736

#

6737

# Default is false.

6738

"stringValues": [ # Optional but exactly one of string_values or long_values must

6739

# be specified.

6740

#

6741

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

6742

# `CASE_INSENSITIVE_MATCH`) search.

6743

# For filterable `string_value`s, a maximum total number of 200 values

6744

# is allowed, with each `string_value` has a byte size of no more than

6745

# 255B. For unfilterable `string_values`, the maximum total byte size of

6746

# unfilterable `string_values` is 50KB.

6747

#

6748

# Empty string is not allowed.

6749

"A String",

6750

],

6751

"longValues": [ # Optional but exactly one of string_values or long_values must

6752

# be specified.

6753

#

6754

# This field is used to perform number range search.

6755

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

6756

#

6757

# Currently at most 1 long_values is supported.

"A String",

],

},

},

"jobLevel": "A String", # Optional.

6763

#

6764

# The experience level associated with the job, such as "Entry Level".

6765

},

6766

"commuteInfo": { # Output only. # Commute information which is generated based on specified

6767

# CommuteFilter.

6768

#

6769

# Commute details related to this job.

6770

"travelDuration": "A String", # The number of seconds required to travel to the job location from the

6771

# query location. A duration of 0 seconds indicates that the job is not

6772

# reachable within the requested duration, but was returned as part of an

6773

# expanded query.

6774

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

6775

#

6776

# A resource that represents a location with full geographic information.

6777

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

6778

# location bounding box in which a circle with the specified radius

6779

# centered from LatLng covers the area associated with the job location.

6780

# For example, currently, "Mountain View, CA, USA" has a radius of

6781

# 6.17 miles.

6782

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

6783

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

6784

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

6785

# LocationType#LOCALITY.

6786

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

6787

# of doubles representing degrees latitude and degrees longitude. Unless

6788

# specified otherwise, this must conform to the

6789

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6790

# standard</a>. Values must be within normalized ranges.

6791

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6792

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6793

},

6794

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

6795

# such as postal delivery and payments addresses. Given a postal address,

6796

# a postal service can deliver items to a premises, P.O. Box, or other

6797

# delivery location.

6798

# Given a postal address, a postal service can deliver items to a premise, P.O.

6799

# Box or similar.

6800

# It is not intended to model geographical locations (roads, towns,

6801

# mountains).

6802

#

6803

# In typical usage an address would be created via user input or from importing

6804

# existing data, depending on the type of process.

6805

#

6806

# Advice on address input / editing:

6807

# - Use an i18n-ready address widget such as

6808

# https://github.com/googlei18n/libaddressinput)

6809

# - Users should not be presented with UI elements for input or editing of

6810

# fields outside countries where that field is used.

6811

#

6812

# For more guidance on how to use this schema, please see:

6813

# https://support.google.com/business/answer/6397478

6814

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

6815

# known). This is often the UI language of the input form or is expected

6816

# to match one of the languages used in the address' country/region, or their

6817

# transliterated equivalents.

6818

# This can affect formatting in certain countries, but is not critical

6819

# to the correctness of the data and will never affect any validation or

6820

# other non-formatting related operations.

6821

#

6822

# If this value is not known, it should be omitted (rather than specifying a

6823

# possibly incorrect default).

6824

#

6825

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

6826

"recipients": [ # Optional. The recipient at the address.

6827

# This field may, under certain circumstances, contain multiline information.

6828

# For example, it might contain "care of" information.

6829

"A String",

6830

],

6831

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

6832

# Examples: US city, IT comune, UK post town.

6833

# In regions of the world where localities are not well defined or do not fit

6834

# into this structure well, leave locality empty and use address_lines.

6835

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

6836

# in most regions. Where it is used, the value is either a string like

6837

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

6838

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

6839

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

6840

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

6841

# is never inferred and it is up to the user to ensure the value is

6842

# correct. See http://cldr.unicode.org/ and

6843

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6844

# for details. Example: "CH" for Switzerland.

6845

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

6846

# addresses of a country or region.

6847

# For example, this can be a state, a province, an oblast, or a prefecture.

6848

# Specifically, for Spain this is the province and not the autonomous

6849

# community (e.g. "Barcelona" and not "Catalonia").

6850

# Many countries don't use an administrative area in postal addresses. E.g.

6851

# in Switzerland this should be left unpopulated.

6852

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

6853

#

6854

# Because values in address_lines do not have type information and may

6855

# sometimes contain multiple values in a single field (e.g.

6856

# "Austin, TX"), it is important that the line order is clear. The order of

6857

# address lines should be "envelope order" for the country/region of the

6858

# address. In places where this can vary (e.g. Japan), address_language is

6859

# used to make it explicit (e.g. "ja" for large-to-small ordering and

6860

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

6861

# an address can be selected based on the language.

6862

#

6863

# The minimum permitted structural representation of an address consists

6864

# of a region_code with all remaining information placed in the

6865

# address_lines. It would be possible to format such an address very

6866

# approximately without geocoding, but no semantic reasoning could be

6867

# made about any of the address components until it was at least

6868

# partially resolved.

6869

#

6870

# Creating an address only containing a region_code and address_lines, and

6871

# then geocoding is the recommended way to handle completely unstructured

6872

# addresses (as opposed to guessing which parts of the address should be

6873

# localities or administrative areas).

6874

"A String",

6875

],

6876

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

6877

# postal codes to be present, but where they are used, they may trigger

6878

# additional validation with other parts of the address (e.g. state/zip

6879

# validation in the U.S.A.).

6880

"organization": "A String", # Optional. The name of the organization at the address.

6881

"sublocality": "A String", # Optional. Sublocality of the address.

6882

# For example, this can be neighborhoods, boroughs, districts.

6883

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

6884

# the latest revision.

6885

#

6886

# All new revisions **must** be backward compatible with old revisions.

},

},

},

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

6891

# results listing page.

6892

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

6893

# closely matching a search query's keywords, if available. The matching

6894

# query keywords are enclosed in HTML bold tags.

6895

},

6896

],

6897

"histogramResults": { # Output only. # The histogram results that match specified

6898

# SearchJobsRequest.histogram_facets.

6899

#

6900

# Histogram results that match HistogramFacets specified in

6901

# SearchJobsRequest.

6902

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match

6903

# HistogramFacets.custom_attribute_histogram_facets.

6904

{ # Output only.

6905

#

6906

# Custom attribute histogram result.

6907

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

6908

# custom attribute long values associated with `key`.

6909

#

6910

# Custom numeric bucketing result.

6911

"counts": [ # Count within each bucket. Its size is the length of

6912

# NumericBucketingOption.bucket_bounds plus 1.

6913

{ # Represents count of jobs within one bucket.

6914

"count": 42, # Number of jobs whose numeric field value fall into `range`.

6915

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

6916

# that is, the count represents number of jobs in this range.

6917

"to": 3.14, # Ending value of the bucket range.

6918

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

6923

# [NumericBucketingOption.requires_min_max] is set to true.

6924

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

6925

# [NumericBucketingOption.requires_min_max] is set to true.

6926

},

6927

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

6928

# with `key` to the number of jobs with that value in this histogram result.

6929

"a_key": 42,

6930

},

6931

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

6932

},

6933

],

6934

"simpleHistogramResults": [ # Specifies histogram results that matches

6935

# HistogramFacets.simple_histogram_facets.

6936

{ # Output only.

6937

#

6938

# Result of a histogram call. The response contains the histogram map for the

6939

# search type specified by HistogramResult.field.

6940

# The response is a map of each filter value to the corresponding count of

6941

# jobs for that filter.

6942

"values": { # A map from the values of field to the number of jobs with that value

6943

# in this search result.

6944

#

6945

# Key: search type (filter names, such as the companyName).

6946

#

6947

# Values: the count of jobs that match the filter for this search.

6948

"a_key": 42,

6949

},

6950

"searchType": "A String", # The Histogram search filters.

6951

},

6952

],

6953

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that match

6954

# HistogramFacets.compensation_histogram_requests.

6955

{ # Output only.

6956

#

6957

# Compensation based histogram result.

6958

"type": "A String", # Type of the request, corresponding to

6959

# CompensationHistogramRequest.type.

6960

"result": { # Output only. # Histogram result.

6961

#

6962

# Custom numeric bucketing result.

6963

"counts": [ # Count within each bucket. Its size is the length of

6964

# NumericBucketingOption.bucket_bounds plus 1.

6965

{ # Represents count of jobs within one bucket.

6966

"count": 42, # Number of jobs whose numeric field value fall into `range`.

6967

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

6968

# that is, the count represents number of jobs in this range.

6969

"to": 3.14, # Ending value of the bucket range.

6970

"from": 3.14, # Starting value of the bucket range.

},

},

],

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

6975

# [NumericBucketingOption.requires_min_max] is set to true.

6976

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

6977

# [NumericBucketingOption.requires_min_max] is set to true.

},

},

],

},

"estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.

6983

#

6984

# This number is not guaranteed to be accurate. For accurate results,

6985

# see enable_precise_result_size.

6986

"broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the

6987

# broadened query. This number indicates how many of the jobs returned in the

6988

# jobs field are from the broadened query. These results are always at the

6989

# end of the jobs list. In particular, a value of 0, or if the field isn't

6990

# set, all the jobs in the jobs list are from the original

6991

# (without broadening) query. If this field is non-zero, subsequent requests

6992

# with offset after this result set should contain all broadened results.

6993

"locationFilters": [ # The location filters that the service applied to the specified query. If

6994

# any filters are lat-lng based, the JobLocation.location_type is

6995

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

6996

{ # Output only.

6997

#

6998

# A resource that represents a location with full geographic information.

6999

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

7000

# location bounding box in which a circle with the specified radius

7001

# centered from LatLng covers the area associated with the job location.

7002

# For example, currently, "Mountain View, CA, USA" has a radius of

7003

# 6.17 miles.

7004

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

7005

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

7006

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

7007

# LocationType#LOCALITY.

7008

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

7009

# of doubles representing degrees latitude and degrees longitude. Unless

7010

# specified otherwise, this must conform to the

7011

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

7012

# standard</a>. Values must be within normalized ranges.

7013

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

7014

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

7015

},

7016

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

7017

# such as postal delivery and payments addresses. Given a postal address,

7018

# a postal service can deliver items to a premises, P.O. Box, or other

7019

# delivery location.

7020

# Given a postal address, a postal service can deliver items to a premise, P.O.

7021

# Box or similar.

7022

# It is not intended to model geographical locations (roads, towns,

7023

# mountains).

7024

#

7025

# In typical usage an address would be created via user input or from importing

7026

# existing data, depending on the type of process.

7027

#

7028

# Advice on address input / editing:

7029

# - Use an i18n-ready address widget such as

7030

# https://github.com/googlei18n/libaddressinput)

7031

# - Users should not be presented with UI elements for input or editing of

7032

# fields outside countries where that field is used.

7033

#

7034

# For more guidance on how to use this schema, please see:

7035

# https://support.google.com/business/answer/6397478

7036

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

7037

# known). This is often the UI language of the input form or is expected

7038

# to match one of the languages used in the address' country/region, or their

7039

# transliterated equivalents.

7040

# This can affect formatting in certain countries, but is not critical

7041

# to the correctness of the data and will never affect any validation or

7042

# other non-formatting related operations.

7043

#

7044

# If this value is not known, it should be omitted (rather than specifying a

7045

# possibly incorrect default).

7046

#

7047

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

7048

"recipients": [ # Optional. The recipient at the address.

7049

# This field may, under certain circumstances, contain multiline information.

7050

# For example, it might contain "care of" information.

7051

"A String",

7052

],

7053

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

7054

# Examples: US city, IT comune, UK post town.

7055

# In regions of the world where localities are not well defined or do not fit

7056

# into this structure well, leave locality empty and use address_lines.

7057

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

7058

# in most regions. Where it is used, the value is either a string like

7059

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

7060

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

7061

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

7062

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

7063

# is never inferred and it is up to the user to ensure the value is

7064

# correct. See http://cldr.unicode.org/ and

7065

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

7066

# for details. Example: "CH" for Switzerland.

7067

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

7068

# addresses of a country or region.

7069

# For example, this can be a state, a province, an oblast, or a prefecture.

7070

# Specifically, for Spain this is the province and not the autonomous

7071

# community (e.g. "Barcelona" and not "Catalonia").

7072

# Many countries don't use an administrative area in postal addresses. E.g.

7073

# in Switzerland this should be left unpopulated.

7074

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

7075

#

7076

# Because values in address_lines do not have type information and may

7077

# sometimes contain multiple values in a single field (e.g.

7078

# "Austin, TX"), it is important that the line order is clear. The order of

7079

# address lines should be "envelope order" for the country/region of the

7080

# address. In places where this can vary (e.g. Japan), address_language is

7081

# used to make it explicit (e.g. "ja" for large-to-small ordering and

7082

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

7083

# an address can be selected based on the language.

7084

#

7085

# The minimum permitted structural representation of an address consists

7086

# of a region_code with all remaining information placed in the

7087

# address_lines. It would be possible to format such an address very

7088

# approximately without geocoding, but no semantic reasoning could be

7089

# made about any of the address components until it was at least

7090

# partially resolved.

7091

#

7092

# Creating an address only containing a region_code and address_lines, and

7093

# then geocoding is the recommended way to handle completely unstructured

7094

# addresses (as opposed to guessing which parts of the address should be

7095

# localities or administrative areas).

7096

"A String",

7097

],

7098

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

7099

# postal codes to be present, but where they are used, they may trigger

7100

# additional validation with other parts of the address (e.g. state/zip

7101

# validation in the U.S.A.).

7102

"organization": "A String", # Optional. The name of the organization at the address.

7103

"sublocality": "A String", # Optional. Sublocality of the address.

7104

# For example, this can be neighborhoods, boroughs, districts.

7105

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

7106

# the latest revision.

7107

#

7108

# All new revisions **must** be backward compatible with old revisions.

},

},

],

"metadata": { # Output only. # Additional information for the API invocation, such as the request

7113

# tracking id.

7114

#

7115

# Additional information returned to client, such as debugging information.

7116

"requestId": "A String", # A unique id associated with this call.

7117

# This id is logged for tracking purposes.

},

}</pre>

</div>

<code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code>

7124

<pre>Retrieves the next page of results.

7125

7126

Args:

7127

previous_request: The request for the previous page. (required)

7128

previous_response: The response from the request for the previous page. (required)

7129

7130

Returns:

7131

A request object that you can call 'execute()' on to request the next

7132

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>

7138

<pre>Retrieves the next page of results.

7139

7140

Args:

7141

previous_request: The request for the previous page. (required)

7142

previous_response: The response from the request for the previous page. (required)

7143

7144

Returns:

7145

A request object that you can call 'execute()' on to request the next

7146

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>