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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

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

80

Dan O'Meara

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

[diff] [blame]

81

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

Bu Sun Kim

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

[diff] [blame]

82

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

83

84

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

85

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

86

87

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

88

<p class="firstline">Retrieves the specified job, whose status is OPEN or recently EXPIRED</p>

89

Bu Sun Kim

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

Dan O'Meara

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

105

<code><a href="#searchForAlert_next">searchForAlert_next(previous_request, previous_response)</a></code></p>

106

<p class="firstline">Retrieves the next page of results.</p>

107

108

<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>

109

<p class="firstline">Retrieves the next page of results.</p>

110

<h3>Method Details</h3>

111

Dan O'Meara

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

<pre>Deletes a list of Jobs by filter.

114

115

Args:

Dan O'Meara

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

[diff] [blame]

116

parent: string, Required. The resource name of the project under which the job is created.

Bu Sun Kim

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

[diff] [blame]

117

Bu Sun Kim

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

[diff] [blame]

118

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

119

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

Dan O'Meara

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

[diff] [blame]

120

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

121

The object takes the form of:

{ # Input only.

#

# Batch delete jobs request.

Bu Sun Kim

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

[diff] [blame]

126

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

Bu Sun Kim

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

[diff] [blame]

127

#

128

# Supported operator: =, AND

129

#

130

# The fields eligible for filtering are:

131

#

132

# * `companyName` (Required)

133

# * `requisitionId` (Required)

134

#

Bu Sun Kim

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

[diff] [blame]

135

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

136

# requisitionId = "req-1"

Bu Sun Kim

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

[diff] [blame]

137

}

138

139

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

146

147

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

148

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

149

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

150

#

151

# service Foo {

152

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

153

# }

154

#

155

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

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

160

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

Bu Sun Kim

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

[diff] [blame]

161

<pre>Creates a new job.

162

163

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

164

up to 5 minutes.

165

166

Args:

Dan O'Meara

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

[diff] [blame]

167

parent: string, Required. The resource name of the project under which the job is created.

Bu Sun Kim

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

[diff] [blame]

168

Bu Sun Kim

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

[diff] [blame]

169

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

170

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

Dan O'Meara

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

[diff] [blame]

171

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

172

The object takes the form of:

{ # Input only.

#

# Create job request.

Bu Sun Kim

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

[diff] [blame]

177

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

178

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

Bu Sun Kim

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

[diff] [blame]

179

# entity responsible for the job.

Bu Sun Kim

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

[diff] [blame]

180

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

Bu Sun Kim

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

[diff] [blame]

181

#

Bu Sun Kim

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

[diff] [blame]

182

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

183

# job is created.

Bu Sun Kim

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

[diff] [blame]

184

#

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

187

#

188

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

189

# requisition_id since this value is unique.

190

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

191

"A String",

Bu Sun Kim

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

[diff] [blame]

192

],

Bu Sun Kim

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

[diff] [blame]

193

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

Bu Sun Kim

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

[diff] [blame]

194

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

195

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

196

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

Dan O'Meara

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

[diff] [blame]

197

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

Bu Sun Kim

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

[diff] [blame]

198

#

199

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

Bu Sun Kim

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

[diff] [blame]

200

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

Bu Sun Kim

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

[diff] [blame]

201

#

202

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

203

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

Bu Sun Kim

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

[diff] [blame]

204

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

205

# job. The use of this field is recommended

206

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

Bu Sun Kim

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

[diff] [blame]

207

#

Dan O'Meara

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

[diff] [blame]

208

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

209

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

Bu Sun Kim

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

[diff] [blame]

210

#

Bu Sun Kim

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

[diff] [blame]

211

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

Bu Sun Kim

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

[diff] [blame]

212

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

213

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

214

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

215

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

216

# language_code and requisition_id.

217

#

218

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame]

219

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

220

#

221

# Options for job processing.

222

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

223

# more precise address for the job.

224

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

225

#

226

# * description

227

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

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

233

# disabled.

234

#

235

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

236

},

237

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

238

# engagements. Invalid timestamps are ignored.

239

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

Bu Sun Kim

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

[diff] [blame]

240

#

241

# Derived details about the job posting.

Bu Sun Kim

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

#

244

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

# order.

{ # Output only.

#

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

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

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

252

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

253

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

254

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

Bu Sun Kim

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

[diff] [blame]

255

# of doubles representing degrees latitude and degrees longitude. Unless

256

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

257

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

Dan O'Meara

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

[diff] [blame]

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

Bu Sun Kim

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

[diff] [blame]

261

},

Bu Sun Kim

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

[diff] [blame]

262

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

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

265

# delivery location.

266

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

267

# Box or similar.

268

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

269

# mountains).

270

#

271

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

272

# existing data, depending on the type of process.

273

#

274

# Advice on address input / editing:

275

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

276

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

Bu Sun Kim

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

[diff] [blame]

277

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

278

# fields outside countries where that field is used.

279

#

280

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

281

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

Bu Sun Kim

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

[diff] [blame]

282

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

Bu Sun Kim

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

[diff] [blame]

283

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

284

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

285

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

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

288

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

289

# transliterated equivalents.

290

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

291

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

292

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

293

#

Bu Sun Kim

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

[diff] [blame]

294

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

295

# possibly incorrect default).

296

#

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

"A String",

307

],

Bu Sun Kim

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

[diff] [blame]

308

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

309

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

310

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

311

# the latest revision.

312

#

313

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

314

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

315

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

316

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

317

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

318

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

319

# addresses of a country or region.

320

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

321

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

322

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

323

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

324

# in Switzerland this should be left unpopulated.

325

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

326

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

327

#

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

# an address can be selected based on the language.

336

#

337

# The minimum permitted structural representation of an address consists

338

# of a region_code with all remaining information placed in the

339

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

340

# approximately without geocoding, but no semantic reasoning could be

341

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

342

# partially resolved.

343

#

344

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

345

# then geocoding is the recommended way to handle completely unstructured

346

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

347

# localities or administrative areas).

348

"A String",

349

],

350

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

351

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

352

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

353

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

354

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

Bu Sun Kim

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

[diff] [blame]

355

},

Bu Sun Kim

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

[diff] [blame]

356

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

357

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

358

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

359

# LocationType#LOCALITY.

Bu Sun Kim

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

[diff] [blame]

360

},

361

],

Bu Sun Kim

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

[diff] [blame]

362

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

363

"A String",

364

],

Bu Sun Kim

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

[diff] [blame]

365

},

Bu Sun Kim

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

[diff] [blame]

366

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

367

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

368

#

369

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

Bu Sun Kim

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

[diff] [blame]

370

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

# full time or

# part time.

"A String",

],

Bu Sun Kim

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

[diff] [blame]

375

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

376

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

377

#

378

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

379

#

380

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

381

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

382

#

383

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

384

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

385

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

386

# multiple jobs with the same company_name, language_code and

387

# requisition_id are not allowed. If the original requisition_id must

388

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

389

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

390

# for better search experience.

391

#

392

# The maximum number of allowed characters is 500.

393

"A String",

394

],

395

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

396

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

397

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

398

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

399

# provided on the job object for responsibilities,

400

# qualifications, and other job characteristics. Use of

401

# these separate job fields is recommended.

402

#

403

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

404

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

405

#

406

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

407

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

408

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

409

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

410

"A String",

411

],

412

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

Bu Sun Kim

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

[diff] [blame]

413

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

414

# all compensation entries' CompensationEntry.compensation times

415

# CompensationEntry.expected_units_per_year.

416

#

417

# See CompensationEntry for explanation on compensation annualization.

418

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

419

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

420

# match the currency code of

421

# min_compensation.

Bu Sun Kim

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

[diff] [blame]

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

Bu Sun Kim

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

[diff] [blame]

430

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

Bu Sun Kim

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

[diff] [blame]

431

},

432

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

433

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

434

# currency code of max_compensation.

Bu Sun Kim

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

[diff] [blame]

435

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

Bu Sun Kim

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

[diff] [blame]

443

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

Bu Sun Kim

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

[diff] [blame]

444

},

445

},

446

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

447

#

448

# At most one entry can be of type

449

# CompensationInfo.CompensationType.BASE, which is

450

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

451

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

452

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

453

#

454

# Annualization: One compensation entry can be annualized if

455

# - it contains valid amount or range.

456

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

457

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

458

# expected_units_per_year.

Bu Sun Kim

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

[diff] [blame]

459

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

Bu Sun Kim

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

[diff] [blame]

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

Bu Sun Kim

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

[diff] [blame]

468

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

Bu Sun Kim

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

[diff] [blame]

469

},

470

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

471

#

472

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

473

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

474

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

475

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

476

# match the currency code of

477

# min_compensation.

Bu Sun Kim

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

[diff] [blame]

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

Bu Sun Kim

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

[diff] [blame]

486

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

Bu Sun Kim

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

[diff] [blame]

487

},

488

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

489

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

490

# currency code of max_compensation.

Bu Sun Kim

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

[diff] [blame]

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

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

Bu Sun Kim

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

[diff] [blame]

499

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

Bu Sun Kim

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

[diff] [blame]

500

},

501

},

502

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

503

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

504

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

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

511

# indicate equity terms or provide additional context to an estimated

512

# bonus.

Bu Sun Kim

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

[diff] [blame]

513

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

514

#

515

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

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

[diff] [blame]

516

},

517

],

Bu Sun Kim

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

[diff] [blame]

518

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

519

# base compensation entry's CompensationEntry.compensation times

520

# CompensationEntry.expected_units_per_year.

521

#

522

# See CompensationEntry for explanation on compensation annualization.

523

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

524

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

525

# match the currency code of

526

# min_compensation.

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

},

537

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

538

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

539

# currency code of max_compensation.

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

},

550

},

Bu Sun Kim

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

[diff] [blame]

551

},

552

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

553

# recommended as an alternative to using the more general description

554

# field.

Bu Sun Kim

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

[diff] [blame]

555

#

556

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

557

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

558

#

559

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

Bu Sun Kim

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

[diff] [blame]

560

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

561

# position.

Dan O'Meara

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

[diff] [blame]

562

#

Bu Sun Kim

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

[diff] [blame]

563

# The maximum number of allowed characters is 255.

564

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

Bu Sun Kim

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

[diff] [blame]

565

#

Bu Sun Kim

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

[diff] [blame]

566

# Job application information.

567

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

568

# emails or instruction must be

569

# specified.

570

#

571

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

572

# link to an online application form.

573

#

574

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

575

"A String",

576

],

577

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

578

# emails or instruction must be

579

# specified.

580

#

581

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

582

# applications can be sent.

583

#

584

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

585

"A String",

586

],

587

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

588

# emails or instruction must be

589

# specified.

590

#

591

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

592

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

593

#

594

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

595

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

596

#

597

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

598

},

Bu Sun Kim

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

[diff] [blame]

599

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

600

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

601

# LocationFilter in a search query within the job region

602

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

603

# If this field is set to PostingRegion.NATION or

604

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

605

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

Bu Sun Kim

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

[diff] [blame]

606

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

607

# experience.

Bu Sun Kim

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

[diff] [blame]

608

#

Bu Sun Kim

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

[diff] [blame]

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

# language_code and requisition_id.

617

#

618

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

619

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

620

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

621

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

622

# out.

623

#

624

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

625

#

626

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

627

# will be treated as expired immediately.

628

#

629

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

630

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

631

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

632

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

633

#

634

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

635

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

636

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

637

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

638

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

Bu Sun Kim

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

[diff] [blame]

639

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

640

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

641

# ignored.

642

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

Bu Sun Kim

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

[diff] [blame]

643

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

644

#

645

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

646

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

647

# KEY_1_LIKE_THIS.

648

#

649

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

650

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

651

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

652

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

653

# is 50KB.

Bu Sun Kim

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

[diff] [blame]

654

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

655

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

Bu Sun Kim

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

[diff] [blame]

656

# be specified.

657

#

658

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

659

# `CASE_INSENSITIVE_MATCH`) search.

660

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

661

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

Dan O'Meara

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

[diff] [blame]

662

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

Bu Sun Kim

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

[diff] [blame]

663

# unfilterable `string_values` is 50KB.

664

#

665

# Empty string is not allowed.

Bu Sun Kim

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

[diff] [blame]

666

"A String",

Bu Sun Kim

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

[diff] [blame]

667

],

Bu Sun Kim

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

[diff] [blame]

668

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

669

# custom attribute filters JobQuery.custom_attribute_filter.

670

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

671

#

672

# Default is false.

673

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

Bu Sun Kim

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

[diff] [blame]

674

# be specified.

675

#

676

# This field is used to perform number range search.

677

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

678

#

679

# Currently at most 1 long_values is supported.

Bu Sun Kim

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

[diff] [blame]

680

"A String",

Bu Sun Kim

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

[diff] [blame]

681

],

682

},

683

},

Bu Sun Kim

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

[diff] [blame]

684

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

685

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

686

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

687

#

688

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

689

# For more information, see

690

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

691

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

692

#

693

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

694

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

695

# defaults to 'en_US'.

696

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

697

#

698

# The visibility of the job.

699

#

700

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

701

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

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

712

Bu Sun Kim

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

[diff] [blame]

713

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

714

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

Bu Sun Kim

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

[diff] [blame]

715

# entity responsible for the job.

Bu Sun Kim

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

[diff] [blame]

716

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

Bu Sun Kim

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

[diff] [blame]

717

#

Bu Sun Kim

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

[diff] [blame]

718

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

719

# job is created.

Bu Sun Kim

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

[diff] [blame]

720

#

Bu Sun Kim

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

[diff] [blame]

721

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

722

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

723

#

724

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

725

# requisition_id since this value is unique.

726

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

727

"A String",

Bu Sun Kim

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

[diff] [blame]

728

],

Bu Sun Kim

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

[diff] [blame]

729

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

Bu Sun Kim

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

[diff] [blame]

730

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

731

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

732

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

Dan O'Meara

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

[diff] [blame]

733

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

Bu Sun Kim

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

[diff] [blame]

734

#

735

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

Bu Sun Kim

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

[diff] [blame]

736

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

Bu Sun Kim

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

[diff] [blame]

737

#

738

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

739

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

Bu Sun Kim

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

[diff] [blame]

740

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

741

# job. The use of this field is recommended

742

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

Bu Sun Kim

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

[diff] [blame]

743

#

Dan O'Meara

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

[diff] [blame]

744

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

745

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

Bu Sun Kim

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

[diff] [blame]

746

#

Bu Sun Kim

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

[diff] [blame]

747

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

Bu Sun Kim

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

[diff] [blame]

748

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

749

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

750

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

751

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

752

# language_code and requisition_id.

753

#

754

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame]

755

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

756

#

757

# Options for job processing.

758

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

759

# more precise address for the job.

760

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

761

#

762

# * description

763

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

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

769

# disabled.

770

#

771

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

772

},

773

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

774

# engagements. Invalid timestamps are ignored.

775

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

Bu Sun Kim

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

[diff] [blame]

776

#

777

# Derived details about the job posting.

Bu Sun Kim

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

[diff] [blame]

778

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

Bu Sun Kim

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

[diff] [blame]

779

#

780

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

# order.

{ # Output only.

#

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

Bu Sun Kim

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

[diff] [blame]

785

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

786

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

787

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

788

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

789

# 6.17 miles.

Bu Sun Kim

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

[diff] [blame]

790

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

Bu Sun Kim

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

[diff] [blame]

791

# of doubles representing degrees latitude and degrees longitude. Unless

792

# specified otherwise, this must conform to the

Bu Sun Kim

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

[diff] [blame]

793

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

Dan O'Meara

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

[diff] [blame]

794

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

Bu Sun Kim

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

[diff] [blame]

795

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

Bu Sun Kim

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

[diff] [blame]

796

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

Bu Sun Kim

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

[diff] [blame]

797

},

Bu Sun Kim

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

[diff] [blame]

798

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

Bu Sun Kim

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

[diff] [blame]

799

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

800

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

801

# delivery location.

802

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

803

# Box or similar.

804

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

805

# mountains).

806

#

807

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

808

# existing data, depending on the type of process.

809

#

810

# Advice on address input / editing:

811

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

812

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

Bu Sun Kim

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

[diff] [blame]

813

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

814

# fields outside countries where that field is used.

815

#

816

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

817

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

Bu Sun Kim

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

[diff] [blame]

818

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

Bu Sun Kim

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

[diff] [blame]

819

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

820

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

821

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

Bu Sun Kim

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

[diff] [blame]

822

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

823

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

824

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

825

# transliterated equivalents.

826

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

827

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

828

# other non-formatting related operations.

Bu Sun Kim

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

[diff] [blame]

829

#

Bu Sun Kim

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

[diff] [blame]

830

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

831

# possibly incorrect default).

832

#

833

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

834

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

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

"A String",

843

],

Bu Sun Kim

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

[diff] [blame]

844

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

845

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

846

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

847

# the latest revision.

848

#

849

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

850

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

851

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

852

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

853

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

854

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

855

# addresses of a country or region.

856

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

857

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

858

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

859

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

860

# in Switzerland this should be left unpopulated.

861

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

862

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

863

#

864

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

865

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

866

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

867

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

868

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

869

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

870

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

871

# an address can be selected based on the language.

872

#

873

# The minimum permitted structural representation of an address consists

874

# of a region_code with all remaining information placed in the

875

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

876

# approximately without geocoding, but no semantic reasoning could be

877

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

878

# partially resolved.

879

#

880

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

881

# then geocoding is the recommended way to handle completely unstructured

882

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

883

# localities or administrative areas).

884

"A String",

885

],

886

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

887

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

888

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

889

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

890

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

Bu Sun Kim

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

[diff] [blame]

891

},

Bu Sun Kim

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

[diff] [blame]

892

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

893

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

894

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

895

# LocationType#LOCALITY.

Bu Sun Kim

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

[diff] [blame]

896

},

897

],

Bu Sun Kim

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

[diff] [blame]

898

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

899

"A String",

900

],

Bu Sun Kim

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

[diff] [blame]

901

},

Bu Sun Kim

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

[diff] [blame]

902

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

903

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

904

#

905

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

Bu Sun Kim

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

[diff] [blame]

906

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

# full time or

# part time.

"A String",

],

Bu Sun Kim

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

[diff] [blame]

911

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

912

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

913

#

914

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

915

#

916

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

917

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

918

#

919

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

920

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

921

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

922

# multiple jobs with the same company_name, language_code and

923

# requisition_id are not allowed. If the original requisition_id must

924

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

925

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

926

# for better search experience.

927

#

928

# The maximum number of allowed characters is 500.

929

"A String",

930

],

931

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

932

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

933

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

934

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

935

# provided on the job object for responsibilities,

936

# qualifications, and other job characteristics. Use of

937

# these separate job fields is recommended.

938

#

939

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

940

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

941

#

942

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

943

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

944

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

945

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

946

"A String",

947

],

948

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

Bu Sun Kim

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

[diff] [blame]

949

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

950

# all compensation entries' CompensationEntry.compensation times

951

# CompensationEntry.expected_units_per_year.

952

#

953

# See CompensationEntry for explanation on compensation annualization.

954

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

955

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

956

# match the currency code of

957

# min_compensation.

Bu Sun Kim

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

[diff] [blame]

958

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

959

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

960

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

961

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

962

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

963

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

964

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

965

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

Bu Sun Kim

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

[diff] [blame]

966

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

Bu Sun Kim

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

[diff] [blame]

967

},

968

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

969

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

970

# currency code of max_compensation.

Bu Sun Kim

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

[diff] [blame]

971

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

972

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

973

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

974

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

975

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

976

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

977

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

978

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

Bu Sun Kim

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

[diff] [blame]

979

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

Bu Sun Kim

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

[diff] [blame]

980

},

981

},

982

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

983

#

984

# At most one entry can be of type

985

# CompensationInfo.CompensationType.BASE, which is

986

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

987

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

988

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

989

#

990

# Annualization: One compensation entry can be annualized if

991

# - it contains valid amount or range.

992

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

993

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

994

# expected_units_per_year.

Bu Sun Kim

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

[diff] [blame]

995

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

Bu Sun Kim

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

[diff] [blame]

996

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

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

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

Bu Sun Kim

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

[diff] [blame]

1004

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

Bu Sun Kim

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

[diff] [blame]

1005

},

1006

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

1007

#

1008

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

1009

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

1010

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

1011

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

1012

# match the currency code of

1013

# min_compensation.

Bu Sun Kim

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

[diff] [blame]

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

Bu Sun Kim

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

[diff] [blame]

1022

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

Bu Sun Kim

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

[diff] [blame]

1023

},

1024

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

1025

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

1026

# currency code of max_compensation.

Bu Sun Kim

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

[diff] [blame]

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

Bu Sun Kim

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

[diff] [blame]

1035

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

Bu Sun Kim

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

[diff] [blame]

1036

},

1037

},

1038

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

1039

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

1040

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

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

1047

# indicate equity terms or provide additional context to an estimated

1048

# bonus.

Bu Sun Kim

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

[diff] [blame]

1049

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

1050

#

1051

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

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

[diff] [blame]

1052

},

1053

],

Bu Sun Kim

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

[diff] [blame]

1054

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

1055

# base compensation entry's CompensationEntry.compensation times

1056

# CompensationEntry.expected_units_per_year.

1057

#

1058

# See CompensationEntry for explanation on compensation annualization.

1059

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

1060

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

1061

# match the currency code of

1062

# min_compensation.

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

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

1070

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

1071

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

1072

},

1073

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

1074

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

1075

# currency code of max_compensation.

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

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

1085

},

1086

},

Bu Sun Kim

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

[diff] [blame]

1087

},

1088

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

1089

# recommended as an alternative to using the more general description

1090

# field.

Bu Sun Kim

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

[diff] [blame]

1091

#

1092

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

1093

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

1094

#

1095

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

Bu Sun Kim

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

[diff] [blame]

1096

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

1097

# position.

Dan O'Meara

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

[diff] [blame]

1098

#

Bu Sun Kim

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

[diff] [blame]

1099

# The maximum number of allowed characters is 255.

1100

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

Bu Sun Kim

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

[diff] [blame]

1101

#

Bu Sun Kim

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

[diff] [blame]

1102

# Job application information.

1103

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

1104

# emails or instruction must be

1105

# specified.

1106

#

1107

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

1108

# link to an online application form.

1109

#

1110

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

1111

"A String",

1112

],

1113

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

1114

# emails or instruction must be

1115

# specified.

1116

#

1117

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

1118

# applications can be sent.

1119

#

1120

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

1121

"A String",

1122

],

1123

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

1124

# emails or instruction must be

1125

# specified.

1126

#

1127

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

1128

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

1129

#

1130

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

1131

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

1132

#

1133

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

1134

},

Bu Sun Kim

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

[diff] [blame]

1135

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

1136

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

1137

# LocationFilter in a search query within the job region

1138

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

1139

# If this field is set to PostingRegion.NATION or

1140

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

1141

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

Bu Sun Kim

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

[diff] [blame]

1142

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

1143

# experience.

Bu Sun Kim

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

[diff] [blame]

1144

#

Bu Sun Kim

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

[diff] [blame]

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

# language_code and requisition_id.

1153

#

1154

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

1155

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

1156

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

1157

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

1158

# out.

1159

#

1160

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

1161

#

1162

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

1163

# will be treated as expired immediately.

1164

#

1165

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

1166

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

1167

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

1168

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

1169

#

1170

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

1171

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

1172

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

1173

# updated, the job posting expires after 30 days from the job's last

1174

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1175

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

1176

# value is the time the request arrives at the server. Invalid timestamps are

1177

# ignored.

1178

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1179

# attributes that are not covered by the provided structured fields.

1180

#

1181

# The keys of the map are strings up to 64 bytes and must match the

1182

# pattern: a-zA-Z*. For example, key0LikeThis or

1183

# KEY_1_LIKE_THIS.

1184

#

1185

# At most 100 filterable and at most 100 unfilterable keys are supported.

1186

# For filterable `string_values`, across all keys at most 200 values are

1187

# allowed, with each string no more than 255 characters. For unfilterable

1188

# `string_values`, the maximum total size of `string_values` across all keys

1189

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1190

"a_key": { # Custom attribute values that are either filterable or non-filterable.

1191

"stringValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1192

# be specified.

1193

#

1194

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

1195

# `CASE_INSENSITIVE_MATCH`) search.

1196

# For filterable `string_value`s, a maximum total number of 200 values

1197

# is allowed, with each `string_value` has a byte size of no more than

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1198

# 500B. For unfilterable `string_values`, the maximum total byte size of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1199

# unfilterable `string_values` is 50KB.

1200

#

1201

# Empty string is not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1202

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1203

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1204

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

1205

# custom attribute filters JobQuery.custom_attribute_filter.

1206

# If false, these values may not be used for custom attribute filters.

1207

#

1208

# Default is false.

1209

"longValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1210

# be specified.

1211

#

1212

# This field is used to perform number range search.

1213

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

1214

#

1215

# Currently at most 1 long_values is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1216

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1217

],

1218

},

1219

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1220

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

1221

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

1222

# any requirements for fluency that are associated with the job.

1223

#

1224

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

1225

# For more information, see

1226

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

1227

# class="external" target="_blank" }.

1228

#

1229

# If this field is unspecified and Job.description is present, detected

1230

# language code based on Job.description is assigned, otherwise

1231

# defaults to 'en_US'.

1232

"visibility": "A String", # Deprecated. The job is only visible to the owner.

1233

#

1234

# The visibility of the job.

1235

#

1236

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

1237

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

1243

<pre>Deletes the specified job.

1244

1245

Typically, the job becomes unsearchable within 10 seconds, but it may take

1246

up to 5 minutes.

1247

1248

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1249

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1250

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1251

The format is "projects/{project_id}/jobs/{job_id}",

1252

for example, "projects/api-test-project/jobs/1234". (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1253

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1260

1261

{ # A generic empty message that you can re-use to avoid defining duplicated

1262

# empty messages in your APIs. A typical example is to use it as the request

1263

# or the response type of an API method. For instance:

1264

#

1265

# service Foo {

1266

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1267

# }

1268

#

1269

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

1275

<pre>Retrieves the specified job, whose status is OPEN or recently EXPIRED

1276

within the last 90 days.

1277

1278

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1279

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1280

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1281

The format is "projects/{project_id}/jobs/{job_id}",

1282

for example, "projects/api-test-project/jobs/1234". (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1283

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1290

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1291

{ # A Job resource represents a job posting (also referred to as a "job listing"

1292

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1293

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1294

"name": "A String", # Required during job update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1295

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1296

# The resource name for the job. This is generated by the service when a

1297

# job is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1298

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1299

# The format is "projects/{project_id}/jobs/{job_id}",

1300

# for example, "projects/api-test-project/jobs/1234".

1301

#

1302

# Use of this field in job queries and API calls is preferred over the use of

1303

# requisition_id since this value is unique.

1304

"jobBenefits": [ # Optional. The benefits included with the job.

1305

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1306

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1307

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1308

# The value determines the sort order of the jobs returned when searching for

1309

# jobs using the featured jobs search call, with higher promotional values

1310

# being returned first and ties being resolved by relevance sort. Only the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1311

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1312

#

1313

# Default value is 0, and negative values are treated as 0.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1314

"title": "A String", # Required. The title of the job, such as "Software Engineer"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1315

#

1316

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1317

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1318

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

1319

# job. The use of this field is recommended

1320

# as an alternative to using the more general description field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1321

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1322

# This field accepts and sanitizes HTML input, and also accepts

1323

# bold, italic, ordered list, and unordered list markup tags.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1324

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1325

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1326

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

1327

# client to identify a job. This field is intended to be used by clients

1328

# for client identification and tracking of postings. A job is not allowed

1329

# to be created if there is another job with the same [company_name],

1330

# language_code and requisition_id.

1331

#

1332

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1333

"processingOptions": { # Input only. # Optional. Options for job processing.

1334

#

1335

# Options for job processing.

1336

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

1337

# more precise address for the job.

1338

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

1339

#

1340

# * description

1341

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

1347

# disabled.

1348

#

1349

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

1350

},

1351

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

1352

# engagements. Invalid timestamps are ignored.

1353

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1354

#

1355

# Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

"locations": [ # Structured locations of the job, resolved from Job.addresses.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1357

#

1358

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1363

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

1364

# location bounding box in which a circle with the specified radius

1365

# centered from LatLng covers the area associated with the job location.

1366

# For example, currently, "Mountain View, CA, USA" has a radius of

1367

# 6.17 miles.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1368

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1369

# of doubles representing degrees latitude and degrees longitude. Unless

1370

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1371

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1372

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1373

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1374

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1375

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1376

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1377

# such as postal delivery and payments addresses. Given a postal address,

1378

# a postal service can deliver items to a premises, P.O. Box, or other

1379

# delivery location.

1380

# Given a postal address, a postal service can deliver items to a premise, P.O.

1381

# Box or similar.

1382

# It is not intended to model geographical locations (roads, towns,

1383

# mountains).

1384

#

1385

# In typical usage an address would be created via user input or from importing

1386

# existing data, depending on the type of process.

1387

#

1388

# Advice on address input / editing:

1389

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1390

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1391

# - Users should not be presented with UI elements for input or editing of

1392

# fields outside countries where that field is used.

1393

#

1394

# For more guidance on how to use this schema, please see:

1395

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1396

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1397

# postal codes to be present, but where they are used, they may trigger

1398

# additional validation with other parts of the address (e.g. state/zip

1399

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1400

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

1401

# known). This is often the UI language of the input form or is expected

1402

# to match one of the languages used in the address' country/region, or their

1403

# transliterated equivalents.

1404

# This can affect formatting in certain countries, but is not critical

1405

# to the correctness of the data and will never affect any validation or

1406

# other non-formatting related operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1407

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1408

# If this value is not known, it should be omitted (rather than specifying a

1409

# possibly incorrect default).

1410

#

1411

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

1412

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

1413

# in most regions. Where it is used, the value is either a string like

1414

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

1415

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

1416

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

1417

"recipients": [ # Optional. The recipient at the address.

1418

# This field may, under certain circumstances, contain multiline information.

1419

# For example, it might contain "care of" information.

1420

"A String",

1421

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1422

"sublocality": "A String", # Optional. Sublocality of the address.

1423

# For example, this can be neighborhoods, boroughs, districts.

1424

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

1425

# the latest revision.

1426

#

1427

# All new revisions **must** be backward compatible with old revisions.

1428

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

1429

# Examples: US city, IT comune, UK post town.

1430

# In regions of the world where localities are not well defined or do not fit

1431

# into this structure well, leave locality empty and use address_lines.

1432

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

1433

# addresses of a country or region.

1434

# For example, this can be a state, a province, an oblast, or a prefecture.

1435

# Specifically, for Spain this is the province and not the autonomous

1436

# community (e.g. "Barcelona" and not "Catalonia").

1437

# Many countries don't use an administrative area in postal addresses. E.g.

1438

# in Switzerland this should be left unpopulated.

1439

"organization": "A String", # Optional. The name of the organization at the address.

1440

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

1441

#

1442

# Because values in address_lines do not have type information and may

1443

# sometimes contain multiple values in a single field (e.g.

1444

# "Austin, TX"), it is important that the line order is clear. The order of

1445

# address lines should be "envelope order" for the country/region of the

1446

# address. In places where this can vary (e.g. Japan), address_language is

1447

# used to make it explicit (e.g. "ja" for large-to-small ordering and

1448

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

1449

# an address can be selected based on the language.

1450

#

1451

# The minimum permitted structural representation of an address consists

1452

# of a region_code with all remaining information placed in the

1453

# address_lines. It would be possible to format such an address very

1454

# approximately without geocoding, but no semantic reasoning could be

1455

# made about any of the address components until it was at least

1456

# partially resolved.

1457

#

1458

# Creating an address only containing a region_code and address_lines, and

1459

# then geocoding is the recommended way to handle completely unstructured

1460

# addresses (as opposed to guessing which parts of the address should be

1461

# localities or administrative areas).

1462

"A String",

1463

],

1464

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

1465

# is never inferred and it is up to the user to ensure the value is

1466

# correct. See http://cldr.unicode.org/ and

1467

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

1468

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1469

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1470

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

1471

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

1472

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

1473

# LocationType#LOCALITY.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1474

},

1475

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1476

"jobCategories": [ # Job categories derived from Job.title and Job.description.

1477

"A String",

1478

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1479

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1480

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

1481

# incentives associated with the job not including salary or pay.

1482

#

1483

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1484

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1489

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

1490

"addresses": [ # Optional but strongly recommended for the best service experience.

1491

#

1492

# Location(s) where the employer is looking to hire for this job posting.

1493

#

1494

# Specifying the full street address(es) of the hiring location enables

1495

# better API results, especially job searches by commute time.

1496

#

1497

# At most 50 locations are allowed for best search performance. If a job has

1498

# more locations, it is suggested to split it into multiple jobs with unique

1499

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

1500

# multiple jobs with the same company_name, language_code and

1501

# requisition_id are not allowed. If the original requisition_id must

1502

# be preserved, a custom field should be used for storage. It is also

1503

# suggested to group the locations that close to each other in the same job

1504

# for better search experience.

1505

#

1506

# The maximum number of allowed characters is 500.

1507

"A String",

1508

],

1509

"companyName": "A String", # Required. The resource name of the company listing the job, such as

1510

# "projects/api-test-project/companies/foo".

1511

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

1512

# description of the company and related information. Separate fields are

1513

# provided on the job object for responsibilities,

1514

# qualifications, and other job characteristics. Use of

1515

# these separate job fields is recommended.

1516

#

1517

# This field accepts and sanitizes HTML input, and also accepts

1518

# bold, italic, ordered list, and unordered list markup tags.

1519

#

1520

# The maximum number of allowed characters is 100,000.

1521

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

1522

# is used for contracting engagements. Invalid timestamps are ignored.

1523

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

1524

"A String",

1525

],

1526

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1527

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

1528

# all compensation entries' CompensationEntry.compensation times

1529

# CompensationEntry.expected_units_per_year.

1530

#

1531

# See CompensationEntry for explanation on compensation annualization.

1532

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1533

# to a maximal compensation value and the currency code is set to

1534

# match the currency code of

1535

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1536

"nanos": 42, # Number of nano (10^-9) units of the amount.

1537

# The value must be between -999,999,999 and +999,999,999 inclusive.

1538

# If `units` is positive, `nanos` must be positive or zero.

1539

# If `units` is zero, `nanos` can be positive, zero, or negative.

1540

# If `units` is negative, `nanos` must be negative or zero.

1541

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1542

"units": "A String", # The whole units of the amount.

1543

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1544

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1545

},

1546

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1547

# to zero and the currency code is set to match the

1548

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1549

"nanos": 42, # Number of nano (10^-9) units of the amount.

1550

# The value must be between -999,999,999 and +999,999,999 inclusive.

1551

# If `units` is positive, `nanos` must be positive or zero.

1552

# If `units` is zero, `nanos` can be positive, zero, or negative.

1553

# If `units` is negative, `nanos` must be negative or zero.

1554

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1555

"units": "A String", # The whole units of the amount.

1556

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1557

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1558

},

1559

},

1560

"entries": [ # Optional. Job compensation information.

1561

#

1562

# At most one entry can be of type

1563

# CompensationInfo.CompensationType.BASE, which is

1564

# referred as ** base compensation entry ** for the job.

1565

{ # A compensation entry that represents one component of compensation, such

1566

# as base pay, bonus, or other compensation type.

1567

#

1568

# Annualization: One compensation entry can be annualized if

1569

# - it contains valid amount or range.

1570

# - and its expected_units_per_year is set or can be derived.

1571

# Its annualized range is determined as (amount or range) times

1572

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1573

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1574

"nanos": 42, # Number of nano (10^-9) units of the amount.

1575

# The value must be between -999,999,999 and +999,999,999 inclusive.

1576

# If `units` is positive, `nanos` must be positive or zero.

1577

# If `units` is zero, `nanos` can be positive, zero, or negative.

1578

# If `units` is negative, `nanos` must be negative or zero.

1579

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1580

"units": "A String", # The whole units of the amount.

1581

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1582

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1583

},

1584

"type": "A String", # Optional. Compensation type.

1585

#

1586

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

1587

"range": { # Compensation range. # Optional. Compensation range.

1588

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1589

# to a maximal compensation value and the currency code is set to

1590

# match the currency code of

1591

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1592

"nanos": 42, # Number of nano (10^-9) units of the amount.

1593

# The value must be between -999,999,999 and +999,999,999 inclusive.

1594

# If `units` is positive, `nanos` must be positive or zero.

1595

# If `units` is zero, `nanos` can be positive, zero, or negative.

1596

# If `units` is negative, `nanos` must be negative or zero.

1597

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1598

"units": "A String", # The whole units of the amount.

1599

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1600

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1601

},

1602

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1603

# to zero and the currency code is set to match the

1604

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1605

"nanos": 42, # Number of nano (10^-9) units of the amount.

1606

# The value must be between -999,999,999 and +999,999,999 inclusive.

1607

# If `units` is positive, `nanos` must be positive or zero.

1608

# If `units` is zero, `nanos` can be positive, zero, or negative.

1609

# If `units` is negative, `nanos` must be negative or zero.

1610

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1611

"units": "A String", # The whole units of the amount.

1612

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1613

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1614

},

1615

},

1616

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

1617

# Job.employment_types is FULLTIME, a default value is inferred

1618

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"description": "A String", # Optional. Compensation description. For example, could

1625

# indicate equity terms or provide additional context to an estimated

1626

# bonus.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1627

"unit": "A String", # Optional. Frequency of the specified amount.

1628

#

1629

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1630

},

1631

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1632

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

1633

# base compensation entry's CompensationEntry.compensation times

1634

# CompensationEntry.expected_units_per_year.

1635

#

1636

# See CompensationEntry for explanation on compensation annualization.

1637

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

1638

# to a maximal compensation value and the currency code is set to

1639

# match the currency code of

1640

# min_compensation.

1641

"nanos": 42, # Number of nano (10^-9) units of the amount.

1642

# The value must be between -999,999,999 and +999,999,999 inclusive.

1643

# If `units` is positive, `nanos` must be positive or zero.

1644

# If `units` is zero, `nanos` can be positive, zero, or negative.

1645

# If `units` is negative, `nanos` must be negative or zero.

1646

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1647

"units": "A String", # The whole units of the amount.

1648

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1649

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1650

},

1651

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

1652

# to zero and the currency code is set to match the

1653

# currency code of max_compensation.

1654

"nanos": 42, # Number of nano (10^-9) units of the amount.

1655

# The value must be between -999,999,999 and +999,999,999 inclusive.

1656

# If `units` is positive, `nanos` must be positive or zero.

1657

# If `units` is zero, `nanos` can be positive, zero, or negative.

1658

# If `units` is negative, `nanos` must be negative or zero.

1659

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1660

"units": "A String", # The whole units of the amount.

1661

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1662

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1663

},

1664

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1665

},

1666

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

1667

# recommended as an alternative to using the more general description

1668

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1669

#

1670

# This field accepts and sanitizes HTML input, and also accepts

1671

# bold, italic, ordered list, and unordered list markup tags.

1672

#

1673

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1674

"department": "A String", # Optional. The department or functional area within the company with the open

1675

# position.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1676

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1677

# The maximum number of allowed characters is 255.

1678

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1679

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1680

# Job application information.

1681

"uris": [ # Optional but at least one of uris,

1682

# emails or instruction must be

1683

# specified.

1684

#

1685

# Use this URI field to direct an applicant to a website, for example to

1686

# link to an online application form.

1687

#

1688

# The maximum number of allowed characters for each entry is 2,000.

1689

"A String",

1690

],

1691

"emails": [ # Optional but at least one of uris,

1692

# emails or instruction must be

1693

# specified.

1694

#

1695

# Use this field to specify email address(es) to which resumes or

1696

# applications can be sent.

1697

#

1698

# The maximum number of allowed characters for each entry is 255.

1699

"A String",

1700

],

1701

"instruction": "A String", # Optional but at least one of uris,

1702

# emails or instruction must be

1703

# specified.

1704

#

1705

# Use this field to provide instructions, such as "Mail your application

1706

# to ...", that a candidate can follow to apply for the job.

1707

#

1708

# This field accepts and sanitizes HTML input, and also accepts

1709

# bold, italic, ordered list, and unordered list markup tags.

1710

#

1711

# The maximum number of allowed characters is 3,000.

1712

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1713

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

1714

# the job is available. If this field is set, a

1715

# LocationFilter in a search query within the job region

1716

# finds this job posting if an exact location match isn't specified.

1717

# If this field is set to PostingRegion.NATION or

1718

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

1719

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1720

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

1721

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1722

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1723

# The expiration timestamp of the job. After this timestamp, the

1724

# job is marked as expired, and it no longer appears in search results. The

1725

# expired job can't be deleted or listed by the DeleteJob and

1726

# ListJobs APIs, but it can be retrieved with the GetJob API or

1727

# updated with the UpdateJob API. An expired job can be updated and

1728

# opened again by using a future expiration timestamp. Updating an expired

1729

# job fails if there is another existing open job with same company_name,

1730

# language_code and requisition_id.

1731

#

1732

# The expired jobs are retained in our system for 90 days. However, the

1733

# overall expired job count cannot exceed 3 times the maximum of open jobs

1734

# count over the past week, otherwise jobs with earlier expire time are

1735

# cleaned first. Expired jobs are no longer accessible after they are cleaned

1736

# out.

1737

#

1738

# Invalid timestamps are ignored, and treated as expire time not provided.

1739

#

1740

# Timestamp before the instant request is made is considered valid, the job

1741

# will be treated as expired immediately.

1742

#

1743

# If this value is not provided at the time of job creation or is invalid,

1744

# the job posting expires after 30 days from the job's creation time. For

1745

# example, if the job was created on 2017/01/01 13:00AM UTC with an

1746

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

1747

#

1748

# If this value is not provided on job update, it depends on the field masks

1749

# set by UpdateJobRequest.update_mask. If the field masks include

1750

# expiry_time, or the masks are empty meaning that every field is

1751

# updated, the job posting expires after 30 days from the job's last

1752

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1753

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

1754

# value is the time the request arrives at the server. Invalid timestamps are

1755

# ignored.

1756

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1757

# attributes that are not covered by the provided structured fields.

1758

#

1759

# The keys of the map are strings up to 64 bytes and must match the

1760

# pattern: a-zA-Z*. For example, key0LikeThis or

1761

# KEY_1_LIKE_THIS.

1762

#

1763

# At most 100 filterable and at most 100 unfilterable keys are supported.

1764

# For filterable `string_values`, across all keys at most 200 values are

1765

# allowed, with each string no more than 255 characters. For unfilterable

1766

# `string_values`, the maximum total size of `string_values` across all keys

1767

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1768

"a_key": { # Custom attribute values that are either filterable or non-filterable.

1769

"stringValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1770

# be specified.

1771

#

1772

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

1773

# `CASE_INSENSITIVE_MATCH`) search.

1774

# For filterable `string_value`s, a maximum total number of 200 values

1775

# is allowed, with each `string_value` has a byte size of no more than

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1776

# 500B. For unfilterable `string_values`, the maximum total byte size of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1777

# unfilterable `string_values` is 50KB.

1778

#

1779

# Empty string is not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1780

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1781

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1782

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

1783

# custom attribute filters JobQuery.custom_attribute_filter.

1784

# If false, these values may not be used for custom attribute filters.

1785

#

1786

# Default is false.

1787

"longValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1788

# be specified.

1789

#

1790

# This field is used to perform number range search.

1791

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

1792

#

1793

# Currently at most 1 long_values is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1794

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1795

],

1796

},

1797

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1798

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

1799

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

1800

# any requirements for fluency that are associated with the job.

1801

#

1802

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

1803

# For more information, see

1804

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

1805

# class="external" target="_blank" }.

1806

#

1807

# If this field is unspecified and Job.description is present, detected

1808

# language code based on Job.description is assigned, otherwise

1809

# defaults to 'en_US'.

1810

"visibility": "A String", # Deprecated. The job is only visible to the owner.

1811

#

1812

# The visibility of the job.

1813

#

1814

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

1815

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1820

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, jobView=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1821

<pre>Lists jobs by filter.

1822

1823

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1824

parent: string, Required. The resource name of the project under which the job is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1825

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1826

The format is "projects/{project_id}", for example,

1827

"projects/api-test-project". (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1828

pageToken: string, Optional. The starting point of a query result.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1829

pageSize: integer, Optional. The maximum number of jobs to be returned per page of results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1830

1831

If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed

1832

page size is 1000. Otherwise, the maximum allowed page size is 100.

1833

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1834

Default is 100 if empty or a number < 1 is specified.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1835

filter: string, Required. The filter string specifies the jobs to be enumerated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1836

1837

Supported operator: =, AND

1838

1839

The fields eligible for filtering are:

1840

1841

* `companyName` (Required)

1842

* `requisitionId` (Optional)

Sample Query:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1846

* companyName = "projects/api-test-project/companies/123"

1847

* companyName = "projects/api-test-project/companies/123" AND requisitionId

1848

= "req-1"

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1849

jobView: string, Optional. The desired job attributes returned for jobs in the

1850

search response. Defaults to JobView.JOB_VIEW_FULL if no value is

1851

specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1852

x__xgafv: string, V1 error format.

1853

Allowed values

1854

1 - v1 error format

1855

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1856

1857

Returns:

1858

An object of the form:

{ # Output only.

#

# List jobs response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1863

"nextPageToken": "A String", # A token to retrieve the next page of results.

1864

"metadata": { # Output only. # Additional information for the API invocation, such as the request

1865

# tracking id.

1866

#

1867

# Additional information returned to client, such as debugging information.

1868

"requestId": "A String", # A unique id associated with this call.

1869

# This id is logged for tracking purposes.

1870

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1871

"jobs": [ # The Jobs for a given company.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1872

#

1873

# The maximum number of items returned is based on the limit field

1874

# provided in the request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

{ # A Job resource represents a job posting (also referred to as a "job listing"

1876

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1877

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

"name": "A String", # Required during job update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1879

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1880

# The resource name for the job. This is generated by the service when a

1881

# job is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1882

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1883

# The format is "projects/{project_id}/jobs/{job_id}",

1884

# for example, "projects/api-test-project/jobs/1234".

1885

#

1886

# Use of this field in job queries and API calls is preferred over the use of

1887

# requisition_id since this value is unique.

1888

"jobBenefits": [ # Optional. The benefits included with the job.

1889

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1890

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1891

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1892

# The value determines the sort order of the jobs returned when searching for

1893

# jobs using the featured jobs search call, with higher promotional values

1894

# being returned first and ties being resolved by relevance sort. Only the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1895

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1896

#

1897

# Default value is 0, and negative values are treated as 0.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1898

"title": "A String", # Required. The title of the job, such as "Software Engineer"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1899

#

1900

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1901

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1902

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

1903

# job. The use of this field is recommended

1904

# as an alternative to using the more general description field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1905

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1906

# This field accepts and sanitizes HTML input, and also accepts

1907

# bold, italic, ordered list, and unordered list markup tags.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1908

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1909

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1910

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

1911

# client to identify a job. This field is intended to be used by clients

1912

# for client identification and tracking of postings. A job is not allowed

1913

# to be created if there is another job with the same [company_name],

1914

# language_code and requisition_id.

1915

#

1916

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1917

"processingOptions": { # Input only. # Optional. Options for job processing.

1918

#

1919

# Options for job processing.

1920

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

1921

# more precise address for the job.

1922

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

1923

#

1924

# * description

1925

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

1931

# disabled.

1932

#

1933

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

1934

},

1935

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

1936

# engagements. Invalid timestamps are ignored.

1937

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1938

#

1939

# Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1940

"locations": [ # Structured locations of the job, resolved from Job.addresses.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1941

#

1942

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1947

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

1948

# location bounding box in which a circle with the specified radius

1949

# centered from LatLng covers the area associated with the job location.

1950

# For example, currently, "Mountain View, CA, USA" has a radius of

1951

# 6.17 miles.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1952

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1953

# of doubles representing degrees latitude and degrees longitude. Unless

1954

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1955

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1956

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1957

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1958

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1959

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1960

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1961

# such as postal delivery and payments addresses. Given a postal address,

1962

# a postal service can deliver items to a premises, P.O. Box, or other

1963

# delivery location.

1964

# Given a postal address, a postal service can deliver items to a premise, P.O.

1965

# Box or similar.

1966

# It is not intended to model geographical locations (roads, towns,

1967

# mountains).

1968

#

1969

# In typical usage an address would be created via user input or from importing

1970

# existing data, depending on the type of process.

1971

#

1972

# Advice on address input / editing:

1973

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1974

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1975

# - Users should not be presented with UI elements for input or editing of

1976

# fields outside countries where that field is used.

1977

#

1978

# For more guidance on how to use this schema, please see:

1979

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1980

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1981

# postal codes to be present, but where they are used, they may trigger

1982

# additional validation with other parts of the address (e.g. state/zip

1983

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1984

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

1985

# known). This is often the UI language of the input form or is expected

1986

# to match one of the languages used in the address' country/region, or their

1987

# transliterated equivalents.

1988

# This can affect formatting in certain countries, but is not critical

1989

# to the correctness of the data and will never affect any validation or

1990

# other non-formatting related operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1991

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1992

# If this value is not known, it should be omitted (rather than specifying a

1993

# possibly incorrect default).

1994

#

1995

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

1996

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

1997

# in most regions. Where it is used, the value is either a string like

1998

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

1999

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

2000

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

2001

"recipients": [ # Optional. The recipient at the address.

2002

# This field may, under certain circumstances, contain multiline information.

2003

# For example, it might contain "care of" information.

2004

"A String",

2005

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2006

"sublocality": "A String", # Optional. Sublocality of the address.

2007

# For example, this can be neighborhoods, boroughs, districts.

2008

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

2009

# the latest revision.

2010

#

2011

# All new revisions **must** be backward compatible with old revisions.

2012

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

2013

# Examples: US city, IT comune, UK post town.

2014

# In regions of the world where localities are not well defined or do not fit

2015

# into this structure well, leave locality empty and use address_lines.

2016

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

2017

# addresses of a country or region.

2018

# For example, this can be a state, a province, an oblast, or a prefecture.

2019

# Specifically, for Spain this is the province and not the autonomous

2020

# community (e.g. "Barcelona" and not "Catalonia").

2021

# Many countries don't use an administrative area in postal addresses. E.g.

2022

# in Switzerland this should be left unpopulated.

2023

"organization": "A String", # Optional. The name of the organization at the address.

2024

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

2025

#

2026

# Because values in address_lines do not have type information and may

2027

# sometimes contain multiple values in a single field (e.g.

2028

# "Austin, TX"), it is important that the line order is clear. The order of

2029

# address lines should be "envelope order" for the country/region of the

2030

# address. In places where this can vary (e.g. Japan), address_language is

2031

# used to make it explicit (e.g. "ja" for large-to-small ordering and

2032

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

2033

# an address can be selected based on the language.

2034

#

2035

# The minimum permitted structural representation of an address consists

2036

# of a region_code with all remaining information placed in the

2037

# address_lines. It would be possible to format such an address very

2038

# approximately without geocoding, but no semantic reasoning could be

2039

# made about any of the address components until it was at least

2040

# partially resolved.

2041

#

2042

# Creating an address only containing a region_code and address_lines, and

2043

# then geocoding is the recommended way to handle completely unstructured

2044

# addresses (as opposed to guessing which parts of the address should be

2045

# localities or administrative areas).

2046

"A String",

2047

],

2048

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

2049

# is never inferred and it is up to the user to ensure the value is

2050

# correct. See http://cldr.unicode.org/ and

2051

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

2052

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2053

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2054

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

2055

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

2056

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

2057

# LocationType#LOCALITY.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2058

},

2059

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2060

"jobCategories": [ # Job categories derived from Job.title and Job.description.

2061

"A String",

2062

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2063

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2064

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

2065

# incentives associated with the job not including salary or pay.

2066

#

2067

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2068

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2073

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

2074

"addresses": [ # Optional but strongly recommended for the best service experience.

2075

#

2076

# Location(s) where the employer is looking to hire for this job posting.

2077

#

2078

# Specifying the full street address(es) of the hiring location enables

2079

# better API results, especially job searches by commute time.

2080

#

2081

# At most 50 locations are allowed for best search performance. If a job has

2082

# more locations, it is suggested to split it into multiple jobs with unique

2083

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

2084

# multiple jobs with the same company_name, language_code and

2085

# requisition_id are not allowed. If the original requisition_id must

2086

# be preserved, a custom field should be used for storage. It is also

2087

# suggested to group the locations that close to each other in the same job

2088

# for better search experience.

2089

#

2090

# The maximum number of allowed characters is 500.

2091

"A String",

2092

],

2093

"companyName": "A String", # Required. The resource name of the company listing the job, such as

2094

# "projects/api-test-project/companies/foo".

2095

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

2096

# description of the company and related information. Separate fields are

2097

# provided on the job object for responsibilities,

2098

# qualifications, and other job characteristics. Use of

2099

# these separate job fields is recommended.

2100

#

2101

# This field accepts and sanitizes HTML input, and also accepts

2102

# bold, italic, ordered list, and unordered list markup tags.

2103

#

2104

# The maximum number of allowed characters is 100,000.

2105

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

2106

# is used for contracting engagements. Invalid timestamps are ignored.

2107

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

2108

"A String",

2109

],

2110

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2111

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

2112

# all compensation entries' CompensationEntry.compensation times

2113

# CompensationEntry.expected_units_per_year.

2114

#

2115

# See CompensationEntry for explanation on compensation annualization.

2116

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2117

# to a maximal compensation value and the currency code is set to

2118

# match the currency code of

2119

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2120

"nanos": 42, # Number of nano (10^-9) units of the amount.

2121

# The value must be between -999,999,999 and +999,999,999 inclusive.

2122

# If `units` is positive, `nanos` must be positive or zero.

2123

# If `units` is zero, `nanos` can be positive, zero, or negative.

2124

# If `units` is negative, `nanos` must be negative or zero.

2125

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2126

"units": "A String", # The whole units of the amount.

2127

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2128

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2129

},

2130

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2131

# to zero and the currency code is set to match the

2132

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2133

"nanos": 42, # Number of nano (10^-9) units of the amount.

2134

# The value must be between -999,999,999 and +999,999,999 inclusive.

2135

# If `units` is positive, `nanos` must be positive or zero.

2136

# If `units` is zero, `nanos` can be positive, zero, or negative.

2137

# If `units` is negative, `nanos` must be negative or zero.

2138

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2139

"units": "A String", # The whole units of the amount.

2140

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2141

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2142

},

2143

},

2144

"entries": [ # Optional. Job compensation information.

2145

#

2146

# At most one entry can be of type

2147

# CompensationInfo.CompensationType.BASE, which is

2148

# referred as ** base compensation entry ** for the job.

2149

{ # A compensation entry that represents one component of compensation, such

2150

# as base pay, bonus, or other compensation type.

2151

#

2152

# Annualization: One compensation entry can be annualized if

2153

# - it contains valid amount or range.

2154

# - and its expected_units_per_year is set or can be derived.

2155

# Its annualized range is determined as (amount or range) times

2156

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2157

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2158

"nanos": 42, # Number of nano (10^-9) units of the amount.

2159

# The value must be between -999,999,999 and +999,999,999 inclusive.

2160

# If `units` is positive, `nanos` must be positive or zero.

2161

# If `units` is zero, `nanos` can be positive, zero, or negative.

2162

# If `units` is negative, `nanos` must be negative or zero.

2163

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2164

"units": "A String", # The whole units of the amount.

2165

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2166

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2167

},

2168

"type": "A String", # Optional. Compensation type.

2169

#

2170

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

2171

"range": { # Compensation range. # Optional. Compensation range.

2172

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2173

# to a maximal compensation value and the currency code is set to

2174

# match the currency code of

2175

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2176

"nanos": 42, # Number of nano (10^-9) units of the amount.

2177

# The value must be between -999,999,999 and +999,999,999 inclusive.

2178

# If `units` is positive, `nanos` must be positive or zero.

2179

# If `units` is zero, `nanos` can be positive, zero, or negative.

2180

# If `units` is negative, `nanos` must be negative or zero.

2181

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2182

"units": "A String", # The whole units of the amount.

2183

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2184

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2185

},

2186

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2187

# to zero and the currency code is set to match the

2188

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2189

"nanos": 42, # Number of nano (10^-9) units of the amount.

2190

# The value must be between -999,999,999 and +999,999,999 inclusive.

2191

# If `units` is positive, `nanos` must be positive or zero.

2192

# If `units` is zero, `nanos` can be positive, zero, or negative.

2193

# If `units` is negative, `nanos` must be negative or zero.

2194

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2195

"units": "A String", # The whole units of the amount.

2196

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2197

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2198

},

2199

},

2200

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

2201

# Job.employment_types is FULLTIME, a default value is inferred

2202

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"description": "A String", # Optional. Compensation description. For example, could

2209

# indicate equity terms or provide additional context to an estimated

2210

# bonus.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2211

"unit": "A String", # Optional. Frequency of the specified amount.

2212

#

2213

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2214

},

2215

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2216

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

2217

# base compensation entry's CompensationEntry.compensation times

2218

# CompensationEntry.expected_units_per_year.

2219

#

2220

# See CompensationEntry for explanation on compensation annualization.

2221

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2222

# to a maximal compensation value and the currency code is set to

2223

# match the currency code of

2224

# min_compensation.

2225

"nanos": 42, # Number of nano (10^-9) units of the amount.

2226

# The value must be between -999,999,999 and +999,999,999 inclusive.

2227

# If `units` is positive, `nanos` must be positive or zero.

2228

# If `units` is zero, `nanos` can be positive, zero, or negative.

2229

# If `units` is negative, `nanos` must be negative or zero.

2230

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2231

"units": "A String", # The whole units of the amount.

2232

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2233

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2234

},

2235

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2236

# to zero and the currency code is set to match the

2237

# currency code of max_compensation.

2238

"nanos": 42, # Number of nano (10^-9) units of the amount.

2239

# The value must be between -999,999,999 and +999,999,999 inclusive.

2240

# If `units` is positive, `nanos` must be positive or zero.

2241

# If `units` is zero, `nanos` can be positive, zero, or negative.

2242

# If `units` is negative, `nanos` must be negative or zero.

2243

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2244

"units": "A String", # The whole units of the amount.

2245

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2246

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2247

},

2248

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2249

},

2250

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

2251

# recommended as an alternative to using the more general description

2252

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2253

#

2254

# This field accepts and sanitizes HTML input, and also accepts

2255

# bold, italic, ordered list, and unordered list markup tags.

2256

#

2257

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2258

"department": "A String", # Optional. The department or functional area within the company with the open

2259

# position.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2260

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2261

# The maximum number of allowed characters is 255.

2262

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2263

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2264

# Job application information.

2265

"uris": [ # Optional but at least one of uris,

2266

# emails or instruction must be

2267

# specified.

2268

#

2269

# Use this URI field to direct an applicant to a website, for example to

2270

# link to an online application form.

2271

#

2272

# The maximum number of allowed characters for each entry is 2,000.

2273

"A String",

2274

],

2275

"emails": [ # Optional but at least one of uris,

2276

# emails or instruction must be

2277

# specified.

2278

#

2279

# Use this field to specify email address(es) to which resumes or

2280

# applications can be sent.

2281

#

2282

# The maximum number of allowed characters for each entry is 255.

2283

"A String",

2284

],

2285

"instruction": "A String", # Optional but at least one of uris,

2286

# emails or instruction must be

2287

# specified.

2288

#

2289

# Use this field to provide instructions, such as "Mail your application

2290

# to ...", that a candidate can follow to apply for the job.

2291

#

2292

# This field accepts and sanitizes HTML input, and also accepts

2293

# bold, italic, ordered list, and unordered list markup tags.

2294

#

2295

# The maximum number of allowed characters is 3,000.

2296

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2297

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

2298

# the job is available. If this field is set, a

2299

# LocationFilter in a search query within the job region

2300

# finds this job posting if an exact location match isn't specified.

2301

# If this field is set to PostingRegion.NATION or

2302

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

2303

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2304

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

2305

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2306

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2307

# The expiration timestamp of the job. After this timestamp, the

2308

# job is marked as expired, and it no longer appears in search results. The

2309

# expired job can't be deleted or listed by the DeleteJob and

2310

# ListJobs APIs, but it can be retrieved with the GetJob API or

2311

# updated with the UpdateJob API. An expired job can be updated and

2312

# opened again by using a future expiration timestamp. Updating an expired

2313

# job fails if there is another existing open job with same company_name,

2314

# language_code and requisition_id.

2315

#

2316

# The expired jobs are retained in our system for 90 days. However, the

2317

# overall expired job count cannot exceed 3 times the maximum of open jobs

2318

# count over the past week, otherwise jobs with earlier expire time are

2319

# cleaned first. Expired jobs are no longer accessible after they are cleaned

2320

# out.

2321

#

2322

# Invalid timestamps are ignored, and treated as expire time not provided.

2323

#

2324

# Timestamp before the instant request is made is considered valid, the job

2325

# will be treated as expired immediately.

2326

#

2327

# If this value is not provided at the time of job creation or is invalid,

2328

# the job posting expires after 30 days from the job's creation time. For

2329

# example, if the job was created on 2017/01/01 13:00AM UTC with an

2330

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

2331

#

2332

# If this value is not provided on job update, it depends on the field masks

2333

# set by UpdateJobRequest.update_mask. If the field masks include

2334

# expiry_time, or the masks are empty meaning that every field is

2335

# updated, the job posting expires after 30 days from the job's last

2336

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2337

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

2338

# value is the time the request arrives at the server. Invalid timestamps are

2339

# ignored.

2340

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2341

# attributes that are not covered by the provided structured fields.

2342

#

2343

# The keys of the map are strings up to 64 bytes and must match the

2344

# pattern: a-zA-Z*. For example, key0LikeThis or

2345

# KEY_1_LIKE_THIS.

2346

#

2347

# At most 100 filterable and at most 100 unfilterable keys are supported.

2348

# For filterable `string_values`, across all keys at most 200 values are

2349

# allowed, with each string no more than 255 characters. For unfilterable

2350

# `string_values`, the maximum total size of `string_values` across all keys

2351

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2352

"a_key": { # Custom attribute values that are either filterable or non-filterable.

2353

"stringValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2354

# be specified.

2355

#

2356

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

2357

# `CASE_INSENSITIVE_MATCH`) search.

2358

# For filterable `string_value`s, a maximum total number of 200 values

2359

# is allowed, with each `string_value` has a byte size of no more than

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2360

# 500B. For unfilterable `string_values`, the maximum total byte size of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2361

# unfilterable `string_values` is 50KB.

2362

#

2363

# Empty string is not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2364

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2365

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2366

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

2367

# custom attribute filters JobQuery.custom_attribute_filter.

2368

# If false, these values may not be used for custom attribute filters.

2369

#

2370

# Default is false.

2371

"longValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2372

# be specified.

2373

#

2374

# This field is used to perform number range search.

2375

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

2376

#

2377

# Currently at most 1 long_values is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2378

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2379

],

2380

},

2381

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2382

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

2383

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

2384

# any requirements for fluency that are associated with the job.

2385

#

2386

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

2387

# For more information, see

2388

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

2389

# class="external" target="_blank" }.

2390

#

2391

# If this field is unspecified and Job.description is present, detected

2392

# language code based on Job.description is assigned, otherwise

2393

# defaults to 'en_US'.

2394

"visibility": "A String", # Deprecated. The job is only visible to the owner.

2395

#

2396

# The visibility of the job.

2397

#

2398

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

2399

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2400

},

2401

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2407

<pre>Retrieves the next page of results.

2408

2409

Args:

2410

previous_request: The request for the previous page. (required)

2411

previous_response: The response from the request for the previous page. (required)

2412

2413

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2414

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2415

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2420

<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2421

<pre>Updates specified job.

2422

2423

Typically, updated contents become visible in search results within 10

2424

seconds, but it may take up to 5 minutes.

Args:

The resource name for the job. This is generated by the service when a

2430

job is created.

2431

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2432

The format is "projects/{project_id}/jobs/{job_id}",

2433

for example, "projects/api-test-project/jobs/1234".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2434

2435

Use of this field in job queries and API calls is preferred over the use of

2436

requisition_id since this value is unique. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2437

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2438

The object takes the form of:

{ # Input only.

#

# Update job request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2443

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be updated.

2444

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2445

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2446

"name": "A String", # Required during job update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2447

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2448

# The resource name for the job. This is generated by the service when a

2449

# job is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2450

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

# The format is "projects/{project_id}/jobs/{job_id}",

2452

# for example, "projects/api-test-project/jobs/1234".

2453

#

2454

# Use of this field in job queries and API calls is preferred over the use of

2455

# requisition_id since this value is unique.

2456

"jobBenefits": [ # Optional. The benefits included with the job.

2457

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2458

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2459

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2460

# The value determines the sort order of the jobs returned when searching for

2461

# jobs using the featured jobs search call, with higher promotional values

2462

# being returned first and ties being resolved by relevance sort. Only the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2463

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2464

#

2465

# Default value is 0, and negative values are treated as 0.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2466

"title": "A String", # Required. The title of the job, such as "Software Engineer"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2467

#

2468

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2469

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2470

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

2471

# job. The use of this field is recommended

2472

# as an alternative to using the more general description field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2473

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2474

# This field accepts and sanitizes HTML input, and also accepts

2475

# bold, italic, ordered list, and unordered list markup tags.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2476

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2477

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2478

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

2479

# client to identify a job. This field is intended to be used by clients

2480

# for client identification and tracking of postings. A job is not allowed

2481

# to be created if there is another job with the same [company_name],

2482

# language_code and requisition_id.

2483

#

2484

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2485

"processingOptions": { # Input only. # Optional. Options for job processing.

2486

#

2487

# Options for job processing.

2488

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

2489

# more precise address for the job.

2490

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

2491

#

2492

# * description

2493

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

2499

# disabled.

2500

#

2501

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

2502

},

2503

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

2504

# engagements. Invalid timestamps are ignored.

2505

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2506

#

2507

# Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2508

"locations": [ # Structured locations of the job, resolved from Job.addresses.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2509

#

2510

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2515

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

2516

# location bounding box in which a circle with the specified radius

2517

# centered from LatLng covers the area associated with the job location.

2518

# For example, currently, "Mountain View, CA, USA" has a radius of

2519

# 6.17 miles.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2520

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2521

# of doubles representing degrees latitude and degrees longitude. Unless

2522

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2523

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2524

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2525

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2526

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2527

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2528

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2529

# such as postal delivery and payments addresses. Given a postal address,

2530

# a postal service can deliver items to a premises, P.O. Box, or other

2531

# delivery location.

2532

# Given a postal address, a postal service can deliver items to a premise, P.O.

2533

# Box or similar.

2534

# It is not intended to model geographical locations (roads, towns,

2535

# mountains).

2536

#

2537

# In typical usage an address would be created via user input or from importing

2538

# existing data, depending on the type of process.

2539

#

2540

# Advice on address input / editing:

2541

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2542

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2543

# - Users should not be presented with UI elements for input or editing of

2544

# fields outside countries where that field is used.

2545

#

2546

# For more guidance on how to use this schema, please see:

2547

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2548

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2549

# postal codes to be present, but where they are used, they may trigger

2550

# additional validation with other parts of the address (e.g. state/zip

2551

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2552

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

2553

# known). This is often the UI language of the input form or is expected

2554

# to match one of the languages used in the address' country/region, or their

2555

# transliterated equivalents.

2556

# This can affect formatting in certain countries, but is not critical

2557

# to the correctness of the data and will never affect any validation or

2558

# other non-formatting related operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2559

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2560

# If this value is not known, it should be omitted (rather than specifying a

2561

# possibly incorrect default).

2562

#

2563

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

2564

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

2565

# in most regions. Where it is used, the value is either a string like

2566

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

2567

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

2568

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

2569

"recipients": [ # Optional. The recipient at the address.

2570

# This field may, under certain circumstances, contain multiline information.

2571

# For example, it might contain "care of" information.

2572

"A String",

2573

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

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.

2580

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

2581

# Examples: US city, IT comune, UK post town.

2582

# In regions of the world where localities are not well defined or do not fit

2583

# into this structure well, leave locality empty and use address_lines.

2584

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

2585

# addresses of a country or region.

2586

# For example, this can be a state, a province, an oblast, or a prefecture.

2587

# Specifically, for Spain this is the province and not the autonomous

2588

# community (e.g. "Barcelona" and not "Catalonia").

2589

# Many countries don't use an administrative area in postal addresses. E.g.

2590

# in Switzerland this should be left unpopulated.

2591

"organization": "A String", # Optional. The name of the organization at the address.

2592

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

2593

#

2594

# Because values in address_lines do not have type information and may

2595

# sometimes contain multiple values in a single field (e.g.

2596

# "Austin, TX"), it is important that the line order is clear. The order of

2597

# address lines should be "envelope order" for the country/region of the

2598

# address. In places where this can vary (e.g. Japan), address_language is

2599

# used to make it explicit (e.g. "ja" for large-to-small ordering and

2600

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

2601

# an address can be selected based on the language.

2602

#

2603

# The minimum permitted structural representation of an address consists

2604

# of a region_code with all remaining information placed in the

2605

# address_lines. It would be possible to format such an address very

2606

# approximately without geocoding, but no semantic reasoning could be

2607

# made about any of the address components until it was at least

2608

# partially resolved.

2609

#

2610

# Creating an address only containing a region_code and address_lines, and

2611

# then geocoding is the recommended way to handle completely unstructured

2612

# addresses (as opposed to guessing which parts of the address should be

2613

# localities or administrative areas).

2614

"A String",

2615

],

2616

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

2617

# is never inferred and it is up to the user to ensure the value is

2618

# correct. See http://cldr.unicode.org/ and

2619

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

2620

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2621

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2622

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

2623

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

2624

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

2625

# LocationType#LOCALITY.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2626

},

2627

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2628

"jobCategories": [ # Job categories derived from Job.title and Job.description.

2629

"A String",

2630

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2631

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2632

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

2633

# incentives associated with the job not including salary or pay.

2634

#

2635

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2636

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2641

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

2642

"addresses": [ # Optional but strongly recommended for the best service experience.

2643

#

2644

# Location(s) where the employer is looking to hire for this job posting.

2645

#

2646

# Specifying the full street address(es) of the hiring location enables

2647

# better API results, especially job searches by commute time.

2648

#

2649

# At most 50 locations are allowed for best search performance. If a job has

2650

# more locations, it is suggested to split it into multiple jobs with unique

2651

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

2652

# multiple jobs with the same company_name, language_code and

2653

# requisition_id are not allowed. If the original requisition_id must

2654

# be preserved, a custom field should be used for storage. It is also

2655

# suggested to group the locations that close to each other in the same job

2656

# for better search experience.

2657

#

2658

# The maximum number of allowed characters is 500.

2659

"A String",

2660

],

2661

"companyName": "A String", # Required. The resource name of the company listing the job, such as

2662

# "projects/api-test-project/companies/foo".

2663

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

2664

# description of the company and related information. Separate fields are

2665

# provided on the job object for responsibilities,

2666

# qualifications, and other job characteristics. Use of

2667

# these separate job fields is recommended.

2668

#

2669

# This field accepts and sanitizes HTML input, and also accepts

2670

# bold, italic, ordered list, and unordered list markup tags.

2671

#

2672

# The maximum number of allowed characters is 100,000.

2673

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

2674

# is used for contracting engagements. Invalid timestamps are ignored.

2675

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

2676

"A String",

2677

],

2678

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2679

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

2680

# all compensation entries' CompensationEntry.compensation times

2681

# CompensationEntry.expected_units_per_year.

2682

#

2683

# See CompensationEntry for explanation on compensation annualization.

2684

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2685

# to a maximal compensation value and the currency code is set to

2686

# match the currency code of

2687

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2688

"nanos": 42, # Number of nano (10^-9) units of the amount.

2689

# The value must be between -999,999,999 and +999,999,999 inclusive.

2690

# If `units` is positive, `nanos` must be positive or zero.

2691

# If `units` is zero, `nanos` can be positive, zero, or negative.

2692

# If `units` is negative, `nanos` must be negative or zero.

2693

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2694

"units": "A String", # The whole units of the amount.

2695

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2696

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2697

},

2698

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2699

# to zero and the currency code is set to match the

2700

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2701

"nanos": 42, # Number of nano (10^-9) units of the amount.

2702

# The value must be between -999,999,999 and +999,999,999 inclusive.

2703

# If `units` is positive, `nanos` must be positive or zero.

2704

# If `units` is zero, `nanos` can be positive, zero, or negative.

2705

# If `units` is negative, `nanos` must be negative or zero.

2706

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2707

"units": "A String", # The whole units of the amount.

2708

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2709

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2710

},

2711

},

2712

"entries": [ # Optional. Job compensation information.

2713

#

2714

# At most one entry can be of type

2715

# CompensationInfo.CompensationType.BASE, which is

2716

# referred as ** base compensation entry ** for the job.

2717

{ # A compensation entry that represents one component of compensation, such

2718

# as base pay, bonus, or other compensation type.

2719

#

2720

# Annualization: One compensation entry can be annualized if

2721

# - it contains valid amount or range.

2722

# - and its expected_units_per_year is set or can be derived.

2723

# Its annualized range is determined as (amount or range) times

2724

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2725

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2726

"nanos": 42, # Number of nano (10^-9) units of the amount.

2727

# The value must be between -999,999,999 and +999,999,999 inclusive.

2728

# If `units` is positive, `nanos` must be positive or zero.

2729

# If `units` is zero, `nanos` can be positive, zero, or negative.

2730

# If `units` is negative, `nanos` must be negative or zero.

2731

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2732

"units": "A String", # The whole units of the amount.

2733

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2734

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2735

},

2736

"type": "A String", # Optional. Compensation type.

2737

#

2738

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

2739

"range": { # Compensation range. # Optional. Compensation range.

2740

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2741

# to a maximal compensation value and the currency code is set to

2742

# match the currency code of

2743

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2744

"nanos": 42, # Number of nano (10^-9) units of the amount.

2745

# The value must be between -999,999,999 and +999,999,999 inclusive.

2746

# If `units` is positive, `nanos` must be positive or zero.

2747

# If `units` is zero, `nanos` can be positive, zero, or negative.

2748

# If `units` is negative, `nanos` must be negative or zero.

2749

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2750

"units": "A String", # The whole units of the amount.

2751

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2752

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2753

},

2754

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2755

# to zero and the currency code is set to match the

2756

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2757

"nanos": 42, # Number of nano (10^-9) units of the amount.

2758

# The value must be between -999,999,999 and +999,999,999 inclusive.

2759

# If `units` is positive, `nanos` must be positive or zero.

2760

# If `units` is zero, `nanos` can be positive, zero, or negative.

2761

# If `units` is negative, `nanos` must be negative or zero.

2762

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2763

"units": "A String", # The whole units of the amount.

2764

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2765

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2766

},

2767

},

2768

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

2769

# Job.employment_types is FULLTIME, a default value is inferred

2770

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"description": "A String", # Optional. Compensation description. For example, could

2777

# indicate equity terms or provide additional context to an estimated

2778

# bonus.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2779

"unit": "A String", # Optional. Frequency of the specified amount.

2780

#

2781

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2782

},

2783

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2784

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

2785

# base compensation entry's CompensationEntry.compensation times

2786

# CompensationEntry.expected_units_per_year.

2787

#

2788

# See CompensationEntry for explanation on compensation annualization.

2789

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2790

# to a maximal compensation value and the currency code is set to

2791

# match the currency code of

2792

# min_compensation.

2793

"nanos": 42, # Number of nano (10^-9) units of the amount.

2794

# The value must be between -999,999,999 and +999,999,999 inclusive.

2795

# If `units` is positive, `nanos` must be positive or zero.

2796

# If `units` is zero, `nanos` can be positive, zero, or negative.

2797

# If `units` is negative, `nanos` must be negative or zero.

2798

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2799

"units": "A String", # The whole units of the amount.

2800

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2801

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2802

},

2803

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2804

# to zero and the currency code is set to match the

2805

# currency code of max_compensation.

2806

"nanos": 42, # Number of nano (10^-9) units of the amount.

2807

# The value must be between -999,999,999 and +999,999,999 inclusive.

2808

# If `units` is positive, `nanos` must be positive or zero.

2809

# If `units` is zero, `nanos` can be positive, zero, or negative.

2810

# If `units` is negative, `nanos` must be negative or zero.

2811

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2812

"units": "A String", # The whole units of the amount.

2813

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2814

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2815

},

2816

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2817

},

2818

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

2819

# recommended as an alternative to using the more general description

2820

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2821

#

2822

# This field accepts and sanitizes HTML input, and also accepts

2823

# bold, italic, ordered list, and unordered list markup tags.

2824

#

2825

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2826

"department": "A String", # Optional. The department or functional area within the company with the open

2827

# position.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2828

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2829

# The maximum number of allowed characters is 255.

2830

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2831

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2832

# Job application information.

2833

"uris": [ # Optional but at least one of uris,

2834

# emails or instruction must be

2835

# specified.

2836

#

2837

# Use this URI field to direct an applicant to a website, for example to

2838

# link to an online application form.

2839

#

2840

# The maximum number of allowed characters for each entry is 2,000.

2841

"A String",

2842

],

2843

"emails": [ # Optional but at least one of uris,

2844

# emails or instruction must be

2845

# specified.

2846

#

2847

# Use this field to specify email address(es) to which resumes or

2848

# applications can be sent.

2849

#

2850

# The maximum number of allowed characters for each entry is 255.

2851

"A String",

2852

],

2853

"instruction": "A String", # Optional but at least one of uris,

2854

# emails or instruction must be

2855

# specified.

2856

#

2857

# Use this field to provide instructions, such as "Mail your application

2858

# to ...", that a candidate can follow to apply for the job.

2859

#

2860

# This field accepts and sanitizes HTML input, and also accepts

2861

# bold, italic, ordered list, and unordered list markup tags.

2862

#

2863

# The maximum number of allowed characters is 3,000.

2864

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2865

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

2866

# the job is available. If this field is set, a

2867

# LocationFilter in a search query within the job region

2868

# finds this job posting if an exact location match isn't specified.

2869

# If this field is set to PostingRegion.NATION or

2870

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

2871

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2872

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

2873

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2874

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2875

# The expiration timestamp of the job. After this timestamp, the

2876

# job is marked as expired, and it no longer appears in search results. The

2877

# expired job can't be deleted or listed by the DeleteJob and

2878

# ListJobs APIs, but it can be retrieved with the GetJob API or

2879

# updated with the UpdateJob API. An expired job can be updated and

2880

# opened again by using a future expiration timestamp. Updating an expired

2881

# job fails if there is another existing open job with same company_name,

2882

# language_code and requisition_id.

2883

#

2884

# The expired jobs are retained in our system for 90 days. However, the

2885

# overall expired job count cannot exceed 3 times the maximum of open jobs

2886

# count over the past week, otherwise jobs with earlier expire time are

2887

# cleaned first. Expired jobs are no longer accessible after they are cleaned

2888

# out.

2889

#

2890

# Invalid timestamps are ignored, and treated as expire time not provided.

2891

#

2892

# Timestamp before the instant request is made is considered valid, the job

2893

# will be treated as expired immediately.

2894

#

2895

# If this value is not provided at the time of job creation or is invalid,

2896

# the job posting expires after 30 days from the job's creation time. For

2897

# example, if the job was created on 2017/01/01 13:00AM UTC with an

2898

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

2899

#

2900

# If this value is not provided on job update, it depends on the field masks

2901

# set by UpdateJobRequest.update_mask. If the field masks include

2902

# expiry_time, or the masks are empty meaning that every field is

2903

# updated, the job posting expires after 30 days from the job's last

2904

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2905

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

2906

# value is the time the request arrives at the server. Invalid timestamps are

2907

# ignored.

2908

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2909

# attributes that are not covered by the provided structured fields.

2910

#

2911

# The keys of the map are strings up to 64 bytes and must match the

2912

# pattern: a-zA-Z*. For example, key0LikeThis or

2913

# KEY_1_LIKE_THIS.

2914

#

2915

# At most 100 filterable and at most 100 unfilterable keys are supported.

2916

# For filterable `string_values`, across all keys at most 200 values are

2917

# allowed, with each string no more than 255 characters. For unfilterable

2918

# `string_values`, the maximum total size of `string_values` across all keys

2919

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2920

"a_key": { # Custom attribute values that are either filterable or non-filterable.

2921

"stringValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2922

# be specified.

2923

#

2924

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

2925

# `CASE_INSENSITIVE_MATCH`) search.

2926

# For filterable `string_value`s, a maximum total number of 200 values

2927

# is allowed, with each `string_value` has a byte size of no more than

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2928

# 500B. For unfilterable `string_values`, the maximum total byte size of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2929

# unfilterable `string_values` is 50KB.

2930

#

2931

# Empty string is not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2932

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2933

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2934

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

2935

# custom attribute filters JobQuery.custom_attribute_filter.

2936

# If false, these values may not be used for custom attribute filters.

2937

#

2938

# Default is false.

2939

"longValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2940

# be specified.

2941

#

2942

# This field is used to perform number range search.

2943

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

2944

#

2945

# Currently at most 1 long_values is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2946

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2947

],

2948

},

2949

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2950

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

2951

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

2952

# any requirements for fluency that are associated with the job.

2953

#

2954

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

2955

# For more information, see

2956

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

2957

# class="external" target="_blank" }.

2958

#

2959

# If this field is unspecified and Job.description is present, detected

2960

# language code based on Job.description is assigned, otherwise

2961

# defaults to 'en_US'.

2962

"visibility": "A String", # Deprecated. The job is only visible to the owner.

2963

#

2964

# The visibility of the job.

2965

#

2966

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

2967

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2968

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2969

"updateMask": "A String", # Optional but strongly recommended to be provided for the best service

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2970

# experience.

2971

#

2972

# If update_mask is provided, only the specified fields in

2973

# job are updated. Otherwise all the fields are updated.

2974

#

2975

# A field mask to restrict the fields that are updated. Only

2976

# top level fields of Job are supported.

2977

}

2978

2979

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2986

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2987

{ # A Job resource represents a job posting (also referred to as a "job listing"

2988

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2989

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2990

"name": "A String", # Required during job update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2991

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2992

# The resource name for the job. This is generated by the service when a

2993

# job is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2994

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2995

# The format is "projects/{project_id}/jobs/{job_id}",

2996

# for example, "projects/api-test-project/jobs/1234".

2997

#

2998

# Use of this field in job queries and API calls is preferred over the use of

2999

# requisition_id since this value is unique.

3000

"jobBenefits": [ # Optional. The benefits included with the job.

3001

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3002

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3003

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3004

# The value determines the sort order of the jobs returned when searching for

3005

# jobs using the featured jobs search call, with higher promotional values

3006

# being returned first and ties being resolved by relevance sort. Only the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3007

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3008

#

3009

# Default value is 0, and negative values are treated as 0.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3010

"title": "A String", # Required. The title of the job, such as "Software Engineer"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3011

#

3012

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3013

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3014

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

3015

# job. The use of this field is recommended

3016

# as an alternative to using the more general description field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3017

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3018

# This field accepts and sanitizes HTML input, and also accepts

3019

# bold, italic, ordered list, and unordered list markup tags.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3020

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3021

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3022

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

3023

# client to identify a job. This field is intended to be used by clients

3024

# for client identification and tracking of postings. A job is not allowed

3025

# to be created if there is another job with the same [company_name],

3026

# language_code and requisition_id.

3027

#

3028

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

"processingOptions": { # Input only. # Optional. Options for job processing.

3030

#

3031

# Options for job processing.

3032

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

3033

# more precise address for the job.

3034

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

3035

#

3036

# * description

3037

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

3043

# disabled.

3044

#

3045

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

3046

},

3047

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

3048

# engagements. Invalid timestamps are ignored.

3049

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3050

#

3051

# Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3052

"locations": [ # Structured locations of the job, resolved from Job.addresses.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3053

#

3054

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3059

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

3060

# location bounding box in which a circle with the specified radius

3061

# centered from LatLng covers the area associated with the job location.

3062

# For example, currently, "Mountain View, CA, USA" has a radius of

3063

# 6.17 miles.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3064

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3065

# of doubles representing degrees latitude and degrees longitude. Unless

3066

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3067

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3068

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3069

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3070

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3071

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3072

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3073

# such as postal delivery and payments addresses. Given a postal address,

3074

# a postal service can deliver items to a premises, P.O. Box, or other

3075

# delivery location.

3076

# Given a postal address, a postal service can deliver items to a premise, P.O.

3077

# Box or similar.

3078

# It is not intended to model geographical locations (roads, towns,

3079

# mountains).

3080

#

3081

# In typical usage an address would be created via user input or from importing

3082

# existing data, depending on the type of process.

3083

#

3084

# Advice on address input / editing:

3085

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3086

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3087

# - Users should not be presented with UI elements for input or editing of

3088

# fields outside countries where that field is used.

3089

#

3090

# For more guidance on how to use this schema, please see:

3091

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3092

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3093

# postal codes to be present, but where they are used, they may trigger

3094

# additional validation with other parts of the address (e.g. state/zip

3095

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3096

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

3097

# known). This is often the UI language of the input form or is expected

3098

# to match one of the languages used in the address' country/region, or their

3099

# transliterated equivalents.

3100

# This can affect formatting in certain countries, but is not critical

3101

# to the correctness of the data and will never affect any validation or

3102

# other non-formatting related operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3103

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3104

# If this value is not known, it should be omitted (rather than specifying a

3105

# possibly incorrect default).

3106

#

3107

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

3108

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

3109

# in most regions. Where it is used, the value is either a string like

3110

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

3111

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

3112

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

3113

"recipients": [ # Optional. The recipient at the address.

3114

# This field may, under certain circumstances, contain multiline information.

3115

# For example, it might contain "care of" information.

3116

"A String",

3117

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3118

"sublocality": "A String", # Optional. Sublocality of the address.

3119

# For example, this can be neighborhoods, boroughs, districts.

3120

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

3121

# the latest revision.

3122

#

3123

# All new revisions **must** be backward compatible with old revisions.

3124

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

3125

# Examples: US city, IT comune, UK post town.

3126

# In regions of the world where localities are not well defined or do not fit

3127

# into this structure well, leave locality empty and use address_lines.

3128

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

3129

# addresses of a country or region.

3130

# For example, this can be a state, a province, an oblast, or a prefecture.

3131

# Specifically, for Spain this is the province and not the autonomous

3132

# community (e.g. "Barcelona" and not "Catalonia").

3133

# Many countries don't use an administrative area in postal addresses. E.g.

3134

# in Switzerland this should be left unpopulated.

3135

"organization": "A String", # Optional. The name of the organization at the address.

3136

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

3137

#

3138

# Because values in address_lines do not have type information and may

3139

# sometimes contain multiple values in a single field (e.g.

3140

# "Austin, TX"), it is important that the line order is clear. The order of

3141

# address lines should be "envelope order" for the country/region of the

3142

# address. In places where this can vary (e.g. Japan), address_language is

3143

# used to make it explicit (e.g. "ja" for large-to-small ordering and

3144

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

3145

# an address can be selected based on the language.

3146

#

3147

# The minimum permitted structural representation of an address consists

3148

# of a region_code with all remaining information placed in the

3149

# address_lines. It would be possible to format such an address very

3150

# approximately without geocoding, but no semantic reasoning could be

3151

# made about any of the address components until it was at least

3152

# partially resolved.

3153

#

3154

# Creating an address only containing a region_code and address_lines, and

3155

# then geocoding is the recommended way to handle completely unstructured

3156

# addresses (as opposed to guessing which parts of the address should be

3157

# localities or administrative areas).

3158

"A String",

3159

],

3160

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

3161

# is never inferred and it is up to the user to ensure the value is

3162

# correct. See http://cldr.unicode.org/ and

3163

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3164

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3165

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3166

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

3167

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

3168

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

3169

# LocationType#LOCALITY.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3170

},

3171

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3172

"jobCategories": [ # Job categories derived from Job.title and Job.description.

3173

"A String",

3174

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3175

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3176

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

3177

# incentives associated with the job not including salary or pay.

3178

#

3179

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3180

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3185

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

3186

"addresses": [ # Optional but strongly recommended for the best service experience.

3187

#

3188

# Location(s) where the employer is looking to hire for this job posting.

3189

#

3190

# Specifying the full street address(es) of the hiring location enables

3191

# better API results, especially job searches by commute time.

3192

#

3193

# At most 50 locations are allowed for best search performance. If a job has

3194

# more locations, it is suggested to split it into multiple jobs with unique

3195

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

3196

# multiple jobs with the same company_name, language_code and

3197

# requisition_id are not allowed. If the original requisition_id must

3198

# be preserved, a custom field should be used for storage. It is also

3199

# suggested to group the locations that close to each other in the same job

3200

# for better search experience.

3201

#

3202

# The maximum number of allowed characters is 500.

3203

"A String",

3204

],

3205

"companyName": "A String", # Required. The resource name of the company listing the job, such as

3206

# "projects/api-test-project/companies/foo".

3207

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

3208

# description of the company and related information. Separate fields are

3209

# provided on the job object for responsibilities,

3210

# qualifications, and other job characteristics. Use of

3211

# these separate job fields is recommended.

3212

#

3213

# This field accepts and sanitizes HTML input, and also accepts

3214

# bold, italic, ordered list, and unordered list markup tags.

3215

#

3216

# The maximum number of allowed characters is 100,000.

3217

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

3218

# is used for contracting engagements. Invalid timestamps are ignored.

3219

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

3220

"A String",

3221

],

3222

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3223

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

3224

# all compensation entries' CompensationEntry.compensation times

3225

# CompensationEntry.expected_units_per_year.

3226

#

3227

# See CompensationEntry for explanation on compensation annualization.

3228

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3229

# to a maximal compensation value and the currency code is set to

3230

# match the currency code of

3231

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3232

"nanos": 42, # Number of nano (10^-9) units of the amount.

3233

# The value must be between -999,999,999 and +999,999,999 inclusive.

3234

# If `units` is positive, `nanos` must be positive or zero.

3235

# If `units` is zero, `nanos` can be positive, zero, or negative.

3236

# If `units` is negative, `nanos` must be negative or zero.

3237

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3238

"units": "A String", # The whole units of the amount.

3239

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3240

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3241

},

3242

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3243

# to zero and the currency code is set to match the

3244

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3245

"nanos": 42, # Number of nano (10^-9) units of the amount.

3246

# The value must be between -999,999,999 and +999,999,999 inclusive.

3247

# If `units` is positive, `nanos` must be positive or zero.

3248

# If `units` is zero, `nanos` can be positive, zero, or negative.

3249

# If `units` is negative, `nanos` must be negative or zero.

3250

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3251

"units": "A String", # The whole units of the amount.

3252

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3253

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3254

},

3255

},

3256

"entries": [ # Optional. Job compensation information.

3257

#

3258

# At most one entry can be of type

3259

# CompensationInfo.CompensationType.BASE, which is

3260

# referred as ** base compensation entry ** for the job.

3261

{ # A compensation entry that represents one component of compensation, such

3262

# as base pay, bonus, or other compensation type.

3263

#

3264

# Annualization: One compensation entry can be annualized if

3265

# - it contains valid amount or range.

3266

# - and its expected_units_per_year is set or can be derived.

3267

# Its annualized range is determined as (amount or range) times

3268

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3269

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3270

"nanos": 42, # Number of nano (10^-9) units of the amount.

3271

# The value must be between -999,999,999 and +999,999,999 inclusive.

3272

# If `units` is positive, `nanos` must be positive or zero.

3273

# If `units` is zero, `nanos` can be positive, zero, or negative.

3274

# If `units` is negative, `nanos` must be negative or zero.

3275

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3276

"units": "A String", # The whole units of the amount.

3277

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3278

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3279

},

3280

"type": "A String", # Optional. Compensation type.

3281

#

3282

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

3283

"range": { # Compensation range. # Optional. Compensation range.

3284

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3285

# to a maximal compensation value and the currency code is set to

3286

# match the currency code of

3287

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3288

"nanos": 42, # Number of nano (10^-9) units of the amount.

3289

# The value must be between -999,999,999 and +999,999,999 inclusive.

3290

# If `units` is positive, `nanos` must be positive or zero.

3291

# If `units` is zero, `nanos` can be positive, zero, or negative.

3292

# If `units` is negative, `nanos` must be negative or zero.

3293

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3294

"units": "A String", # The whole units of the amount.

3295

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3296

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3297

},

3298

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3299

# to zero and the currency code is set to match the

3300

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3301

"nanos": 42, # Number of nano (10^-9) units of the amount.

3302

# The value must be between -999,999,999 and +999,999,999 inclusive.

3303

# If `units` is positive, `nanos` must be positive or zero.

3304

# If `units` is zero, `nanos` can be positive, zero, or negative.

3305

# If `units` is negative, `nanos` must be negative or zero.

3306

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3307

"units": "A String", # The whole units of the amount.

3308

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3309

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3310

},

3311

},

3312

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

3313

# Job.employment_types is FULLTIME, a default value is inferred

3314

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"description": "A String", # Optional. Compensation description. For example, could

3321

# indicate equity terms or provide additional context to an estimated

3322

# bonus.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3323

"unit": "A String", # Optional. Frequency of the specified amount.

3324

#

3325

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3326

},

3327

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3328

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

3329

# base compensation entry's CompensationEntry.compensation times

3330

# CompensationEntry.expected_units_per_year.

3331

#

3332

# See CompensationEntry for explanation on compensation annualization.

3333

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3334

# to a maximal compensation value and the currency code is set to

3335

# match the currency code of

3336

# min_compensation.

3337

"nanos": 42, # Number of nano (10^-9) units of the amount.

3338

# The value must be between -999,999,999 and +999,999,999 inclusive.

3339

# If `units` is positive, `nanos` must be positive or zero.

3340

# If `units` is zero, `nanos` can be positive, zero, or negative.

3341

# If `units` is negative, `nanos` must be negative or zero.

3342

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3343

"units": "A String", # The whole units of the amount.

3344

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3345

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3346

},

3347

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3348

# to zero and the currency code is set to match the

3349

# currency code of max_compensation.

3350

"nanos": 42, # Number of nano (10^-9) units of the amount.

3351

# The value must be between -999,999,999 and +999,999,999 inclusive.

3352

# If `units` is positive, `nanos` must be positive or zero.

3353

# If `units` is zero, `nanos` can be positive, zero, or negative.

3354

# If `units` is negative, `nanos` must be negative or zero.

3355

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3356

"units": "A String", # The whole units of the amount.

3357

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3358

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3359

},

3360

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3361

},

3362

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

3363

# recommended as an alternative to using the more general description

3364

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3365

#

3366

# This field accepts and sanitizes HTML input, and also accepts

3367

# bold, italic, ordered list, and unordered list markup tags.

3368

#

3369

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3370

"department": "A String", # Optional. The department or functional area within the company with the open

3371

# position.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3372

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3373

# The maximum number of allowed characters is 255.

3374

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3375

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3376

# Job application information.

3377

"uris": [ # Optional but at least one of uris,

3378

# emails or instruction must be

3379

# specified.

3380

#

3381

# Use this URI field to direct an applicant to a website, for example to

3382

# link to an online application form.

3383

#

3384

# The maximum number of allowed characters for each entry is 2,000.

3385

"A String",

3386

],

3387

"emails": [ # Optional but at least one of uris,

3388

# emails or instruction must be

3389

# specified.

3390

#

3391

# Use this field to specify email address(es) to which resumes or

3392

# applications can be sent.

3393

#

3394

# The maximum number of allowed characters for each entry is 255.

3395

"A String",

3396

],

3397

"instruction": "A String", # Optional but at least one of uris,

3398

# emails or instruction must be

3399

# specified.

3400

#

3401

# Use this field to provide instructions, such as "Mail your application

3402

# to ...", that a candidate can follow to apply for the job.

3403

#

3404

# This field accepts and sanitizes HTML input, and also accepts

3405

# bold, italic, ordered list, and unordered list markup tags.

3406

#

3407

# The maximum number of allowed characters is 3,000.

3408

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3409

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

3410

# the job is available. If this field is set, a

3411

# LocationFilter in a search query within the job region

3412

# finds this job posting if an exact location match isn't specified.

3413

# If this field is set to PostingRegion.NATION or

3414

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

3415

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3416

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

3417

# experience.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3418

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3419

# The expiration timestamp of the job. After this timestamp, the

3420

# job is marked as expired, and it no longer appears in search results. The

3421

# expired job can't be deleted or listed by the DeleteJob and

3422

# ListJobs APIs, but it can be retrieved with the GetJob API or

3423

# updated with the UpdateJob API. An expired job can be updated and

3424

# opened again by using a future expiration timestamp. Updating an expired

3425

# job fails if there is another existing open job with same company_name,

3426

# language_code and requisition_id.

3427

#

3428

# The expired jobs are retained in our system for 90 days. However, the

3429

# overall expired job count cannot exceed 3 times the maximum of open jobs

3430

# count over the past week, otherwise jobs with earlier expire time are

3431

# cleaned first. Expired jobs are no longer accessible after they are cleaned

3432

# out.

3433

#

3434

# Invalid timestamps are ignored, and treated as expire time not provided.

3435

#

3436

# Timestamp before the instant request is made is considered valid, the job

3437

# will be treated as expired immediately.

3438

#

3439

# If this value is not provided at the time of job creation or is invalid,

3440

# the job posting expires after 30 days from the job's creation time. For

3441

# example, if the job was created on 2017/01/01 13:00AM UTC with an

3442

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

3443

#

3444

# If this value is not provided on job update, it depends on the field masks

3445

# set by UpdateJobRequest.update_mask. If the field masks include

3446

# expiry_time, or the masks are empty meaning that every field is

3447

# updated, the job posting expires after 30 days from the job's last

3448

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3449

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

3450

# value is the time the request arrives at the server. Invalid timestamps are

3451

# ignored.

3452

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3453

# attributes that are not covered by the provided structured fields.

3454

#

3455

# The keys of the map are strings up to 64 bytes and must match the

3456

# pattern: a-zA-Z*. For example, key0LikeThis or

3457

# KEY_1_LIKE_THIS.

3458

#

3459

# At most 100 filterable and at most 100 unfilterable keys are supported.

3460

# For filterable `string_values`, across all keys at most 200 values are

3461

# allowed, with each string no more than 255 characters. For unfilterable

3462

# `string_values`, the maximum total size of `string_values` across all keys

3463

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3464

"a_key": { # Custom attribute values that are either filterable or non-filterable.

3465

"stringValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3466

# be specified.

3467

#

3468

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

3469

# `CASE_INSENSITIVE_MATCH`) search.

3470

# For filterable `string_value`s, a maximum total number of 200 values

3471

# is allowed, with each `string_value` has a byte size of no more than

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3472

# 500B. For unfilterable `string_values`, the maximum total byte size of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3473

# unfilterable `string_values` is 50KB.

3474

#

3475

# Empty string is not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3476

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3477

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3478

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

3479

# custom attribute filters JobQuery.custom_attribute_filter.

3480

# If false, these values may not be used for custom attribute filters.

3481

#

3482

# Default is false.

3483

"longValues": [ # Optional but exactly one of string_values or long_values must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3484

# be specified.

3485

#

3486

# This field is used to perform number range search.

3487

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

3488

#

3489

# Currently at most 1 long_values is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3490

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3491

],

3492

},

3493

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3494

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

3495

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

3496

# any requirements for fluency that are associated with the job.

3497

#

3498

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

3499

# For more information, see

3500

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

3501

# class="external" target="_blank" }.

3502

#

3503

# If this field is unspecified and Job.description is present, detected

3504

# language code based on Job.description is assigned, otherwise

3505

# defaults to 'en_US'.

3506

"visibility": "A String", # Deprecated. The job is only visible to the owner.

3507

#

3508

# The visibility of the job.

3509

#

3510

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

3511

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3516

<code class="details" id="search">search(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3517

<pre>Searches for jobs using the provided SearchJobsRequest.

3518

3519

This call constrains the visibility of jobs

3520

present in the database, and only returns jobs that the caller has

3521

permission to search against.

3522

3523

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3524

parent: string, Required. The resource name of the project to search within.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3525

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3526

The format is "projects/{project_id}", for example,

3527

"projects/api-test-project". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3528

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3529

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3534

"disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,

3535

# Job.description, Job.company_display_name, Job.locations,

3536

# Job.qualifications. When disable keyword match is turned off, a

3537

# keyword match returns jobs that do not match given category filters when

3538

# there are matching keywords. For example, the query "program manager," a

3539

# result is returned even if the job posting has the title "software

3540

# developer," which does not fall into "program manager" ontology, but does

3541

# have "program manager" appearing in its description.

3542

#

3543

# For queries like "cloud" that does not contain title or

3544

# location specific ontology, jobs with "cloud" keyword matches are returned

3545

# regardless of this flag's value.

3546

#

3547

# Please use Company.keyword_searchable_custom_fields or

3548

# Company.keyword_searchable_custom_attributes if company specific

3549

# globally matched custom field/attribute string values is needed. Enabling

3550

# keyword match improves recall of subsequent search requests.

3551

#

3552

# Defaults to false.

3553

"enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.

3554

# Broadened queries append results to the end of the matching results

# list.

#

# Defaults to false.

"offset": 42, # Optional. An integer that specifies the current offset (that is, starting result

3559

# location, amongst the jobs deemed by the API as relevant) in search

3560

# results. This field is only considered if page_token is unset.

3561

#

3562

# The maximum allowed value is 5000. Otherwise an error is thrown.

3563

#

3564

# For example, 0 means to return results starting from the first matching

3565

# job, and 10 means to return from the 11th job. This can be used for

3566

# pagination, (for example, pageSize = 10 and offset = 10 means to return

3567

# from the second page).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3568

"pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.

3569

# Increasing this value above the default value of 10 can increase search

3570

# response time. The value can be between 1 and 100.

3571

"histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.

3572

#

3573

# Histogram facets to be specified in SearchJobsRequest.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3574

"compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.

3575

# Duplicate values of CompensationHistogramRequest.type are not allowed.

3576

{ # Input only.

3577

#

3578

# Compensation based histogram request.

3579

"bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.

3580

#

3581

# Use this field to specify bucketing option for the histogram search response.

3582

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

3583

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

3584

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

3585

# [buckets_bound is supported.

3586

3.14,

3587

],

3588

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

3589

# value of the numeric field.

3590

},

3591

"type": "A String", # Required. Type of the request, representing which field the histogramming should be

3592

# performed over. A single request can only specify one histogram of each

3593

# `CompensationHistogramRequestType`.

3594

},

3595

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3596

"customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.

3597

# Duplicate values of CustomAttributeHistogramRequest.key are not

3598

# allowed.

3599

{ # Custom attributes histogram request. An error is thrown if neither

3600

# string_value_histogram or long_value_histogram_bucketing_option has

3601

# been defined.

3602

"longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's

3603

# filterable long custom field values, or min/max value requirements.

3604

#

3605

# Use this field to specify bucketing option for the histogram search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3606

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

3607

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

3608

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

3609

# [buckets_bound is supported.

3610

3.14,

3611

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3612

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

3613

# value of the numeric field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3614

},

3615

"key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified

3616

# without `long_value_histogram_bucketing_option`, histogram on string values

3617

# of the given `key` is triggered, otherwise histogram is performed on long

3618

# values.

3619

"stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for

3620

# each key as a string.

3621

},

3622

],

3623

"simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,

3624

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.

3625

"A String",

3626

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3627

},

3628

"orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is

3629

# "relevance desc".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3630

#

3631

# Supported options are:

3632

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3633

# * `"relevance desc"`: By relevance descending, as determined by the API

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3634

# algorithms. Relevance thresholding of query results is only available

3635

# with this ordering.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3636

# * `"posting_publish_time desc"`: By Job.posting_publish_time

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3637

# descending.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3638

# * `"posting_update_time desc"`: By Job.posting_update_time

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3639

# descending.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3640

# * `"title"`: By Job.title ascending.

3641

# * `"title desc"`: By Job.title descending.

3642

# * `"annualized_base_compensation"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3643

# CompensationInfo.annualized_base_compensation_range ascending. Jobs

3644

# whose annualized base compensation is unspecified are put at the end of

3645

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3646

# * `"annualized_base_compensation desc"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3647

# CompensationInfo.annualized_base_compensation_range descending. Jobs

3648

# whose annualized base compensation is unspecified are put at the end of

3649

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3650

# * `"annualized_total_compensation"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3651

# CompensationInfo.annualized_total_compensation_range ascending. Jobs

3652

# whose annualized base compensation is unspecified are put at the end of

3653

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3654

# * `"annualized_total_compensation desc"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3655

# CompensationInfo.annualized_total_compensation_range descending. Jobs

3656

# whose annualized base compensation is unspecified are put at the end of

3657

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3658

"jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3659

#

3660

# The query required to perform a search query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3661

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

3662

# Job.custom_attributes marked as `filterable`.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3663

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3664

# The syntax for this expression is a subset of SQL syntax.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3665

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3666

# Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the

3667

# left of the operator is a custom field key and the right of the operator

3668

# is a number or a quoted string. You must escape backslash (\\) and

3669

# quote (\") characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3670

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3671

# Supported functions are `LOWER([field_name])` to

3672

# perform a case insensitive match and `EMPTY([field_name])` to filter on the

3673

# existence of a key.

3674

#

3675

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

3676

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100

3677

# comparisons or functions are allowed in the expression. The expression

3678

# must be < 6000 bytes in length.

3679

#

3680

# Sample Query:

3681

# `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND

3682

# driving_years > 10`

3683

"publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3684

# against.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3685

"startTime": "A String", # Begin of the period.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3686

"endTime": "A String", # End of the period.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3687

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3688

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3689

# search against. See LocationFilter for more information.

3690

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3691

# If a location value isn't specified, jobs fitting the other search

3692

# criteria are retrieved regardless of where they're located.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3693

#

3694

# If multiple values are specified, jobs are retrieved from any of the

3695

# specified locations. If different values are specified for the

3696

# LocationFilter.distance_in_miles parameter, the maximum provided

3697

# distance is used for all locations.

3698

#

3699

# At most 5 location filters are allowed.

3700

{ # Input only.

3701

#

3702

# Geographic region of the search.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3703

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used

3704

# to address ambiguity of the user-input location, for example, "Liverpool"

3705

# against "Liverpool, NY, US" or "Liverpool, UK".

3706

#

3707

# Set this field if all the jobs to search against are from a same region,

3708

# or jobs are world-wide, but the job seeker is from a specific region.

3709

#

3710

# See http://cldr.unicode.org/ and

3711

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3712

# for details. Example: "CH" for Switzerland.

3713

"address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

3714

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

3715

# identified as a city or smaller. When the location being searched for is a

3716

# state or larger, this field is ignored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3717

"telecommutePreference": "A String", # Optional. Allows the client to return jobs without a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3718

# set location, specifically, telecommuting jobs (telecommuting is considered

3719

# by the service as a special location.

3720

# Job.posting_region indicates if a job permits telecommuting.

3721

# If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,

3722

# telecommuting jobs are searched, and address and lat_lng are

3723

# ignored. If not set or set to

3724

# TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not

3725

# searched.

3726

#

3727

# This filter can be used by itself to search exclusively for telecommuting

3728

# jobs, or it can be combined with another location

3729

# filter to search for a combination of job locations,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3730

# such as "Mountain View" or "telecommuting" jobs. However, when used in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3731

# combination with other location filters, telecommuting jobs can be

3732

# treated as less relevant than other jobs in the search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3733

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

3734

# search. This field's ignored if `address` is provided.

3735

# of doubles representing degrees latitude and degrees longitude. Unless

3736

# specified otherwise, this must conform to the

3737

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3738

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3739

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3740

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3741

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3742

},

3743

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3744

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for

3745

# example, driving or public transit). Note: This only works with COMMUTE

3746

# MODE. When specified, [JobQuery.location_filters] is

3747

# ignored.

3748

#

3749

# Currently we don't support sorting by commute time.

3750

#

3751

# Parameters needed for commute search.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3752

"travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

3753

# (one hour). Format is `123s`.

3754

"startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

3755

# commute time.

3756

# of doubles representing degrees latitude and degrees longitude. Unless

3757

# specified otherwise, this must conform to the

3758

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3759

# standard</a>. Values must be within normalized ranges.

3760

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3761

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3762

},

3763

"commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3764

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

3765

"allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS

3766

# coordinates) might also be returned. For city and coarser level addresses,

3767

# text matching is used. If this field is set to false or is not specified,

3768

# only jobs that include precise addresses are returned by Commute

3769

# Search.

3770

#

3771

# Note: If `allow_imprecise_addresses` is set to true, Commute Search is not

3772

# able to calculate accurate commute times to jobs with city level and

3773

# coarser address information. Jobs with imprecise addresses will return a

3774

# `travel_duration` time of 0 regardless of distance from the job seeker.

3775

"departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as

3776

# google.type.TimeOfDay in local time zone.

3777

#

3778

# Currently traffic model is restricted to hour level resolution.

3779

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3780

# types are google.type.Date and `google.protobuf.Timestamp`.

3781

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3782

# to allow the value "24:00:00" for scenarios like business closing time.

3783

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3784

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3785

# allow the value 60 if it allows leap-seconds.

3786

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3787

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3788

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3789

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

3790

# for example, "en-US".

3791

#

3792

# 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".

3797

# For more information, see

3798

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

3799

#

3800

# At most 10 language code filters are allowed.

3801

"A String",

3802

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3803

"query": "A String", # Optional. The query string that matches against the job title, description, and

3804

# location fields.

3805

#

3806

# The maximum number of allowed characters is 255.

3807

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3808

# Job.compensation_info. For example, if the filter is specified

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3809

# as "Hourly job with per-hour compensation > $15", only jobs meeting

3810

# these criteria are searched. If a filter isn't defined, all open jobs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3811

# are searched.

3812

#

3813

# Filter on job compensation type and amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3814

"range": { # Compensation range. # Optional. Compensation range.

3815

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3816

# to a maximal compensation value and the currency code is set to

3817

# match the currency code of

3818

# min_compensation.

3819

"nanos": 42, # Number of nano (10^-9) units of the amount.

3820

# The value must be between -999,999,999 and +999,999,999 inclusive.

3821

# If `units` is positive, `nanos` must be positive or zero.

3822

# If `units` is zero, `nanos` can be positive, zero, or negative.

3823

# If `units` is negative, `nanos` must be negative or zero.

3824

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3825

"units": "A String", # The whole units of the amount.

3826

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3827

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3828

},

3829

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3830

# to zero and the currency code is set to match the

3831

# currency code of max_compensation.

3832

"nanos": 42, # Number of nano (10^-9) units of the amount.

3833

# The value must be between -999,999,999 and +999,999,999 inclusive.

3834

# If `units` is positive, `nanos` must be positive or zero.

3835

# If `units` is zero, `nanos` can be positive, zero, or negative.

3836

# If `units` is negative, `nanos` must be negative or zero.

3837

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3838

"units": "A String", # The whole units of the amount.

3839

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3840

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3841

},

3842

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3843

"type": "A String", # Required. Type of filter.

3844

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are

3845

# included.

3846

"units": [ # Required. Specify desired `base compensation entry's`

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3847

# CompensationInfo.CompensationUnit.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3848

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3849

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3850

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3851

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

3852

# service attempts to correct a misspelled query,

3853

# for example, "enginee" is corrected to "engineer".

3854

#

3855

# Defaults to false: a spell check is performed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3856

"companyDisplayNames": [ # Optional. This filter specifies the exact company display

3857

# name of the jobs to search against.

3858

#

3859

# If a value isn't specified, jobs within the search results are

3860

# associated with any company.

3861

#

3862

# If multiple values are specified, jobs within the search results may be

3863

# associated with any of the specified companies.

3864

#

3865

# At most 20 company display name filters are allowed.

3866

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3867

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3868

"jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.

3869

# See Category for more information.

3870

#

3871

# If a value is not specified, jobs from any category are searched against.

3872

#

3873

# If multiple values are specified, jobs from any of the specified

3874

# categories are searched against.

3875

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3876

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3877

"companyNames": [ # Optional. This filter specifies the company entities to search against.

3878

#

3879

# If a value isn't specified, jobs are searched for against all

3880

# companies.

3881

#

3882

# If multiple values are specified, jobs are searched against the

3883

# companies specified.

3884

#

3885

# The format is "projects/{project_id}/companies/{company_id}", for example,

3886

# "projects/api-test-project/companies/foo".

3887

#

3888

# At most 20 company filters are allowed.

3889

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3890

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3891

"queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to

3892

# better interpret the query.

3893

#

3894

# If a value isn't specified, the query language code is automatically

3895

# detected, which may not be accurate.

3896

#

3897

# Language code should be in BCP-47 format, such as "en-US" or "sr-Latn".

3898

# For more information, see

3899

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

3900

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

3901

# search against, such as EmploymentType.FULL_TIME.

3902

#

3903

# If a value is not specified, jobs in the search results includes any

3904

# employment type.

3905

#

3906

# If multiple values are specified, jobs in the search results include

3907

# any of the specified employment types.

3908

"A String",

3909

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3910

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3911

"jobView": "A String", # Optional. The desired job attributes returned for jobs in the

3912

# search response. Defaults to JobView.SMALL if no value is specified.

3913

"requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3914

# count of the first 300 results. Setting this to `true` ensures

3915

# consistency in the number of results per page. Best practice is to set this

3916

# value to true if a client allows users to jump directly to a

3917

# non-sequential search results page.

3918

#

3919

# Enabling this flag may adversely impact performance.

3920

#

3921

# Defaults to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3922

"pageToken": "A String", # Optional. The token specifying the current offset within

3923

# search results. See SearchJobsResponse.next_page_token for

3924

# an explanation of how to obtain the next set of query results.

3925

"diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in

3926

# the search results. Jobs are identified as highly similar based on

3927

# their titles, job categories, and locations. Highly similar results are

3928

# clustered so that only one representative job of the cluster is

3929

# displayed to the job seeker higher up in the results, with the other jobs

3930

# being displayed lower down in the results.

3931

#

3932

# Defaults to DiversificationLevel.SIMPLE if no value

3933

# is specified.

3934

"searchMode": "A String", # Optional. Mode of a search.

3935

#

3936

# Defaults to SearchMode.JOB_SEARCH.

3937

"requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the

3938

# search quality of the service. The identifiers (such as `user_id`) are

3939

# provided by users, and must be unique and consistent.

3940

#

3941

# Meta information related to the job searcher or entity

3942

# conducting the job search. This information is used to improve the

3943

# performance of the service.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3944

"deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the

3945

# service.

3946

# other entity conducting the job search. Providing this information improves

3947

# the quality of the search results across devices.

3948

"deviceType": "A String", # Optional. Type of the device.

3949

"id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that

3950

# distinguishes the device from other devices.

3951

},

3952

"sessionId": "A String", # Required. A unique session identification string. A session is defined as the

3953

# duration of an end user's interaction with the service over a certain

3954

# period.

3955

# Obfuscate this field for privacy concerns before

3956

# providing it to the service.

3957

#

3958

# If this field is not available for some reason, send "UNKNOWN". Note

3959

# that any improvements to the model for a particular tenant

3960

# site, rely on this field being set correctly to some unique session_id.

3961

#

3962

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3963

"domain": "A String", # Required. The client-defined scope or source of the service call, which typically

3964

# is the domain on

3965

# which the service has been implemented and is currently being run.

3966

#

3967

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

3968

# job board www.foo.com and career site www.bar.com, then this field is

3969

# set to "foo.com" for use on the job board, and "bar.com" for use on the

3970

# career site.

3971

#

3972

# If this field isn't available for some reason, send "UNKNOWN".

3973

# Any improvements to the model for a particular tenant site rely on this

3974

# field being set correctly to a domain.

3975

#

3976

# The maximum number of allowed characters is 255.

3977

"userId": "A String", # Required. A unique user identification string, as determined by the client.

3978

# To have the strongest positive impact on search quality

3979

# make sure the client-level is unique.

3980

# Obfuscate this field for privacy concerns before

3981

# providing it to the service.

3982

#

3983

# If this field is not available for some reason, send "UNKNOWN". Note

3984

# that any improvements to the model for a particular tenant

3985

# site, rely on this field being set correctly to a unique user_id.

3986

#

3987

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3988

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3989

}

3990

3991

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# Response for SearchJob method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4002

"metadata": { # Output only. # Additional information for the API invocation, such as the request

4003

# tracking id.

4004

#

4005

# Additional information returned to client, such as debugging information.

4006

"requestId": "A String", # A unique id associated with this call.

4007

# This id is logged for tracking purposes.

4008

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4009

"histogramResults": { # Output only. # The histogram results that match specified

4010

# SearchJobsRequest.histogram_facets.

4011

#

4012

# Histogram results that match HistogramFacets specified in

4013

# SearchJobsRequest.

4014

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that match

4015

# HistogramFacets.compensation_histogram_requests.

4016

{ # Output only.

4017

#

4018

# Compensation based histogram result.

4019

"result": { # Output only. # Histogram result.

4020

#

4021

# Custom numeric bucketing result.

4022

"counts": [ # Count within each bucket. Its size is the length of

4023

# NumericBucketingOption.bucket_bounds plus 1.

4024

{ # Represents count of jobs within one bucket.

4025

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

4026

# that is, the count represents number of jobs in this range.

4027

"to": 3.14, # Ending value of the bucket range.

4028

"from": 3.14, # Starting value of the bucket range.

4029

},

4030

"count": 42, # Number of jobs whose numeric field value fall into `range`.

4031

},

4032

],

4033

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

4034

# [NumericBucketingOption.requires_min_max] is set to true.

4035

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

4036

# [NumericBucketingOption.requires_min_max] is set to true.

4037

},

4038

"type": "A String", # Type of the request, corresponding to

4039

# CompensationHistogramRequest.type.

4040

},

4041

],

4042

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match

4043

# HistogramFacets.custom_attribute_histogram_facets.

4044

{ # Output only.

4045

#

4046

# Custom attribute histogram result.

4047

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

4048

# custom attribute long values associated with `key`.

4049

#

4050

# Custom numeric bucketing result.

4051

"counts": [ # Count within each bucket. Its size is the length of

4052

# NumericBucketingOption.bucket_bounds plus 1.

4053

{ # Represents count of jobs within one bucket.

4054

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

4055

# that is, the count represents number of jobs in this range.

4056

"to": 3.14, # Ending value of the bucket range.

4057

"from": 3.14, # Starting value of the bucket range.

4058

},

4059

"count": 42, # Number of jobs whose numeric field value fall into `range`.

4060

},

4061

],

4062

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

4063

# [NumericBucketingOption.requires_min_max] is set to true.

4064

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

4065

# [NumericBucketingOption.requires_min_max] is set to true.

4066

},

4067

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

4068

# with `key` to the number of jobs with that value in this histogram result.

4069

"a_key": 42,

4070

},

4071

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

4072

},

4073

],

4074

"simpleHistogramResults": [ # Specifies histogram results that matches

4075

# HistogramFacets.simple_histogram_facets.

4076

{ # Output only.

4077

#

4078

# Result of a histogram call. The response contains the histogram map for the

4079

# search type specified by HistogramResult.field.

4080

# The response is a map of each filter value to the corresponding count of

4081

# jobs for that filter.

4082

"values": { # A map from the values of field to the number of jobs with that value

4083

# in this search result.

4084

#

4085

# Key: search type (filter names, such as the companyName).

4086

#

4087

# Values: the count of jobs that match the filter for this search.

4088

"a_key": 42,

4089

},

4090

"searchType": "A String", # The Histogram search filters.

4091

},

4092

],

4093

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4094

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

4095

{ # Output only.

4096

#

4097

# Job entry with metadata inside SearchJobsResponse.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4098

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

4099

# or "job requisition"). A job belongs to a Company, which is the hiring

4100

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4101

"name": "A String", # Required during job update.

4102

#

4103

# The resource name for the job. This is generated by the service when a

4104

# job is created.

4105

#

4106

# The format is "projects/{project_id}/jobs/{job_id}",

4107

# for example, "projects/api-test-project/jobs/1234".

4108

#

4109

# Use of this field in job queries and API calls is preferred over the use of

4110

# requisition_id since this value is unique.

4111

"jobBenefits": [ # Optional. The benefits included with the job.

4112

"A String",

4113

],

4114

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

4115

# The value determines the sort order of the jobs returned when searching for

4116

# jobs using the featured jobs search call, with higher promotional values

4117

# being returned first and ties being resolved by relevance sort. Only the

4118

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

4119

#

4120

# Default value is 0, and negative values are treated as 0.

4121

"title": "A String", # Required. The title of the job, such as "Software Engineer"

4122

#

4123

# The maximum number of allowed characters is 500.

4124

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4125

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

4126

# job. The use of this field is recommended

4127

# as an alternative to using the more general description field.

4128

#

4129

# This field accepts and sanitizes HTML input, and also accepts

4130

# bold, italic, ordered list, and unordered list markup tags.

4131

#

4132

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4133

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

4134

# client to identify a job. This field is intended to be used by clients

4135

# for client identification and tracking of postings. A job is not allowed

4136

# to be created if there is another job with the same [company_name],

4137

# language_code and requisition_id.

4138

#

4139

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4140

"processingOptions": { # Input only. # Optional. Options for job processing.

4141

#

4142

# Options for job processing.

4143

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

4144

# more precise address for the job.

4145

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

4146

#

4147

# * description

4148

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

4154

# disabled.

4155

#

4156

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

4157

},

4158

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

4159

# engagements. Invalid timestamps are ignored.

4160

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

4161

#

4162

# Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4163

"locations": [ # Structured locations of the job, resolved from Job.addresses.

4164

#

4165

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4170

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

4171

# location bounding box in which a circle with the specified radius

4172

# centered from LatLng covers the area associated with the job location.

4173

# For example, currently, "Mountain View, CA, USA" has a radius of

4174

# 6.17 miles.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4175

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4176

# of doubles representing degrees latitude and degrees longitude. Unless

4177

# specified otherwise, this must conform to the

4178

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4179

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4180

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4181

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4182

},

4183

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4184

# such as postal delivery and payments addresses. Given a postal address,

4185

# a postal service can deliver items to a premises, P.O. Box, or other

4186

# delivery location.

4187

# Given a postal address, a postal service can deliver items to a premise, P.O.

4188

# Box or similar.

4189

# It is not intended to model geographical locations (roads, towns,

4190

# mountains).

4191

#

4192

# In typical usage an address would be created via user input or from importing

4193

# existing data, depending on the type of process.

4194

#

4195

# Advice on address input / editing:

4196

# - Use an i18n-ready address widget such as

4197

# https://github.com/google/libaddressinput)

4198

# - Users should not be presented with UI elements for input or editing of

4199

# fields outside countries where that field is used.

4200

#

4201

# For more guidance on how to use this schema, please see:

4202

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4203

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

4204

# postal codes to be present, but where they are used, they may trigger

4205

# additional validation with other parts of the address (e.g. state/zip

4206

# validation in the U.S.A.).

4207

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4208

# known). This is often the UI language of the input form or is expected

4209

# to match one of the languages used in the address' country/region, or their

4210

# transliterated equivalents.

4211

# This can affect formatting in certain countries, but is not critical

4212

# to the correctness of the data and will never affect any validation or

4213

# other non-formatting related operations.

4214

#

4215

# If this value is not known, it should be omitted (rather than specifying a

4216

# possibly incorrect default).

4217

#

4218

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

4219

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

4220

# in most regions. Where it is used, the value is either a string like

4221

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

4222

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

4223

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

4224

"recipients": [ # Optional. The recipient at the address.

4225

# This field may, under certain circumstances, contain multiline information.

4226

# For example, it might contain "care of" information.

4227

"A String",

4228

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4229

"sublocality": "A String", # Optional. Sublocality of the address.

4230

# For example, this can be neighborhoods, boroughs, districts.

4231

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

4232

# the latest revision.

4233

#

4234

# All new revisions **must** be backward compatible with old revisions.

4235

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

4236

# Examples: US city, IT comune, UK post town.

4237

# In regions of the world where localities are not well defined or do not fit

4238

# into this structure well, leave locality empty and use address_lines.

4239

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

4240

# addresses of a country or region.

4241

# For example, this can be a state, a province, an oblast, or a prefecture.

4242

# Specifically, for Spain this is the province and not the autonomous

4243

# community (e.g. "Barcelona" and not "Catalonia").

4244

# Many countries don't use an administrative area in postal addresses. E.g.

4245

# in Switzerland this should be left unpopulated.

4246

"organization": "A String", # Optional. The name of the organization at the address.

4247

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

4248

#

4249

# Because values in address_lines do not have type information and may

4250

# sometimes contain multiple values in a single field (e.g.

4251

# "Austin, TX"), it is important that the line order is clear. The order of

4252

# address lines should be "envelope order" for the country/region of the

4253

# address. In places where this can vary (e.g. Japan), address_language is

4254

# used to make it explicit (e.g. "ja" for large-to-small ordering and

4255

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

4256

# an address can be selected based on the language.

4257

#

4258

# The minimum permitted structural representation of an address consists

4259

# of a region_code with all remaining information placed in the

4260

# address_lines. It would be possible to format such an address very

4261

# approximately without geocoding, but no semantic reasoning could be

4262

# made about any of the address components until it was at least

4263

# partially resolved.

4264

#

4265

# Creating an address only containing a region_code and address_lines, and

4266

# then geocoding is the recommended way to handle completely unstructured

4267

# addresses (as opposed to guessing which parts of the address should be

4268

# localities or administrative areas).

4269

"A String",

4270

],

4271

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

4272

# is never inferred and it is up to the user to ensure the value is

4273

# correct. See http://cldr.unicode.org/ and

4274

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4275

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4276

},

4277

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4278

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4279

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4280

# LocationType#LOCALITY.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4281

},

4282

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4283

"jobCategories": [ # Job categories derived from Job.title and Job.description.

4284

"A String",

4285

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4286

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4287

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

4288

# incentives associated with the job not including salary or pay.

4289

#

4290

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4291

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4296

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

4297

"addresses": [ # Optional but strongly recommended for the best service experience.

4298

#

4299

# Location(s) where the employer is looking to hire for this job posting.

4300

#

4301

# Specifying the full street address(es) of the hiring location enables

4302

# better API results, especially job searches by commute time.

4303

#

4304

# At most 50 locations are allowed for best search performance. If a job has

4305

# more locations, it is suggested to split it into multiple jobs with unique

4306

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

4307

# multiple jobs with the same company_name, language_code and

4308

# requisition_id are not allowed. If the original requisition_id must

4309

# be preserved, a custom field should be used for storage. It is also

4310

# suggested to group the locations that close to each other in the same job

4311

# for better search experience.

4312

#

4313

# The maximum number of allowed characters is 500.

4314

"A String",

4315

],

4316

"companyName": "A String", # Required. The resource name of the company listing the job, such as

4317

# "projects/api-test-project/companies/foo".

4318

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

4319

# description of the company and related information. Separate fields are

4320

# provided on the job object for responsibilities,

4321

# qualifications, and other job characteristics. Use of

4322

# these separate job fields is recommended.

4323

#

4324

# This field accepts and sanitizes HTML input, and also accepts

4325

# bold, italic, ordered list, and unordered list markup tags.

4326

#

4327

# The maximum number of allowed characters is 100,000.

4328

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

4329

# is used for contracting engagements. Invalid timestamps are ignored.

4330

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

4331

"A String",

4332

],

4333

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4334

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

4335

# all compensation entries' CompensationEntry.compensation times

4336

# CompensationEntry.expected_units_per_year.

4337

#

4338

# See CompensationEntry for explanation on compensation annualization.

4339

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4340

# to a maximal compensation value and the currency code is set to

4341

# match the currency code of

4342

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4343

"nanos": 42, # Number of nano (10^-9) units of the amount.

4344

# The value must be between -999,999,999 and +999,999,999 inclusive.

4345

# If `units` is positive, `nanos` must be positive or zero.

4346

# If `units` is zero, `nanos` can be positive, zero, or negative.

4347

# If `units` is negative, `nanos` must be negative or zero.

4348

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4349

"units": "A String", # The whole units of the amount.

4350

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4351

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4352

},

4353

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4354

# to zero and the currency code is set to match the

4355

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4356

"nanos": 42, # Number of nano (10^-9) units of the amount.

4357

# The value must be between -999,999,999 and +999,999,999 inclusive.

4358

# If `units` is positive, `nanos` must be positive or zero.

4359

# If `units` is zero, `nanos` can be positive, zero, or negative.

4360

# If `units` is negative, `nanos` must be negative or zero.

4361

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4362

"units": "A String", # The whole units of the amount.

4363

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4364

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4365

},

4366

},

4367

"entries": [ # Optional. Job compensation information.

4368

#

4369

# At most one entry can be of type

4370

# CompensationInfo.CompensationType.BASE, which is

4371

# referred as ** base compensation entry ** for the job.

4372

{ # A compensation entry that represents one component of compensation, such

4373

# as base pay, bonus, or other compensation type.

4374

#

4375

# Annualization: One compensation entry can be annualized if

4376

# - it contains valid amount or range.

4377

# - and its expected_units_per_year is set or can be derived.

4378

# Its annualized range is determined as (amount or range) times

4379

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4380

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4381

"nanos": 42, # Number of nano (10^-9) units of the amount.

4382

# The value must be between -999,999,999 and +999,999,999 inclusive.

4383

# If `units` is positive, `nanos` must be positive or zero.

4384

# If `units` is zero, `nanos` can be positive, zero, or negative.

4385

# If `units` is negative, `nanos` must be negative or zero.

4386

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4387

"units": "A String", # The whole units of the amount.

4388

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4389

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4390

},

4391

"type": "A String", # Optional. Compensation type.

4392

#

4393

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

4394

"range": { # Compensation range. # Optional. Compensation range.

4395

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4396

# to a maximal compensation value and the currency code is set to

4397

# match the currency code of

4398

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4399

"nanos": 42, # Number of nano (10^-9) units of the amount.

4400

# The value must be between -999,999,999 and +999,999,999 inclusive.

4401

# If `units` is positive, `nanos` must be positive or zero.

4402

# If `units` is zero, `nanos` can be positive, zero, or negative.

4403

# If `units` is negative, `nanos` must be negative or zero.

4404

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4405

"units": "A String", # The whole units of the amount.

4406

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4407

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4408

},

4409

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4410

# to zero and the currency code is set to match the

4411

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4412

"nanos": 42, # Number of nano (10^-9) units of the amount.

4413

# The value must be between -999,999,999 and +999,999,999 inclusive.

4414

# If `units` is positive, `nanos` must be positive or zero.

4415

# If `units` is zero, `nanos` can be positive, zero, or negative.

4416

# If `units` is negative, `nanos` must be negative or zero.

4417

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4418

"units": "A String", # The whole units of the amount.

4419

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4420

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4421

},

4422

},

4423

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

4424

# Job.employment_types is FULLTIME, a default value is inferred

4425

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"description": "A String", # Optional. Compensation description. For example, could

4432

# indicate equity terms or provide additional context to an estimated

4433

# bonus.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4434

"unit": "A String", # Optional. Frequency of the specified amount.

4435

#

4436

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4437

},

4438

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4439

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

4440

# base compensation entry's CompensationEntry.compensation times

4441

# CompensationEntry.expected_units_per_year.

4442

#

4443

# See CompensationEntry for explanation on compensation annualization.

4444

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4445

# to a maximal compensation value and the currency code is set to

4446

# match the currency code of

4447

# min_compensation.

4448

"nanos": 42, # Number of nano (10^-9) units of the amount.

4449

# The value must be between -999,999,999 and +999,999,999 inclusive.

4450

# If `units` is positive, `nanos` must be positive or zero.

4451

# If `units` is zero, `nanos` can be positive, zero, or negative.

4452

# If `units` is negative, `nanos` must be negative or zero.

4453

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4454

"units": "A String", # The whole units of the amount.

4455

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4456

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4457

},

4458

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4459

# to zero and the currency code is set to match the

4460

# currency code of max_compensation.

4461

"nanos": 42, # Number of nano (10^-9) units of the amount.

4462

# The value must be between -999,999,999 and +999,999,999 inclusive.

4463

# If `units` is positive, `nanos` must be positive or zero.

4464

# If `units` is zero, `nanos` can be positive, zero, or negative.

4465

# If `units` is negative, `nanos` must be negative or zero.

4466

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4467

"units": "A String", # The whole units of the amount.

4468

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4469

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4470

},

4471

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4472

},

4473

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

4474

# recommended as an alternative to using the more general description

4475

# field.

4476

#

4477

# This field accepts and sanitizes HTML input, and also accepts

4478

# bold, italic, ordered list, and unordered list markup tags.

4479

#

4480

# The maximum number of allowed characters is 10,000.

4481

"department": "A String", # Optional. The department or functional area within the company with the open

4482

# position.

4483

#

4484

# The maximum number of allowed characters is 255.

4485

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

4486

#

4487

# Job application information.

4488

"uris": [ # Optional but at least one of uris,

4489

# emails or instruction must be

4490

# specified.

4491

#

4492

# Use this URI field to direct an applicant to a website, for example to

4493

# link to an online application form.

4494

#

4495

# The maximum number of allowed characters for each entry is 2,000.

4496

"A String",

4497

],

4498

"emails": [ # Optional but at least one of uris,

4499

# emails or instruction must be

4500

# specified.

4501

#

4502

# Use this field to specify email address(es) to which resumes or

4503

# applications can be sent.

4504

#

4505

# The maximum number of allowed characters for each entry is 255.

4506

"A String",

4507

],

4508

"instruction": "A String", # Optional but at least one of uris,

4509

# emails or instruction must be

4510

# specified.

4511

#

4512

# Use this field to provide instructions, such as "Mail your application

4513

# to ...", that a candidate can follow to apply for the job.

4514

#

4515

# This field accepts and sanitizes HTML input, and also accepts

4516

# bold, italic, ordered list, and unordered list markup tags.

4517

#

4518

# The maximum number of allowed characters is 3,000.

4519

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4520

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

4521

# the job is available. If this field is set, a

4522

# LocationFilter in a search query within the job region

4523

# finds this job posting if an exact location match isn't specified.

4524

# If this field is set to PostingRegion.NATION or

4525

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

4526

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4527

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

4528

# experience.

4529

#

4530

# The expiration timestamp of the job. After this timestamp, the

4531

# job is marked as expired, and it no longer appears in search results. The

4532

# expired job can't be deleted or listed by the DeleteJob and

4533

# ListJobs APIs, but it can be retrieved with the GetJob API or

4534

# updated with the UpdateJob API. An expired job can be updated and

4535

# opened again by using a future expiration timestamp. Updating an expired

4536

# job fails if there is another existing open job with same company_name,

4537

# language_code and requisition_id.

4538

#

4539

# The expired jobs are retained in our system for 90 days. However, the

4540

# overall expired job count cannot exceed 3 times the maximum of open jobs

4541

# count over the past week, otherwise jobs with earlier expire time are

4542

# cleaned first. Expired jobs are no longer accessible after they are cleaned

4543

# out.

4544

#

4545

# Invalid timestamps are ignored, and treated as expire time not provided.

4546

#

4547

# Timestamp before the instant request is made is considered valid, the job

4548

# will be treated as expired immediately.

4549

#

4550

# If this value is not provided at the time of job creation or is invalid,

4551

# the job posting expires after 30 days from the job's creation time. For

4552

# example, if the job was created on 2017/01/01 13:00AM UTC with an

4553

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

4554

#

4555

# If this value is not provided on job update, it depends on the field masks

4556

# set by UpdateJobRequest.update_mask. If the field masks include

4557

# expiry_time, or the masks are empty meaning that every field is

4558

# updated, the job posting expires after 30 days from the job's last

4559

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4560

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

4561

# value is the time the request arrives at the server. Invalid timestamps are

4562

# ignored.

4563

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

4564

# attributes that are not covered by the provided structured fields.

4565

#

4566

# The keys of the map are strings up to 64 bytes and must match the

4567

# pattern: a-zA-Z*. For example, key0LikeThis or

4568

# KEY_1_LIKE_THIS.

4569

#

4570

# At most 100 filterable and at most 100 unfilterable keys are supported.

4571

# For filterable `string_values`, across all keys at most 200 values are

4572

# allowed, with each string no more than 255 characters. For unfilterable

4573

# `string_values`, the maximum total size of `string_values` across all keys

4574

# is 50KB.

4575

"a_key": { # Custom attribute values that are either filterable or non-filterable.

4576

"stringValues": [ # Optional but exactly one of string_values or long_values must

4577

# be specified.

4578

#

4579

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

4580

# `CASE_INSENSITIVE_MATCH`) search.

4581

# For filterable `string_value`s, a maximum total number of 200 values

4582

# is allowed, with each `string_value` has a byte size of no more than

4583

# 500B. For unfilterable `string_values`, the maximum total byte size of

4584

# unfilterable `string_values` is 50KB.

4585

#

4586

# Empty string is not allowed.

4587

"A String",

4588

],

4589

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

4590

# custom attribute filters JobQuery.custom_attribute_filter.

4591

# If false, these values may not be used for custom attribute filters.

4592

#

4593

# Default is false.

4594

"longValues": [ # Optional but exactly one of string_values or long_values must

4595

# be specified.

4596

#

4597

# This field is used to perform number range search.

4598

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

4599

#

4600

# Currently at most 1 long_values is supported.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4605

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

4606

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

4607

# any requirements for fluency that are associated with the job.

4608

#

4609

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

4610

# For more information, see

4611

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

4612

# class="external" target="_blank" }.

4613

#

4614

# If this field is unspecified and Job.description is present, detected

4615

# language code based on Job.description is assigned, otherwise

4616

# defaults to 'en_US'.

4617

"visibility": "A String", # Deprecated. The job is only visible to the owner.

4618

#

4619

# The visibility of the job.

4620

#

4621

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

4622

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

4623

},

4624

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

4625

# fields that most closely match a search query's keywords, if available.

4626

# All HTML tags in the original fields are stripped when returned in this

4627

# field, and matching query keywords are enclosed in HTML bold tags.

4628

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

4629

# closely matching a search query's keywords, if available. The matching

4630

# query keywords are enclosed in HTML bold tags.

4631

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

4632

# results listing page.

4633

"commuteInfo": { # Output only. # Commute information which is generated based on specified

4634

# CommuteFilter.

4635

#

4636

# Commute details related to this job.

4637

"travelDuration": "A String", # The number of seconds required to travel to the job location from the

4638

# query location. A duration of 0 seconds indicates that the job is not

4639

# reachable within the requested duration, but was returned as part of an

4640

# expanded query.

4641

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

4642

#

4643

# A resource that represents a location with full geographic information.

4644

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

4645

# location bounding box in which a circle with the specified radius

4646

# centered from LatLng covers the area associated with the job location.

4647

# For example, currently, "Mountain View, CA, USA" has a radius of

4648

# 6.17 miles.

4649

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4650

# of doubles representing degrees latitude and degrees longitude. Unless

4651

# specified otherwise, this must conform to the

4652

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4653

# standard</a>. Values must be within normalized ranges.

4654

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4655

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4656

},

4657

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4658

# such as postal delivery and payments addresses. Given a postal address,

4659

# a postal service can deliver items to a premises, P.O. Box, or other

4660

# delivery location.

4661

# Given a postal address, a postal service can deliver items to a premise, P.O.

4662

# Box or similar.

4663

# It is not intended to model geographical locations (roads, towns,

4664

# mountains).

4665

#

4666

# In typical usage an address would be created via user input or from importing

4667

# existing data, depending on the type of process.

4668

#

4669

# Advice on address input / editing:

4670

# - Use an i18n-ready address widget such as

4671

# https://github.com/google/libaddressinput)

4672

# - Users should not be presented with UI elements for input or editing of

4673

# fields outside countries where that field is used.

4674

#

4675

# For more guidance on how to use this schema, please see:

4676

# https://support.google.com/business/answer/6397478

4677

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

4678

# postal codes to be present, but where they are used, they may trigger

4679

# additional validation with other parts of the address (e.g. state/zip

4680

# validation in the U.S.A.).

4681

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4682

# known). This is often the UI language of the input form or is expected

4683

# to match one of the languages used in the address' country/region, or their

4684

# transliterated equivalents.

4685

# This can affect formatting in certain countries, but is not critical

4686

# to the correctness of the data and will never affect any validation or

4687

# other non-formatting related operations.

4688

#

4689

# If this value is not known, it should be omitted (rather than specifying a

4690

# possibly incorrect default).

4691

#

4692

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

4693

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

4694

# in most regions. Where it is used, the value is either a string like

4695

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

4696

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

4697

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

4698

"recipients": [ # Optional. The recipient at the address.

4699

# This field may, under certain circumstances, contain multiline information.

4700

# For example, it might contain "care of" information.

4701

"A String",

4702

],

4703

"sublocality": "A String", # Optional. Sublocality of the address.

4704

# For example, this can be neighborhoods, boroughs, districts.

4705

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

4706

# the latest revision.

4707

#

4708

# All new revisions **must** be backward compatible with old revisions.

4709

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

4710

# Examples: US city, IT comune, UK post town.

4711

# In regions of the world where localities are not well defined or do not fit

4712

# into this structure well, leave locality empty and use address_lines.

4713

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

4714

# addresses of a country or region.

4715

# For example, this can be a state, a province, an oblast, or a prefecture.

4716

# Specifically, for Spain this is the province and not the autonomous

4717

# community (e.g. "Barcelona" and not "Catalonia").

4718

# Many countries don't use an administrative area in postal addresses. E.g.

4719

# in Switzerland this should be left unpopulated.

4720

"organization": "A String", # Optional. The name of the organization at the address.

4721

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

4722

#

4723

# Because values in address_lines do not have type information and may

4724

# sometimes contain multiple values in a single field (e.g.

4725

# "Austin, TX"), it is important that the line order is clear. The order of

4726

# address lines should be "envelope order" for the country/region of the

4727

# address. In places where this can vary (e.g. Japan), address_language is

4728

# used to make it explicit (e.g. "ja" for large-to-small ordering and

4729

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

4730

# an address can be selected based on the language.

4731

#

4732

# The minimum permitted structural representation of an address consists

4733

# of a region_code with all remaining information placed in the

4734

# address_lines. It would be possible to format such an address very

4735

# approximately without geocoding, but no semantic reasoning could be

4736

# made about any of the address components until it was at least

4737

# partially resolved.

4738

#

4739

# Creating an address only containing a region_code and address_lines, and

4740

# then geocoding is the recommended way to handle completely unstructured

4741

# addresses (as opposed to guessing which parts of the address should be

4742

# localities or administrative areas).

4743

"A String",

4744

],

4745

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

4746

# is never inferred and it is up to the user to ensure the value is

4747

# correct. See http://cldr.unicode.org/ and

4748

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4749

# for details. Example: "CH" for Switzerland.

4750

},

4751

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4752

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4753

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4754

# LocationType#LOCALITY.

4755

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

4760

# This field is empty if there are no more results.

4761

"spellCorrection": { # Output only. # The spell checking result, and correction.

4762

#

4763

# Spell check result.

4764

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

4765

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

4766

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4767

"broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the

4768

# broadened query. This number indicates how many of the jobs returned in the

4769

# jobs field are from the broadened query. These results are always at the

4770

# end of the jobs list. In particular, a value of 0, or if the field isn't

4771

# set, all the jobs in the jobs list are from the original

4772

# (without broadening) query. If this field is non-zero, subsequent requests

4773

# with offset after this result set should contain all broadened results.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4774

"estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.

4775

#

4776

# This number is not guaranteed to be accurate. For accurate results,

4777

# see enable_precise_result_size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4778

"totalSize": 42, # The precise result count, which is available only if the client set

4779

# enable_precise_result_size to `true`, or if the response

4780

# is the last page of results. Otherwise, the value is `-1`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4781

"locationFilters": [ # The location filters that the service applied to the specified query. If

4782

# any filters are lat-lng based, the JobLocation.location_type is

4783

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

4784

{ # Output only.

4785

#

4786

# A resource that represents a location with full geographic information.

4787

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

4788

# location bounding box in which a circle with the specified radius

4789

# centered from LatLng covers the area associated with the job location.

4790

# For example, currently, "Mountain View, CA, USA" has a radius of

4791

# 6.17 miles.

4792

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4793

# of doubles representing degrees latitude and degrees longitude. Unless

4794

# specified otherwise, this must conform to the

4795

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4796

# standard</a>. Values must be within normalized ranges.

4797

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4798

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4799

},

4800

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4801

# such as postal delivery and payments addresses. Given a postal address,

4802

# a postal service can deliver items to a premises, P.O. Box, or other

4803

# delivery location.

4804

# Given a postal address, a postal service can deliver items to a premise, P.O.

4805

# Box or similar.

4806

# It is not intended to model geographical locations (roads, towns,

4807

# mountains).

4808

#

4809

# In typical usage an address would be created via user input or from importing

4810

# existing data, depending on the type of process.

4811

#

4812

# Advice on address input / editing:

4813

# - Use an i18n-ready address widget such as

4814

# https://github.com/google/libaddressinput)

4815

# - Users should not be presented with UI elements for input or editing of

4816

# fields outside countries where that field is used.

4817

#

4818

# For more guidance on how to use this schema, please see:

4819

# https://support.google.com/business/answer/6397478

4820

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

4821

# postal codes to be present, but where they are used, they may trigger

4822

# additional validation with other parts of the address (e.g. state/zip

4823

# validation in the U.S.A.).

4824

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4825

# known). This is often the UI language of the input form or is expected

4826

# to match one of the languages used in the address' country/region, or their

4827

# transliterated equivalents.

4828

# This can affect formatting in certain countries, but is not critical

4829

# to the correctness of the data and will never affect any validation or

4830

# other non-formatting related operations.

4831

#

4832

# If this value is not known, it should be omitted (rather than specifying a

4833

# possibly incorrect default).

4834

#

4835

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

4836

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

4837

# in most regions. Where it is used, the value is either a string like

4838

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

4839

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

4840

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

4841

"recipients": [ # Optional. The recipient at the address.

4842

# This field may, under certain circumstances, contain multiline information.

4843

# For example, it might contain "care of" information.

4844

"A String",

4845

],

4846

"sublocality": "A String", # Optional. Sublocality of the address.

4847

# For example, this can be neighborhoods, boroughs, districts.

4848

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

4849

# the latest revision.

4850

#

4851

# All new revisions **must** be backward compatible with old revisions.

4852

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

4853

# Examples: US city, IT comune, UK post town.

4854

# In regions of the world where localities are not well defined or do not fit

4855

# into this structure well, leave locality empty and use address_lines.

4856

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

4857

# addresses of a country or region.

4858

# For example, this can be a state, a province, an oblast, or a prefecture.

4859

# Specifically, for Spain this is the province and not the autonomous

4860

# community (e.g. "Barcelona" and not "Catalonia").

4861

# Many countries don't use an administrative area in postal addresses. E.g.

4862

# in Switzerland this should be left unpopulated.

4863

"organization": "A String", # Optional. The name of the organization at the address.

4864

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

4865

#

4866

# Because values in address_lines do not have type information and may

4867

# sometimes contain multiple values in a single field (e.g.

4868

# "Austin, TX"), it is important that the line order is clear. The order of

4869

# address lines should be "envelope order" for the country/region of the

4870

# address. In places where this can vary (e.g. Japan), address_language is

4871

# used to make it explicit (e.g. "ja" for large-to-small ordering and

4872

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

4873

# an address can be selected based on the language.

4874

#

4875

# The minimum permitted structural representation of an address consists

4876

# of a region_code with all remaining information placed in the

4877

# address_lines. It would be possible to format such an address very

4878

# approximately without geocoding, but no semantic reasoning could be

4879

# made about any of the address components until it was at least

4880

# partially resolved.

4881

#

4882

# Creating an address only containing a region_code and address_lines, and

4883

# then geocoding is the recommended way to handle completely unstructured

4884

# addresses (as opposed to guessing which parts of the address should be

4885

# localities or administrative areas).

4886

"A String",

4887

],

4888

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

4889

# is never inferred and it is up to the user to ensure the value is

4890

# correct. See http://cldr.unicode.org/ and

4891

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4892

# for details. Example: "CH" for Switzerland.

4893

},

4894

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4895

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4896

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4897

# LocationType#LOCALITY.

4898

},

4899

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4904

<code class="details" id="searchForAlert">searchForAlert(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4905

<pre>Searches for jobs using the provided SearchJobsRequest.

4906

4907

This API call is intended for the use case of targeting passive job

4908

seekers (for example, job seekers who have signed up to receive email

4909

alerts about potential job opportunities), and has different algorithmic

4910

adjustments that are targeted to passive job seekers.

4911

4912

This call constrains the visibility of jobs

4913

present in the database, and only returns jobs the caller has

4914

permission to search against.

4915

4916

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4917

parent: string, Required. The resource name of the project to search within.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4918

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4919

The format is "projects/{project_id}", for example,

4920

"projects/api-test-project". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4921

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4922

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4927

"disableKeywordMatch": True or False, # Optional. Controls whether to disable exact keyword match on Job.job_title,

4928

# Job.description, Job.company_display_name, Job.locations,

4929

# Job.qualifications. When disable keyword match is turned off, a

4930

# keyword match returns jobs that do not match given category filters when

4931

# there are matching keywords. For example, the query "program manager," a

4932

# result is returned even if the job posting has the title "software

4933

# developer," which does not fall into "program manager" ontology, but does

4934

# have "program manager" appearing in its description.

4935

#

4936

# For queries like "cloud" that does not contain title or

4937

# location specific ontology, jobs with "cloud" keyword matches are returned

4938

# regardless of this flag's value.

4939

#

4940

# Please use Company.keyword_searchable_custom_fields or

4941

# Company.keyword_searchable_custom_attributes if company specific

4942

# globally matched custom field/attribute string values is needed. Enabling

4943

# keyword match improves recall of subsequent search requests.

4944

#

4945

# Defaults to false.

4946

"enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.

4947

# Broadened queries append results to the end of the matching results

# list.

#

# Defaults to false.

"offset": 42, # Optional. An integer that specifies the current offset (that is, starting result

4952

# location, amongst the jobs deemed by the API as relevant) in search

4953

# results. This field is only considered if page_token is unset.

4954

#

4955

# The maximum allowed value is 5000. Otherwise an error is thrown.

4956

#

4957

# For example, 0 means to return results starting from the first matching

4958

# job, and 10 means to return from the 11th job. This can be used for

4959

# pagination, (for example, pageSize = 10 and offset = 10 means to return

4960

# from the second page).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4961

"pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.

4962

# Increasing this value above the default value of 10 can increase search

4963

# response time. The value can be between 1 and 100.

4964

"histogramFacets": { # Input only. # Optional. Histogram requests for jobs matching JobQuery.

4965

#

4966

# Histogram facets to be specified in SearchJobsRequest.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4967

"compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.

4968

# Duplicate values of CompensationHistogramRequest.type are not allowed.

4969

{ # Input only.

4970

#

4971

# Compensation based histogram request.

4972

"bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.

4973

#

4974

# Use this field to specify bucketing option for the histogram search response.

4975

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

4976

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

4977

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

4978

# [buckets_bound is supported.

4979

3.14,

4980

],

4981

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

4982

# value of the numeric field.

4983

},

4984

"type": "A String", # Required. Type of the request, representing which field the histogramming should be

4985

# performed over. A single request can only specify one histogram of each

4986

# `CompensationHistogramRequestType`.

4987

},

4988

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4989

"customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.

4990

# Duplicate values of CustomAttributeHistogramRequest.key are not

4991

# allowed.

4992

{ # Custom attributes histogram request. An error is thrown if neither

4993

# string_value_histogram or long_value_histogram_bucketing_option has

4994

# been defined.

4995

"longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's

4996

# filterable long custom field values, or min/max value requirements.

4997

#

4998

# Use this field to specify bucketing option for the histogram search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4999

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

5000

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

5001

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

5002

# [buckets_bound is supported.

5003

3.14,

5004

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5005

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

5006

# value of the numeric field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5007

},

5008

"key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified

5009

# without `long_value_histogram_bucketing_option`, histogram on string values

5010

# of the given `key` is triggered, otherwise histogram is performed on long

5011

# values.

5012

"stringValueHistogram": True or False, # Optional. If set to true, the response includes the histogram value for

5013

# each key as a string.

5014

},

5015

],

5016

"simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,

5017

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.

5018

"A String",

5019

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5020

},

5021

"orderBy": "A String", # Optional. The criteria determining how search results are sorted. Default is

5022

# "relevance desc".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5023

#

5024

# Supported options are:

5025

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5026

# * `"relevance desc"`: By relevance descending, as determined by the API

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5027

# algorithms. Relevance thresholding of query results is only available

5028

# with this ordering.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5029

# * `"posting_publish_time desc"`: By Job.posting_publish_time

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5030

# descending.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5031

# * `"posting_update_time desc"`: By Job.posting_update_time

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5032

# descending.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5033

# * `"title"`: By Job.title ascending.

5034

# * `"title desc"`: By Job.title descending.

5035

# * `"annualized_base_compensation"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5036

# CompensationInfo.annualized_base_compensation_range ascending. Jobs

5037

# whose annualized base compensation is unspecified are put at the end of

5038

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5039

# * `"annualized_base_compensation desc"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5040

# CompensationInfo.annualized_base_compensation_range descending. Jobs

5041

# whose annualized base compensation is unspecified are put at the end of

5042

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5043

# * `"annualized_total_compensation"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5044

# CompensationInfo.annualized_total_compensation_range ascending. Jobs

5045

# whose annualized base compensation is unspecified are put at the end of

5046

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5047

# * `"annualized_total_compensation desc"`: By job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5048

# CompensationInfo.annualized_total_compensation_range descending. Jobs

5049

# whose annualized base compensation is unspecified are put at the end of

5050

# search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5051

"jobQuery": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5052

#

5053

# The query required to perform a search query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5054

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

5055

# Job.custom_attributes marked as `filterable`.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5056

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5057

# The syntax for this expression is a subset of SQL syntax.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5058

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5059

# Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the

5060

# left of the operator is a custom field key and the right of the operator

5061

# is a number or a quoted string. You must escape backslash (\\) and

5062

# quote (\") characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5063

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5064

# Supported functions are `LOWER([field_name])` to

5065

# perform a case insensitive match and `EMPTY([field_name])` to filter on the

5066

# existence of a key.

5067

#

5068

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

5069

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100

5070

# comparisons or functions are allowed in the expression. The expression

5071

# must be < 6000 bytes in length.

5072

#

5073

# Sample Query:

5074

# `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND

5075

# driving_years > 10`

5076

"publishTimeRange": { # Message representing a period of time between two timestamps. # Optional. Jobs published within a range specified by this filter are searched

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5077

# against.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5078

"startTime": "A String", # Begin of the period.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5079

"endTime": "A String", # End of the period.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5080

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5081

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5082

# search against. See LocationFilter for more information.

5083

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5084

# If a location value isn't specified, jobs fitting the other search

5085

# criteria are retrieved regardless of where they're located.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5086

#

5087

# If multiple values are specified, jobs are retrieved from any of the

5088

# specified locations. If different values are specified for the

5089

# LocationFilter.distance_in_miles parameter, the maximum provided

5090

# distance is used for all locations.

5091

#

5092

# At most 5 location filters are allowed.

5093

{ # Input only.

5094

#

5095

# Geographic region of the search.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5096

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This is used

5097

# to address ambiguity of the user-input location, for example, "Liverpool"

5098

# against "Liverpool, NY, US" or "Liverpool, UK".

5099

#

5100

# Set this field if all the jobs to search against are from a same region,

5101

# or jobs are world-wide, but the job seeker is from a specific region.

5102

#

5103

# See http://cldr.unicode.org/ and

5104

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5105

# for details. Example: "CH" for Switzerland.

5106

"address": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

5107

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

5108

# identified as a city or smaller. When the location being searched for is a

5109

# state or larger, this field is ignored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5110

"telecommutePreference": "A String", # Optional. Allows the client to return jobs without a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5111

# set location, specifically, telecommuting jobs (telecommuting is considered

5112

# by the service as a special location.

5113

# Job.posting_region indicates if a job permits telecommuting.

5114

# If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,

5115

# telecommuting jobs are searched, and address and lat_lng are

5116

# ignored. If not set or set to

5117

# TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not

5118

# searched.

5119

#

5120

# This filter can be used by itself to search exclusively for telecommuting

5121

# jobs, or it can be combined with another location

5122

# filter to search for a combination of job locations,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5123

# such as "Mountain View" or "telecommuting" jobs. However, when used in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5124

# combination with other location filters, telecommuting jobs can be

5125

# treated as less relevant than other jobs in the search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5126

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

5127

# search. This field's ignored if `address` is provided.

5128

# of doubles representing degrees latitude and degrees longitude. Unless

5129

# specified otherwise, this must conform to the

5130

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5131

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5132

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5133

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5134

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5135

},

5136

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5137

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for

5138

# example, driving or public transit). Note: This only works with COMMUTE

5139

# MODE. When specified, [JobQuery.location_filters] is

5140

# ignored.

5141

#

5142

# Currently we don't support sorting by commute time.

5143

#

5144

# Parameters needed for commute search.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5145

"travelDuration": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

5146

# (one hour). Format is `123s`.

5147

"startCoordinates": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

5148

# commute time.

5149

# of doubles representing degrees latitude and degrees longitude. Unless

5150

# specified otherwise, this must conform to the

5151

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5152

# standard</a>. Values must be within normalized ranges.

5153

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5154

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5155

},

5156

"commuteMethod": "A String", # Required. The method of transportation for which to calculate the commute time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5157

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

5158

"allowImpreciseAddresses": True or False, # Optional. If true, jobs without "precise" addresses (street level addresses or GPS

5159

# coordinates) might also be returned. For city and coarser level addresses,

5160

# text matching is used. If this field is set to false or is not specified,

5161

# only jobs that include precise addresses are returned by Commute

5162

# Search.

5163

#

5164

# Note: If `allow_imprecise_addresses` is set to true, Commute Search is not

5165

# able to calculate accurate commute times to jobs with city level and

5166

# coarser address information. Jobs with imprecise addresses will return a

5167

# `travel_duration` time of 0 regardless of distance from the job seeker.

5168

"departureTime": { # Represents a time of day. The date and time zone are either not significant # Optional. The departure time used to calculate traffic impact, represented as

5169

# google.type.TimeOfDay in local time zone.

5170

#

5171

# Currently traffic model is restricted to hour level resolution.

5172

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5173

# types are google.type.Date and `google.protobuf.Timestamp`.

5174

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5175

# to allow the value "24:00:00" for scenarios like business closing time.

5176

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5177

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5178

# allow the value 60 if it allows leap-seconds.

5179

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5180

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5181

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5182

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

5183

# for example, "en-US".

5184

#

5185

# 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".

5190

# For more information, see

5191

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

5192

#

5193

# At most 10 language code filters are allowed.

5194

"A String",

5195

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5196

"query": "A String", # Optional. The query string that matches against the job title, description, and

5197

# location fields.

5198

#

5199

# The maximum number of allowed characters is 255.

5200

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5201

# Job.compensation_info. For example, if the filter is specified

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5202

# as "Hourly job with per-hour compensation > $15", only jobs meeting

5203

# these criteria are searched. If a filter isn't defined, all open jobs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5204

# are searched.

5205

#

5206

# Filter on job compensation type and amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5207

"range": { # Compensation range. # Optional. Compensation range.

5208

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5209

# to a maximal compensation value and the currency code is set to

5210

# match the currency code of

5211

# min_compensation.

5212

"nanos": 42, # Number of nano (10^-9) units of the amount.

5213

# The value must be between -999,999,999 and +999,999,999 inclusive.

5214

# If `units` is positive, `nanos` must be positive or zero.

5215

# If `units` is zero, `nanos` can be positive, zero, or negative.

5216

# If `units` is negative, `nanos` must be negative or zero.

5217

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5218

"units": "A String", # The whole units of the amount.

5219

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5220

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5221

},

5222

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5223

# to zero and the currency code is set to match the

5224

# currency code of max_compensation.

5225

"nanos": 42, # Number of nano (10^-9) units of the amount.

5226

# The value must be between -999,999,999 and +999,999,999 inclusive.

5227

# If `units` is positive, `nanos` must be positive or zero.

5228

# If `units` is zero, `nanos` can be positive, zero, or negative.

5229

# If `units` is negative, `nanos` must be negative or zero.

5230

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5231

"units": "A String", # The whole units of the amount.

5232

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5233

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5234

},

5235

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5236

"type": "A String", # Required. Type of filter.

5237

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. If set to true, jobs with unspecified compensation range fields are

5238

# included.

5239

"units": [ # Required. Specify desired `base compensation entry's`

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5240

# CompensationInfo.CompensationUnit.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5241

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5242

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5243

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5244

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

5245

# service attempts to correct a misspelled query,

5246

# for example, "enginee" is corrected to "engineer".

5247

#

5248

# Defaults to false: a spell check is performed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5249

"companyDisplayNames": [ # Optional. This filter specifies the exact company display

5250

# name of the jobs to search against.

5251

#

5252

# If a value isn't specified, jobs within the search results are

5253

# associated with any company.

5254

#

5255

# If multiple values are specified, jobs within the search results may be

5256

# associated with any of the specified companies.

5257

#

5258

# At most 20 company display name filters are allowed.

5259

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5260

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5261

"jobCategories": [ # Optional. The category filter specifies the categories of jobs to search against.

5262

# See Category for more information.

5263

#

5264

# If a value is not specified, jobs from any category are searched against.

5265

#

5266

# If multiple values are specified, jobs from any of the specified

5267

# categories are searched against.

5268

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5269

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5270

"companyNames": [ # Optional. This filter specifies the company entities to search against.

5271

#

5272

# If a value isn't specified, jobs are searched for against all

5273

# companies.

5274

#

5275

# If multiple values are specified, jobs are searched against the

5276

# companies specified.

5277

#

5278

# The format is "projects/{project_id}/companies/{company_id}", for example,

5279

# "projects/api-test-project/companies/foo".

5280

#

5281

# At most 20 company filters are allowed.

5282

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5283

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5284

"queryLanguageCode": "A String", # The language code of query. For example, "en-US". This field helps to

5285

# better interpret the query.

5286

#

5287

# If a value isn't specified, the query language code is automatically

5288

# detected, which may not be accurate.

5289

#

5290

# Language code should be in BCP-47 format, such as "en-US" or "sr-Latn".

5291

# For more information, see

5292

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

5293

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

5294

# search against, such as EmploymentType.FULL_TIME.

5295

#

5296

# If a value is not specified, jobs in the search results includes any

5297

# employment type.

5298

#

5299

# If multiple values are specified, jobs in the search results include

5300

# any of the specified employment types.

5301

"A String",

5302

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5303

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5304

"jobView": "A String", # Optional. The desired job attributes returned for jobs in the

5305

# search response. Defaults to JobView.SMALL if no value is specified.

5306

"requirePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5307

# count of the first 300 results. Setting this to `true` ensures

5308

# consistency in the number of results per page. Best practice is to set this

5309

# value to true if a client allows users to jump directly to a

5310

# non-sequential search results page.

5311

#

5312

# Enabling this flag may adversely impact performance.

5313

#

5314

# Defaults to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5315

"pageToken": "A String", # Optional. The token specifying the current offset within

5316

# search results. See SearchJobsResponse.next_page_token for

5317

# an explanation of how to obtain the next set of query results.

5318

"diversificationLevel": "A String", # Optional. Controls whether highly similar jobs are returned next to each other in

5319

# the search results. Jobs are identified as highly similar based on

5320

# their titles, job categories, and locations. Highly similar results are

5321

# clustered so that only one representative job of the cluster is

5322

# displayed to the job seeker higher up in the results, with the other jobs

5323

# being displayed lower down in the results.

5324

#

5325

# Defaults to DiversificationLevel.SIMPLE if no value

5326

# is specified.

5327

"searchMode": "A String", # Optional. Mode of a search.

5328

#

5329

# Defaults to SearchMode.JOB_SEARCH.

5330

"requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the

5331

# search quality of the service. The identifiers (such as `user_id`) are

5332

# provided by users, and must be unique and consistent.

5333

#

5334

# Meta information related to the job searcher or entity

5335

# conducting the job search. This information is used to improve the

5336

# performance of the service.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5337

"deviceInfo": { # Device information collected from the job seeker, candidate, or # Optional. The type of device used by the job seeker at the time of the call to the

5338

# service.

5339

# other entity conducting the job search. Providing this information improves

5340

# the quality of the search results across devices.

5341

"deviceType": "A String", # Optional. Type of the device.

5342

"id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that

5343

# distinguishes the device from other devices.

5344

},

5345

"sessionId": "A String", # Required. A unique session identification string. A session is defined as the

5346

# duration of an end user's interaction with the service over a certain

5347

# period.

5348

# Obfuscate this field for privacy concerns before

5349

# providing it to the service.

5350

#

5351

# If this field is not available for some reason, send "UNKNOWN". Note

5352

# that any improvements to the model for a particular tenant

5353

# site, rely on this field being set correctly to some unique session_id.

5354

#

5355

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5356

"domain": "A String", # Required. The client-defined scope or source of the service call, which typically

5357

# is the domain on

5358

# which the service has been implemented and is currently being run.

5359

#

5360

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

5361

# job board www.foo.com and career site www.bar.com, then this field is

5362

# set to "foo.com" for use on the job board, and "bar.com" for use on the

5363

# career site.

5364

#

5365

# If this field isn't available for some reason, send "UNKNOWN".

5366

# Any improvements to the model for a particular tenant site rely on this

5367

# field being set correctly to a domain.

5368

#

5369

# The maximum number of allowed characters is 255.

5370

"userId": "A String", # Required. A unique user identification string, as determined by the client.

5371

# To have the strongest positive impact on search quality

5372

# make sure the client-level is unique.

5373

# Obfuscate this field for privacy concerns before

5374

# providing it to the service.

5375

#

5376

# If this field is not available for some reason, send "UNKNOWN". Note

5377

# that any improvements to the model for a particular tenant

5378

# site, rely on this field being set correctly to a unique user_id.

5379

#

5380

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5381

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5382

}

5383

5384

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# Response for SearchJob method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5395

"metadata": { # Output only. # Additional information for the API invocation, such as the request

5396

# tracking id.

5397

#

5398

# Additional information returned to client, such as debugging information.

5399

"requestId": "A String", # A unique id associated with this call.

5400

# This id is logged for tracking purposes.

5401

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5402

"histogramResults": { # Output only. # The histogram results that match specified

5403

# SearchJobsRequest.histogram_facets.

5404

#

5405

# Histogram results that match HistogramFacets specified in

5406

# SearchJobsRequest.

5407

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that match

5408

# HistogramFacets.compensation_histogram_requests.

5409

{ # Output only.

5410

#

5411

# Compensation based histogram result.

5412

"result": { # Output only. # Histogram result.

5413

#

5414

# Custom numeric bucketing result.

5415

"counts": [ # Count within each bucket. Its size is the length of

5416

# NumericBucketingOption.bucket_bounds plus 1.

5417

{ # Represents count of jobs within one bucket.

5418

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

5419

# that is, the count represents number of jobs in this range.

5420

"to": 3.14, # Ending value of the bucket range.

5421

"from": 3.14, # Starting value of the bucket range.

5422

},

5423

"count": 42, # Number of jobs whose numeric field value fall into `range`.

5424

},

5425

],

5426

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

5427

# [NumericBucketingOption.requires_min_max] is set to true.

5428

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

5429

# [NumericBucketingOption.requires_min_max] is set to true.

5430

},

5431

"type": "A String", # Type of the request, corresponding to

5432

# CompensationHistogramRequest.type.

5433

},

5434

],

5435

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that match

5436

# HistogramFacets.custom_attribute_histogram_facets.

5437

{ # Output only.

5438

#

5439

# Custom attribute histogram result.

5440

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

5441

# custom attribute long values associated with `key`.

5442

#

5443

# Custom numeric bucketing result.

5444

"counts": [ # Count within each bucket. Its size is the length of

5445

# NumericBucketingOption.bucket_bounds plus 1.

5446

{ # Represents count of jobs within one bucket.

5447

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

5448

# that is, the count represents number of jobs in this range.

5449

"to": 3.14, # Ending value of the bucket range.

5450

"from": 3.14, # Starting value of the bucket range.

5451

},

5452

"count": 42, # Number of jobs whose numeric field value fall into `range`.

5453

},

5454

],

5455

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

5456

# [NumericBucketingOption.requires_min_max] is set to true.

5457

"maxValue": 3.14, # Stores the maximum value of the numeric field. Is populated only if

5458

# [NumericBucketingOption.requires_min_max] is set to true.

5459

},

5460

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

5461

# with `key` to the number of jobs with that value in this histogram result.

5462

"a_key": 42,

5463

},

5464

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

5465

},

5466

],

5467

"simpleHistogramResults": [ # Specifies histogram results that matches

5468

# HistogramFacets.simple_histogram_facets.

5469

{ # Output only.

5470

#

5471

# Result of a histogram call. The response contains the histogram map for the

5472

# search type specified by HistogramResult.field.

5473

# The response is a map of each filter value to the corresponding count of

5474

# jobs for that filter.

5475

"values": { # A map from the values of field to the number of jobs with that value

5476

# in this search result.

5477

#

5478

# Key: search type (filter names, such as the companyName).

5479

#

5480

# Values: the count of jobs that match the filter for this search.

5481

"a_key": 42,

5482

},

5483

"searchType": "A String", # The Histogram search filters.

5484

},

5485

],

5486

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5487

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

5488

{ # Output only.

5489

#

5490

# Job entry with metadata inside SearchJobsResponse.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5491

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

5492

# or "job requisition"). A job belongs to a Company, which is the hiring

5493

# entity responsible for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5494

"name": "A String", # Required during job update.

5495

#

5496

# The resource name for the job. This is generated by the service when a

5497

# job is created.

5498

#

5499

# The format is "projects/{project_id}/jobs/{job_id}",

5500

# for example, "projects/api-test-project/jobs/1234".

5501

#

5502

# Use of this field in job queries and API calls is preferred over the use of

5503

# requisition_id since this value is unique.

5504

"jobBenefits": [ # Optional. The benefits included with the job.

5505

"A String",

5506

],

5507

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

5508

# The value determines the sort order of the jobs returned when searching for

5509

# jobs using the featured jobs search call, with higher promotional values

5510

# being returned first and ties being resolved by relevance sort. Only the

5511

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

5512

#

5513

# Default value is 0, and negative values are treated as 0.

5514

"title": "A String", # Required. The title of the job, such as "Software Engineer"

5515

#

5516

# The maximum number of allowed characters is 500.

5517

"companyDisplayName": "A String", # Output only. Display name of the company listing the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5518

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

5519

# job. The use of this field is recommended

5520

# as an alternative to using the more general description field.

5521

#

5522

# This field accepts and sanitizes HTML input, and also accepts

5523

# bold, italic, ordered list, and unordered list markup tags.

5524

#

5525

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5526

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

5527

# client to identify a job. This field is intended to be used by clients

5528

# for client identification and tracking of postings. A job is not allowed

5529

# to be created if there is another job with the same [company_name],

5530

# language_code and requisition_id.

5531

#

5532

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5533

"processingOptions": { # Input only. # Optional. Options for job processing.

5534

#

5535

# Options for job processing.

5536

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

5537

# more precise address for the job.

5538

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

5539

#

5540

# * description

5541

# * applicationInfo.instruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not

5547

# disabled.

5548

#

5549

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

5550

},

5551

"jobEndTime": "A String", # Optional. The end timestamp of the job. Typically this field is used for contracting

5552

# engagements. Invalid timestamps are ignored.

5553

"derivedInfo": { # Output only. # Output only. Derived details about the job posting.

5554

#

5555

# Derived details about the job posting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5556

"locations": [ # Structured locations of the job, resolved from Job.addresses.

5557

#

5558

# locations are exactly matched to Job.addresses in the same

# order.

{ # Output only.

#

# A resource that represents a location with full geographic information.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5563

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

5564

# location bounding box in which a circle with the specified radius

5565

# centered from LatLng covers the area associated with the job location.

5566

# For example, currently, "Mountain View, CA, USA" has a radius of

5567

# 6.17 miles.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5568

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

5569

# of doubles representing degrees latitude and degrees longitude. Unless

5570

# specified otherwise, this must conform to the

5571

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5572

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5573

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5574

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5575

},

5576

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

5577

# such as postal delivery and payments addresses. Given a postal address,

5578

# a postal service can deliver items to a premises, P.O. Box, or other

5579

# delivery location.

5580

# Given a postal address, a postal service can deliver items to a premise, P.O.

5581

# Box or similar.

5582

# It is not intended to model geographical locations (roads, towns,

5583

# mountains).

5584

#

5585

# In typical usage an address would be created via user input or from importing

5586

# existing data, depending on the type of process.

5587

#

5588

# Advice on address input / editing:

5589

# - Use an i18n-ready address widget such as

5590

# https://github.com/google/libaddressinput)

5591

# - Users should not be presented with UI elements for input or editing of

5592

# fields outside countries where that field is used.

5593

#

5594

# For more guidance on how to use this schema, please see:

5595

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5596

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

5597

# postal codes to be present, but where they are used, they may trigger

5598

# additional validation with other parts of the address (e.g. state/zip

5599

# validation in the U.S.A.).

5600

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

5601

# known). This is often the UI language of the input form or is expected

5602

# to match one of the languages used in the address' country/region, or their

5603

# transliterated equivalents.

5604

# This can affect formatting in certain countries, but is not critical

5605

# to the correctness of the data and will never affect any validation or

5606

# other non-formatting related operations.

5607

#

5608

# If this value is not known, it should be omitted (rather than specifying a

5609

# possibly incorrect default).

5610

#

5611

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

5612

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

5613

# in most regions. Where it is used, the value is either a string like

5614

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

5615

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

5616

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

5617

"recipients": [ # Optional. The recipient at the address.

5618

# This field may, under certain circumstances, contain multiline information.

5619

# For example, it might contain "care of" information.

5620

"A String",

5621

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5622

"sublocality": "A String", # Optional. Sublocality of the address.

5623

# For example, this can be neighborhoods, boroughs, districts.

5624

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

5625

# the latest revision.

5626

#

5627

# All new revisions **must** be backward compatible with old revisions.

5628

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

5629

# Examples: US city, IT comune, UK post town.

5630

# In regions of the world where localities are not well defined or do not fit

5631

# into this structure well, leave locality empty and use address_lines.

5632

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

5633

# addresses of a country or region.

5634

# For example, this can be a state, a province, an oblast, or a prefecture.

5635

# Specifically, for Spain this is the province and not the autonomous

5636

# community (e.g. "Barcelona" and not "Catalonia").

5637

# Many countries don't use an administrative area in postal addresses. E.g.

5638

# in Switzerland this should be left unpopulated.

5639

"organization": "A String", # Optional. The name of the organization at the address.

5640

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

5641

#

5642

# Because values in address_lines do not have type information and may

5643

# sometimes contain multiple values in a single field (e.g.

5644

# "Austin, TX"), it is important that the line order is clear. The order of

5645

# address lines should be "envelope order" for the country/region of the

5646

# address. In places where this can vary (e.g. Japan), address_language is

5647

# used to make it explicit (e.g. "ja" for large-to-small ordering and

5648

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

5649

# an address can be selected based on the language.

5650

#

5651

# The minimum permitted structural representation of an address consists

5652

# of a region_code with all remaining information placed in the

5653

# address_lines. It would be possible to format such an address very

5654

# approximately without geocoding, but no semantic reasoning could be

5655

# made about any of the address components until it was at least

5656

# partially resolved.

5657

#

5658

# Creating an address only containing a region_code and address_lines, and

5659

# then geocoding is the recommended way to handle completely unstructured

5660

# addresses (as opposed to guessing which parts of the address should be

5661

# localities or administrative areas).

5662

"A String",

5663

],

5664

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

5665

# is never inferred and it is up to the user to ensure the value is

5666

# correct. See http://cldr.unicode.org/ and

5667

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5668

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5669

},

5670

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

5671

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

5672

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

5673

# LocationType#LOCALITY.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5674

},

5675

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5676

"jobCategories": [ # Job categories derived from Job.title and Job.description.

5677

"A String",

5678

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5679

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5680

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

5681

# incentives associated with the job not including salary or pay.

5682

#

5683

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5684

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5689

"postingCreateTime": "A String", # Output only. The timestamp when this job posting was created.

5690

"addresses": [ # Optional but strongly recommended for the best service experience.

5691

#

5692

# Location(s) where the employer is looking to hire for this job posting.

5693

#

5694

# Specifying the full street address(es) of the hiring location enables

5695

# better API results, especially job searches by commute time.

5696

#

5697

# At most 50 locations are allowed for best search performance. If a job has

5698

# more locations, it is suggested to split it into multiple jobs with unique

5699

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

5700

# multiple jobs with the same company_name, language_code and

5701

# requisition_id are not allowed. If the original requisition_id must

5702

# be preserved, a custom field should be used for storage. It is also

5703

# suggested to group the locations that close to each other in the same job

5704

# for better search experience.

5705

#

5706

# The maximum number of allowed characters is 500.

5707

"A String",

5708

],

5709

"companyName": "A String", # Required. The resource name of the company listing the job, such as

5710

# "projects/api-test-project/companies/foo".

5711

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

5712

# description of the company and related information. Separate fields are

5713

# provided on the job object for responsibilities,

5714

# qualifications, and other job characteristics. Use of

5715

# these separate job fields is recommended.

5716

#

5717

# This field accepts and sanitizes HTML input, and also accepts

5718

# bold, italic, ordered list, and unordered list markup tags.

5719

#

5720

# The maximum number of allowed characters is 100,000.

5721

"jobStartTime": "A String", # Optional. The start timestamp of the job in UTC time zone. Typically this field

5722

# is used for contracting engagements. Invalid timestamps are ignored.

5723

"degreeTypes": [ # Optional. The desired education degrees for the job, such as Bachelors, Masters.

5724

"A String",

5725

],

5726

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5727

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

5728

# all compensation entries' CompensationEntry.compensation times

5729

# CompensationEntry.expected_units_per_year.

5730

#

5731

# See CompensationEntry for explanation on compensation annualization.

5732

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5733

# to a maximal compensation value and the currency code is set to

5734

# match the currency code of

5735

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5736

"nanos": 42, # Number of nano (10^-9) units of the amount.

5737

# The value must be between -999,999,999 and +999,999,999 inclusive.

5738

# If `units` is positive, `nanos` must be positive or zero.

5739

# If `units` is zero, `nanos` can be positive, zero, or negative.

5740

# If `units` is negative, `nanos` must be negative or zero.

5741

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5742

"units": "A String", # The whole units of the amount.

5743

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5744

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5745

},

5746

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5747

# to zero and the currency code is set to match the

5748

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5749

"nanos": 42, # Number of nano (10^-9) units of the amount.

5750

# The value must be between -999,999,999 and +999,999,999 inclusive.

5751

# If `units` is positive, `nanos` must be positive or zero.

5752

# If `units` is zero, `nanos` can be positive, zero, or negative.

5753

# If `units` is negative, `nanos` must be negative or zero.

5754

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5755

"units": "A String", # The whole units of the amount.

5756

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5757

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5758

},

5759

},

5760

"entries": [ # Optional. Job compensation information.

5761

#

5762

# At most one entry can be of type

5763

# CompensationInfo.CompensationType.BASE, which is

5764

# referred as ** base compensation entry ** for the job.

5765

{ # A compensation entry that represents one component of compensation, such

5766

# as base pay, bonus, or other compensation type.

5767

#

5768

# Annualization: One compensation entry can be annualized if

5769

# - it contains valid amount or range.

5770

# - and its expected_units_per_year is set or can be derived.

5771

# Its annualized range is determined as (amount or range) times

5772

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5773

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5774

"nanos": 42, # Number of nano (10^-9) units of the amount.

5775

# The value must be between -999,999,999 and +999,999,999 inclusive.

5776

# If `units` is positive, `nanos` must be positive or zero.

5777

# If `units` is zero, `nanos` can be positive, zero, or negative.

5778

# If `units` is negative, `nanos` must be negative or zero.

5779

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5780

"units": "A String", # The whole units of the amount.

5781

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5782

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5783

},

5784

"type": "A String", # Optional. Compensation type.

5785

#

5786

# Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.

5787

"range": { # Compensation range. # Optional. Compensation range.

5788

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5789

# to a maximal compensation value and the currency code is set to

5790

# match the currency code of

5791

# min_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5792

"nanos": 42, # Number of nano (10^-9) units of the amount.

5793

# The value must be between -999,999,999 and +999,999,999 inclusive.

5794

# If `units` is positive, `nanos` must be positive or zero.

5795

# If `units` is zero, `nanos` can be positive, zero, or negative.

5796

# If `units` is negative, `nanos` must be negative or zero.

5797

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5798

"units": "A String", # The whole units of the amount.

5799

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5800

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5801

},

5802

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5803

# to zero and the currency code is set to match the

5804

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5805

"nanos": 42, # Number of nano (10^-9) units of the amount.

5806

# The value must be between -999,999,999 and +999,999,999 inclusive.

5807

# If `units` is positive, `nanos` must be positive or zero.

5808

# If `units` is zero, `nanos` can be positive, zero, or negative.

5809

# If `units` is negative, `nanos` must be negative or zero.

5810

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5811

"units": "A String", # The whole units of the amount.

5812

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5813

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5814

},

5815

},

5816

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

5817

# Job.employment_types is FULLTIME, a default value is inferred

5818

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"description": "A String", # Optional. Compensation description. For example, could

5825

# indicate equity terms or provide additional context to an estimated

5826

# bonus.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5827

"unit": "A String", # Optional. Frequency of the specified amount.

5828

#

5829

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5830

},

5831

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5832

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

5833

# base compensation entry's CompensationEntry.compensation times

5834

# CompensationEntry.expected_units_per_year.

5835

#

5836

# See CompensationEntry for explanation on compensation annualization.

5837

"maxCompensation": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5838

# to a maximal compensation value and the currency code is set to

5839

# match the currency code of

5840

# min_compensation.

5841

"nanos": 42, # Number of nano (10^-9) units of the amount.

5842

# The value must be between -999,999,999 and +999,999,999 inclusive.

5843

# If `units` is positive, `nanos` must be positive or zero.

5844

# If `units` is zero, `nanos` can be positive, zero, or negative.

5845

# If `units` is negative, `nanos` must be negative or zero.

5846

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5847

"units": "A String", # The whole units of the amount.

5848

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5849

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5850

},

5851

"minCompensation": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5852

# to zero and the currency code is set to match the

5853

# currency code of max_compensation.

5854

"nanos": 42, # Number of nano (10^-9) units of the amount.

5855

# The value must be between -999,999,999 and +999,999,999 inclusive.

5856

# If `units` is positive, `nanos` must be positive or zero.

5857

# If `units` is zero, `nanos` can be positive, zero, or negative.

5858

# If `units` is negative, `nanos` must be negative or zero.

5859

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5860

"units": "A String", # The whole units of the amount.

5861

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5862

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5863

},

5864

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5865

},

5866

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

5867

# recommended as an alternative to using the more general description

5868

# field.

5869

#

5870

# This field accepts and sanitizes HTML input, and also accepts

5871

# bold, italic, ordered list, and unordered list markup tags.

5872

#

5873

# The maximum number of allowed characters is 10,000.

5874

"department": "A String", # Optional. The department or functional area within the company with the open

5875

# position.

5876

#

5877

# The maximum number of allowed characters is 255.

5878

"applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified.

5879

#

5880

# Job application information.

5881

"uris": [ # Optional but at least one of uris,

5882

# emails or instruction must be

5883

# specified.

5884

#

5885

# Use this URI field to direct an applicant to a website, for example to

5886

# link to an online application form.

5887

#

5888

# The maximum number of allowed characters for each entry is 2,000.

5889

"A String",

5890

],

5891

"emails": [ # Optional but at least one of uris,

5892

# emails or instruction must be

5893

# specified.

5894

#

5895

# Use this field to specify email address(es) to which resumes or

5896

# applications can be sent.

5897

#

5898

# The maximum number of allowed characters for each entry is 255.

5899

"A String",

5900

],

5901

"instruction": "A String", # Optional but at least one of uris,

5902

# emails or instruction must be

5903

# specified.

5904

#

5905

# Use this field to provide instructions, such as "Mail your application

5906

# to ...", that a candidate can follow to apply for the job.

5907

#

5908

# This field accepts and sanitizes HTML input, and also accepts

5909

# bold, italic, ordered list, and unordered list markup tags.

5910

#

5911

# The maximum number of allowed characters is 3,000.

5912

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5913

"postingRegion": "A String", # Optional. The job PostingRegion (for example, state, country) throughout which

5914

# the job is available. If this field is set, a

5915

# LocationFilter in a search query within the job region

5916

# finds this job posting if an exact location match isn't specified.

5917

# If this field is set to PostingRegion.NATION or

5918

# PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses

5919

# to the same location level as this field is strongly recommended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5920

"postingExpireTime": "A String", # Optional but strongly recommended for the best service

5921

# experience.

5922

#

5923

# The expiration timestamp of the job. After this timestamp, the

5924

# job is marked as expired, and it no longer appears in search results. The

5925

# expired job can't be deleted or listed by the DeleteJob and

5926

# ListJobs APIs, but it can be retrieved with the GetJob API or

5927

# updated with the UpdateJob API. An expired job can be updated and

5928

# opened again by using a future expiration timestamp. Updating an expired

5929

# job fails if there is another existing open job with same company_name,

5930

# language_code and requisition_id.

5931

#

5932

# The expired jobs are retained in our system for 90 days. However, the

5933

# overall expired job count cannot exceed 3 times the maximum of open jobs

5934

# count over the past week, otherwise jobs with earlier expire time are

5935

# cleaned first. Expired jobs are no longer accessible after they are cleaned

5936

# out.

5937

#

5938

# Invalid timestamps are ignored, and treated as expire time not provided.

5939

#

5940

# Timestamp before the instant request is made is considered valid, the job

5941

# will be treated as expired immediately.

5942

#

5943

# If this value is not provided at the time of job creation or is invalid,

5944

# the job posting expires after 30 days from the job's creation time. For

5945

# example, if the job was created on 2017/01/01 13:00AM UTC with an

5946

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

5947

#

5948

# If this value is not provided on job update, it depends on the field masks

5949

# set by UpdateJobRequest.update_mask. If the field masks include

5950

# expiry_time, or the masks are empty meaning that every field is

5951

# updated, the job posting expires after 30 days from the job's last

5952

# update time. Otherwise the expiration date isn't updated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5953

"postingPublishTime": "A String", # Optional. The timestamp this job posting was most recently published. The default

5954

# value is the time the request arrives at the server. Invalid timestamps are

5955

# ignored.

5956

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

5957

# attributes that are not covered by the provided structured fields.

5958

#

5959

# The keys of the map are strings up to 64 bytes and must match the

5960

# pattern: a-zA-Z*. For example, key0LikeThis or

5961

# KEY_1_LIKE_THIS.

5962

#

5963

# At most 100 filterable and at most 100 unfilterable keys are supported.

5964

# For filterable `string_values`, across all keys at most 200 values are

5965

# allowed, with each string no more than 255 characters. For unfilterable

5966

# `string_values`, the maximum total size of `string_values` across all keys

5967

# is 50KB.

5968

"a_key": { # Custom attribute values that are either filterable or non-filterable.

5969

"stringValues": [ # Optional but exactly one of string_values or long_values must

5970

# be specified.

5971

#

5972

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

5973

# `CASE_INSENSITIVE_MATCH`) search.

5974

# For filterable `string_value`s, a maximum total number of 200 values

5975

# is allowed, with each `string_value` has a byte size of no more than

5976

# 500B. For unfilterable `string_values`, the maximum total byte size of

5977

# unfilterable `string_values` is 50KB.

5978

#

5979

# Empty string is not allowed.

5980

"A String",

5981

],

5982

"filterable": True or False, # Optional. If the `filterable` flag is true, the custom field values may be used for

5983

# custom attribute filters JobQuery.custom_attribute_filter.

5984

# If false, these values may not be used for custom attribute filters.

5985

#

5986

# Default is false.

5987

"longValues": [ # Optional but exactly one of string_values or long_values must

5988

# be specified.

5989

#

5990

# This field is used to perform number range search.

5991

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.

5992

#

5993

# Currently at most 1 long_values is supported.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5998

"jobLevel": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

5999

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

6000

# any requirements for fluency that are associated with the job.

6001

#

6002

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

6003

# For more information, see

6004

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

6005

# class="external" target="_blank" }.

6006

#

6007

# If this field is unspecified and Job.description is present, detected

6008

# language code based on Job.description is assigned, otherwise

6009

# defaults to 'en_US'.

6010

"visibility": "A String", # Deprecated. The job is only visible to the owner.

6011

#

6012

# The visibility of the job.

6013

#

6014

# Defaults to Visibility.ACCOUNT_ONLY if not specified.

6015

"postingUpdateTime": "A String", # Output only. The timestamp when this job posting was last updated.

6016

},

6017

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

6018

# fields that most closely match a search query's keywords, if available.

6019

# All HTML tags in the original fields are stripped when returned in this

6020

# field, and matching query keywords are enclosed in HTML bold tags.

6021

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

6022

# closely matching a search query's keywords, if available. The matching

6023

# query keywords are enclosed in HTML bold tags.

6024

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

6025

# results listing page.

6026

"commuteInfo": { # Output only. # Commute information which is generated based on specified

6027

# CommuteFilter.

6028

#

6029

# Commute details related to this job.

6030

"travelDuration": "A String", # The number of seconds required to travel to the job location from the

6031

# query location. A duration of 0 seconds indicates that the job is not

6032

# reachable within the requested duration, but was returned as part of an

6033

# expanded query.

6034

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

6035

#

6036

# A resource that represents a location with full geographic information.

6037

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

6038

# location bounding box in which a circle with the specified radius

6039

# centered from LatLng covers the area associated with the job location.

6040

# For example, currently, "Mountain View, CA, USA" has a radius of

6041

# 6.17 miles.

6042

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

6043

# of doubles representing degrees latitude and degrees longitude. Unless

6044

# specified otherwise, this must conform to the

6045

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6046

# standard</a>. Values must be within normalized ranges.

6047

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6048

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6049

},

6050

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

6051

# such as postal delivery and payments addresses. Given a postal address,

6052

# a postal service can deliver items to a premises, P.O. Box, or other

6053

# delivery location.

6054

# Given a postal address, a postal service can deliver items to a premise, P.O.

6055

# Box or similar.

6056

# It is not intended to model geographical locations (roads, towns,

6057

# mountains).

6058

#

6059

# In typical usage an address would be created via user input or from importing

6060

# existing data, depending on the type of process.

6061

#

6062

# Advice on address input / editing:

6063

# - Use an i18n-ready address widget such as

6064

# https://github.com/google/libaddressinput)

6065

# - Users should not be presented with UI elements for input or editing of

6066

# fields outside countries where that field is used.

6067

#

6068

# For more guidance on how to use this schema, please see:

6069

# https://support.google.com/business/answer/6397478

6070

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

6071

# postal codes to be present, but where they are used, they may trigger

6072

# additional validation with other parts of the address (e.g. state/zip

6073

# validation in the U.S.A.).

6074

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

6075

# known). This is often the UI language of the input form or is expected

6076

# to match one of the languages used in the address' country/region, or their

6077

# transliterated equivalents.

6078

# This can affect formatting in certain countries, but is not critical

6079

# to the correctness of the data and will never affect any validation or

6080

# other non-formatting related operations.

6081

#

6082

# If this value is not known, it should be omitted (rather than specifying a

6083

# possibly incorrect default).

6084

#

6085

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

6086

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

6087

# in most regions. Where it is used, the value is either a string like

6088

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

6089

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

6090

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

6091

"recipients": [ # Optional. The recipient at the address.

6092

# This field may, under certain circumstances, contain multiline information.

6093

# For example, it might contain "care of" information.

6094

"A String",

6095

],

6096

"sublocality": "A String", # Optional. Sublocality of the address.

6097

# For example, this can be neighborhoods, boroughs, districts.

6098

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

6099

# the latest revision.

6100

#

6101

# All new revisions **must** be backward compatible with old revisions.

6102

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

6103

# Examples: US city, IT comune, UK post town.

6104

# In regions of the world where localities are not well defined or do not fit

6105

# into this structure well, leave locality empty and use address_lines.

6106

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

6107

# addresses of a country or region.

6108

# For example, this can be a state, a province, an oblast, or a prefecture.

6109

# Specifically, for Spain this is the province and not the autonomous

6110

# community (e.g. "Barcelona" and not "Catalonia").

6111

# Many countries don't use an administrative area in postal addresses. E.g.

6112

# in Switzerland this should be left unpopulated.

6113

"organization": "A String", # Optional. The name of the organization at the address.

6114

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

6115

#

6116

# Because values in address_lines do not have type information and may

6117

# sometimes contain multiple values in a single field (e.g.

6118

# "Austin, TX"), it is important that the line order is clear. The order of

6119

# address lines should be "envelope order" for the country/region of the

6120

# address. In places where this can vary (e.g. Japan), address_language is

6121

# used to make it explicit (e.g. "ja" for large-to-small ordering and

6122

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

6123

# an address can be selected based on the language.

6124

#

6125

# The minimum permitted structural representation of an address consists

6126

# of a region_code with all remaining information placed in the

6127

# address_lines. It would be possible to format such an address very

6128

# approximately without geocoding, but no semantic reasoning could be

6129

# made about any of the address components until it was at least

6130

# partially resolved.

6131

#

6132

# Creating an address only containing a region_code and address_lines, and

6133

# then geocoding is the recommended way to handle completely unstructured

6134

# addresses (as opposed to guessing which parts of the address should be

6135

# localities or administrative areas).

6136

"A String",

6137

],

6138

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

6139

# is never inferred and it is up to the user to ensure the value is

6140

# correct. See http://cldr.unicode.org/ and

6141

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6142

# for details. Example: "CH" for Switzerland.

6143

},

6144

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

6145

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

6146

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

6147

# LocationType#LOCALITY.

6148

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

6153

# This field is empty if there are no more results.

6154

"spellCorrection": { # Output only. # The spell checking result, and correction.

6155

#

6156

# Spell check result.

6157

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

6158

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

6159

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6160

"broadenedQueryJobsCount": 42, # If query broadening is enabled, we may append additional results from the

6161

# broadened query. This number indicates how many of the jobs returned in the

6162

# jobs field are from the broadened query. These results are always at the

6163

# end of the jobs list. In particular, a value of 0, or if the field isn't

6164

# set, all the jobs in the jobs list are from the original

6165

# (without broadening) query. If this field is non-zero, subsequent requests

6166

# with offset after this result set should contain all broadened results.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6167

"estimatedTotalSize": 42, # An estimation of the number of jobs that match the specified query.

6168

#

6169

# This number is not guaranteed to be accurate. For accurate results,

6170

# see enable_precise_result_size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6171

"totalSize": 42, # The precise result count, which is available only if the client set

6172

# enable_precise_result_size to `true`, or if the response

6173

# is the last page of results. Otherwise, the value is `-1`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6174

"locationFilters": [ # The location filters that the service applied to the specified query. If

6175

# any filters are lat-lng based, the JobLocation.location_type is

6176

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

6177

{ # Output only.

6178

#

6179

# A resource that represents a location with full geographic information.

6180

"radiusInMiles": 3.14, # Radius in miles of the job location. This value is derived from the

6181

# location bounding box in which a circle with the specified radius

6182

# centered from LatLng covers the area associated with the job location.

6183

# For example, currently, "Mountain View, CA, USA" has a radius of

6184

# 6.17 miles.

6185

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

6186

# of doubles representing degrees latitude and degrees longitude. Unless

6187

# specified otherwise, this must conform to the

6188

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6189

# standard</a>. Values must be within normalized ranges.

6190

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6191

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6192

},

6193

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

6194

# such as postal delivery and payments addresses. Given a postal address,

6195

# a postal service can deliver items to a premises, P.O. Box, or other

6196

# delivery location.

6197

# Given a postal address, a postal service can deliver items to a premise, P.O.

6198

# Box or similar.

6199

# It is not intended to model geographical locations (roads, towns,

6200

# mountains).

6201

#

6202

# In typical usage an address would be created via user input or from importing

6203

# existing data, depending on the type of process.

6204

#

6205

# Advice on address input / editing:

6206

# - Use an i18n-ready address widget such as

6207

# https://github.com/google/libaddressinput)

6208

# - Users should not be presented with UI elements for input or editing of

6209

# fields outside countries where that field is used.

6210

#

6211

# For more guidance on how to use this schema, please see:

6212

# https://support.google.com/business/answer/6397478

6213

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

6214

# postal codes to be present, but where they are used, they may trigger

6215

# additional validation with other parts of the address (e.g. state/zip

6216

# validation in the U.S.A.).

6217

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

6218

# known). This is often the UI language of the input form or is expected

6219

# to match one of the languages used in the address' country/region, or their

6220

# transliterated equivalents.

6221

# This can affect formatting in certain countries, but is not critical

6222

# to the correctness of the data and will never affect any validation or

6223

# other non-formatting related operations.

6224

#

6225

# If this value is not known, it should be omitted (rather than specifying a

6226

# possibly incorrect default).

6227

#

6228

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

6229

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

6230

# in most regions. Where it is used, the value is either a string like

6231

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

6232

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

6233

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

6234

"recipients": [ # Optional. The recipient at the address.

6235

# This field may, under certain circumstances, contain multiline information.

6236

# For example, it might contain "care of" information.

6237

"A String",

6238

],

6239

"sublocality": "A String", # Optional. Sublocality of the address.

6240

# For example, this can be neighborhoods, boroughs, districts.

6241

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

6242

# the latest revision.

6243

#

6244

# All new revisions **must** be backward compatible with old revisions.

6245

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

6246

# Examples: US city, IT comune, UK post town.

6247

# In regions of the world where localities are not well defined or do not fit

6248

# into this structure well, leave locality empty and use address_lines.

6249

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

6250

# addresses of a country or region.

6251

# For example, this can be a state, a province, an oblast, or a prefecture.

6252

# Specifically, for Spain this is the province and not the autonomous

6253

# community (e.g. "Barcelona" and not "Catalonia").

6254

# Many countries don't use an administrative area in postal addresses. E.g.

6255

# in Switzerland this should be left unpopulated.

6256

"organization": "A String", # Optional. The name of the organization at the address.

6257

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

6258

#

6259

# Because values in address_lines do not have type information and may

6260

# sometimes contain multiple values in a single field (e.g.

6261

# "Austin, TX"), it is important that the line order is clear. The order of

6262

# address lines should be "envelope order" for the country/region of the

6263

# address. In places where this can vary (e.g. Japan), address_language is

6264

# used to make it explicit (e.g. "ja" for large-to-small ordering and

6265

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

6266

# an address can be selected based on the language.

6267

#

6268

# The minimum permitted structural representation of an address consists

6269

# of a region_code with all remaining information placed in the

6270

# address_lines. It would be possible to format such an address very

6271

# approximately without geocoding, but no semantic reasoning could be

6272

# made about any of the address components until it was at least

6273

# partially resolved.

6274

#

6275

# Creating an address only containing a region_code and address_lines, and

6276

# then geocoding is the recommended way to handle completely unstructured

6277

# addresses (as opposed to guessing which parts of the address should be

6278

# localities or administrative areas).

6279

"A String",

6280

],

6281

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

6282

# is never inferred and it is up to the user to ensure the value is

6283

# correct. See http://cldr.unicode.org/ and

6284

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6285

# for details. Example: "CH" for Switzerland.

6286

},

6287

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

6288

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

6289

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

6290

# LocationType#LOCALITY.

6291

},

6292

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code>

6298

<pre>Retrieves the next page of results.

6299

6300

Args:

6301

previous_request: The request for the previous page. (required)

6302

previous_response: The response from the request for the previous page. (required)

6303

6304

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6305

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6306

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="search_next">search_next(previous_request, previous_response)</code>

6312

<pre>Retrieves the next page of results.

6313

6314

Args:

6315

previous_request: The request for the previous page. (required)

6316

previous_response: The response from the request for the previous page. (required)

6317

6318

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6319

A request object that you can call 'execute()' on to request the next

Bu Sun Kim