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

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

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

<p class="firstline">Deletes specified company.</p>

83

84

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

85

<p class="firstline">Retrieves specified company.</p>

86

87

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

88

<p class="firstline">Lists all companies associated with the service account.</p>

89

90

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

91

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

92

93

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

94

<p class="firstline">Updates specified company. Company names can't be updated. To update a</p>

95

<h3>Method Details</h3>

96

97

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

98

<pre>Creates a new company entity.

99

100

Args:

101

parent: string, Required.

102

103

Resource name of the project under which the company is created.

104

105

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

106

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

107

body: object, The request body. (required)

108

The object takes the form of:

{ # Input only.

#

# The Request of the CreateCompany method.

113

"company": { # A Company resource represents a company in the service. A company is the # Required.

114

#

115

# The company to be created.

116

# entity that owns job postings, that is, the hiring entity responsible for

117

# employing applicants for the job position.

118

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

119

#

120

# The display name of the company, for example, "Google, LLC".

121

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

122

#

123

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

124

# company is created.

125

#

126

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

127

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

128

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

129

#

130

# The URI to employer's career site or careers page on the employer's web

131

# site, for example, "https://careers.google.com".

132

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

133

#

134

# The street address of the company's main headquarters, which may be

135

# different from the job location. The service attempts

136

# to geolocate the provided address, and populates a more specific

137

# location wherever possible in DerivedInfo.headquarters_location.

138

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

139

#

140

# Equal Employment Opportunity legal disclaimer text to be

141

# associated with all jobs, and typically to be displayed in all

142

# roles.

143

#

144

# The maximum number of allowed characters is 500.

145

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

146

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

147

# Company.hq_location if provided.

148

#

149

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

150

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

151

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

152

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

153

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

154

# 6.17 miles.

155

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

156

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

157

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

158

# LocationType#LOCALITY.

159

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

160

# of doubles representing degrees latitude and degrees longitude. Unless

161

# specified otherwise, this must conform to the

162

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

163

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

164

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

165

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

166

},

167

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

168

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

169

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

170

# delivery location.

171

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

172

# Box or similar.

173

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

174

# mountains).

175

#

176

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

177

# existing data, depending on the type of process.

178

#

179

# Advice on address input / editing:

180

# - Use an i18n-ready address widget such as

181

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

182

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

183

# fields outside countries where that field is used.

184

#

185

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

186

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

187

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

188

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

189

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

190

# transliterated equivalents.

191

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

192

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

193

# other non-formatting related operations.

194

#

195

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

196

# possibly incorrect default).

197

#

198

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

199

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

200

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

201

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

202

"A String",

203

],

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

# addresses of a country or region.

220

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

221

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

222

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

223

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

224

# in Switzerland this should be left unpopulated.

225

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

226

#

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

# an address can be selected based on the language.

235

#

236

# The minimum permitted structural representation of an address consists

237

# of a region_code with all remaining information placed in the

238

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

239

# approximately without geocoding, but no semantic reasoning could be

240

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

241

# partially resolved.

242

#

243

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

244

# then geocoding is the recommended way to handle completely unstructured

245

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

246

# localities or administrative areas).

247

"A String",

248

],

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

# the latest revision.

258

#

259

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

},

},

},

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

264

#

265

# A URI that hosts the employer's company logo.

266

"keywordSearchableJobCustomAttributes": [ # Optional.

267

#

268

# A list of keys of filterable Job.custom_attributes, whose

269

# corresponding `string_values` are used in keyword search. Jobs with

270

# `string_values` under these specified field keys are returned if any

271

# of the values matches the search keyword. Custom field values with

272

# parenthesis, brackets and special symbols won't be properly searchable,

273

# and those keyword queries need to be surrounded by quotes.

274

"A String",

275

],

276

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

277

#

278

# Client side company identifier, used to uniquely identify the

279

# company.

280

#

281

# The maximum number of allowed characters is 255.

282

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

283

#

284

# The URI representing the company's primary web site or home page,

285

# for example, "https://www.google.com".

286

#

287

# The maximum number of allowed characters is 255.

288

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from

289

# public availability by the service when job content appears suspicious,

290

# abusive, or spammy.

291

"hiringAgency": True or False, # Optional.

292

#

293

# Set to true if it is the hiring agency that post jobs for other

294

# employers.

295

#

296

# Defaults to false if not provided.

297

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

298

#

299

# The employer's company size.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

310

311

{ # A Company resource represents a company in the service. A company is the

312

# entity that owns job postings, that is, the hiring entity responsible for

313

# employing applicants for the job position.

314

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

315

#

316

# The display name of the company, for example, "Google, LLC".

317

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

318

#

319

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

320

# company is created.

321

#

322

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

323

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

324

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

325

#

326

# The URI to employer's career site or careers page on the employer's web

327

# site, for example, "https://careers.google.com".

328

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

329

#

330

# The street address of the company's main headquarters, which may be

331

# different from the job location. The service attempts

332

# to geolocate the provided address, and populates a more specific

333

# location wherever possible in DerivedInfo.headquarters_location.

334

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

335

#

336

# Equal Employment Opportunity legal disclaimer text to be

337

# associated with all jobs, and typically to be displayed in all

338

# roles.

339

#

340

# The maximum number of allowed characters is 500.

341

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

342

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

343

# Company.hq_location if provided.

344

#

345

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

346

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

347

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

348

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

349

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

350

# 6.17 miles.

351

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

352

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

353

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

354

# LocationType#LOCALITY.

355

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

356

# of doubles representing degrees latitude and degrees longitude. Unless

357

# specified otherwise, this must conform to the

358

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

359

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

360

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

361

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

362

},

363

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

364

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

365

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

366

# delivery location.

367

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

368

# Box or similar.

369

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

370

# mountains).

371

#

372

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

373

# existing data, depending on the type of process.

374

#

375

# Advice on address input / editing:

376

# - Use an i18n-ready address widget such as

377

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

378

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

379

# fields outside countries where that field is used.

380

#

381

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

382

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

383

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

384

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

385

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

386

# transliterated equivalents.

387

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

388

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

389

# other non-formatting related operations.

390

#

391

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

392

# possibly incorrect default).

393

#

394

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

395

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

396

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

397

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

398

"A String",

399

],

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

# addresses of a country or region.

416

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

417

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

418

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

419

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

420

# in Switzerland this should be left unpopulated.

421

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

422

#

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

# an address can be selected based on the language.

431

#

432

# The minimum permitted structural representation of an address consists

433

# of a region_code with all remaining information placed in the

434

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

435

# approximately without geocoding, but no semantic reasoning could be

436

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

437

# partially resolved.

438

#

439

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

440

# then geocoding is the recommended way to handle completely unstructured

441

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

442

# localities or administrative areas).

443

"A String",

444

],

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

# the latest revision.

454

#

455

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

},

},

},

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

460

#

461

# A URI that hosts the employer's company logo.

462

"keywordSearchableJobCustomAttributes": [ # Optional.

463

#

464

# A list of keys of filterable Job.custom_attributes, whose

465

# corresponding `string_values` are used in keyword search. Jobs with

466

# `string_values` under these specified field keys are returned if any

467

# of the values matches the search keyword. Custom field values with

468

# parenthesis, brackets and special symbols won't be properly searchable,

469

# and those keyword queries need to be surrounded by quotes.

470

"A String",

471

],

472

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

473

#

474

# Client side company identifier, used to uniquely identify the

475

# company.

476

#

477

# The maximum number of allowed characters is 255.

478

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

479

#

480

# The URI representing the company's primary web site or home page,

481

# for example, "https://www.google.com".

482

#

483

# The maximum number of allowed characters is 255.

484

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from

485

# public availability by the service when job content appears suspicious,

486

# abusive, or spammy.

487

"hiringAgency": True or False, # Optional.

488

#

489

# Set to true if it is the hiring agency that post jobs for other

490

# employers.

491

#

492

# Defaults to false if not provided.

493

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

494

#

495

# The employer's company size.

}</pre>

</div>

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

501

<pre>Deletes specified company.

502

Prerequisite: The company has no jobs associated with it.

Args:

The resource name of the company to be deleted.

508

509

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

510

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

511

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

518

519

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

520

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

521

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

522

#

523

# service Foo {

524

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

525

# }

526

#

527

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

}</pre>

</div>

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

533

<pre>Retrieves specified company.

Args:

The resource name of the company to be retrieved.

539

540

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

541

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

542

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

549

550

{ # A Company resource represents a company in the service. A company is the

551

# entity that owns job postings, that is, the hiring entity responsible for

552

# employing applicants for the job position.

553

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

554

#

555

# The display name of the company, for example, "Google, LLC".

556

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

557

#

558

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

559

# company is created.

560

#

561

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

562

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

563

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

564

#

565

# The URI to employer's career site or careers page on the employer's web

566

# site, for example, "https://careers.google.com".

567

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

568

#

569

# The street address of the company's main headquarters, which may be

570

# different from the job location. The service attempts

571

# to geolocate the provided address, and populates a more specific

572

# location wherever possible in DerivedInfo.headquarters_location.

573

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

574

#

575

# Equal Employment Opportunity legal disclaimer text to be

576

# associated with all jobs, and typically to be displayed in all

577

# roles.

578

#

579

# The maximum number of allowed characters is 500.

580

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

581

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

582

# Company.hq_location if provided.

583

#

584

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

585

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

586

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

587

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

588

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

589

# 6.17 miles.

590

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

591

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

592

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

593

# LocationType#LOCALITY.

594

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

595

# of doubles representing degrees latitude and degrees longitude. Unless

596

# specified otherwise, this must conform to the

597

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

598

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

599

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

600

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

601

},

602

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

603

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

604

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

605

# delivery location.

606

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

607

# Box or similar.

608

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

609

# mountains).

610

#

611

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

612

# existing data, depending on the type of process.

613

#

614

# Advice on address input / editing:

615

# - Use an i18n-ready address widget such as

616

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

617

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

618

# fields outside countries where that field is used.

619

#

620

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

621

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

622

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

623

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

624

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

625

# transliterated equivalents.

626

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

627

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

628

# other non-formatting related operations.

629

#

630

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

631

# possibly incorrect default).

632

#

633

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

634

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

635

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

636

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

637

"A String",

638

],

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

# addresses of a country or region.

655

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

656

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

657

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

658

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

659

# in Switzerland this should be left unpopulated.

660

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

661

#

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

# an address can be selected based on the language.

670

#

671

# The minimum permitted structural representation of an address consists

672

# of a region_code with all remaining information placed in the

673

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

674

# approximately without geocoding, but no semantic reasoning could be

675

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

676

# partially resolved.

677

#

678

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

679

# then geocoding is the recommended way to handle completely unstructured

680

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

681

# localities or administrative areas).

682

"A String",

683

],

684

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

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

# the latest revision.

693

#

694

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

},

},

},

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

699

#

700

# A URI that hosts the employer's company logo.

701

"keywordSearchableJobCustomAttributes": [ # Optional.

702

#

703

# A list of keys of filterable Job.custom_attributes, whose

704

# corresponding `string_values` are used in keyword search. Jobs with

705

# `string_values` under these specified field keys are returned if any

706

# of the values matches the search keyword. Custom field values with

707

# parenthesis, brackets and special symbols won't be properly searchable,

708

# and those keyword queries need to be surrounded by quotes.

709

"A String",

710

],

711

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

712

#

713

# Client side company identifier, used to uniquely identify the

714

# company.

715

#

716

# The maximum number of allowed characters is 255.

717

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

718

#

719

# The URI representing the company's primary web site or home page,

720

# for example, "https://www.google.com".

721

#

722

# The maximum number of allowed characters is 255.

723

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from

724

# public availability by the service when job content appears suspicious,

725

# abusive, or spammy.

726

"hiringAgency": True or False, # Optional.

727

#

728

# Set to true if it is the hiring agency that post jobs for other

729

# employers.

730

#

731

# Defaults to false if not provided.

732

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

733

#

734

# The employer's company size.

}</pre>

</div>

<code class="details" id="list">list(parent, requireOpenJobs=None, pageToken=None, x__xgafv=None, pageSize=None)</code>

740

<pre>Lists all companies associated with the service account.

741

742

Args:

743

parent: string, Required.

744

745

Resource name of the project under which the company is created.

746

747

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

748

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

749

requireOpenJobs: boolean, Optional.

750

751

Set to true if the companies requested must have open jobs.

Defaults to false.

If true, at most page_size of companies are fetched, among which

756

only those with open jobs are returned.

757

pageToken: string, Optional.

758

759

The starting indicator from which to return results.

760

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

pageSize: integer, Optional.

765

766

The maximum number of companies to be returned, at most 100.

767

Default is 100 if a non-positive number is provided.

768

769

Returns:

770

An object of the form:

{ # Output only.

#

# The List companies response object.

775

"nextPageToken": "A String", # A token to retrieve the next page of results.

776

"companies": [ # Companies for the current client.

777

{ # A Company resource represents a company in the service. A company is the

778

# entity that owns job postings, that is, the hiring entity responsible for

779

# employing applicants for the job position.

780

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

781

#

782

# The display name of the company, for example, "Google, LLC".

783

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

784

#

785

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

786

# company is created.

787

#

788

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

789

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

790

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

791

#

792

# The URI to employer's career site or careers page on the employer's web

793

# site, for example, "https://careers.google.com".

794

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

795

#

796

# The street address of the company's main headquarters, which may be

797

# different from the job location. The service attempts

798

# to geolocate the provided address, and populates a more specific

799

# location wherever possible in DerivedInfo.headquarters_location.

800

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

801

#

802

# Equal Employment Opportunity legal disclaimer text to be

803

# associated with all jobs, and typically to be displayed in all

804

# roles.

805

#

806

# The maximum number of allowed characters is 500.

807

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

808

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

809

# Company.hq_location if provided.

810

#

811

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

812

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

813

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

814

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

815

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

816

# 6.17 miles.

817

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

818

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

819

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

820

# LocationType#LOCALITY.

821

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

822

# of doubles representing degrees latitude and degrees longitude. Unless

823

# specified otherwise, this must conform to the

824

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

825

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

826

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

827

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

828

},

829

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

830

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

831

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

832

# delivery location.

833

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

834

# Box or similar.

835

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

836

# mountains).

837

#

838

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

839

# existing data, depending on the type of process.

840

#

841

# Advice on address input / editing:

842

# - Use an i18n-ready address widget such as

843

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

844

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

845

# fields outside countries where that field is used.

846

#

847

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

848

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

849

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

850

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

851

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

852

# transliterated equivalents.

853

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

854

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

855

# other non-formatting related operations.

856

#

857

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

858

# possibly incorrect default).

859

#

860

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

861

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

862

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

863

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

864

"A String",

865

],

866

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

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

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

881

# addresses of a country or region.

882

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

883

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

884

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

885

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

886

# in Switzerland this should be left unpopulated.

887

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

888

#

889

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

890

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

891

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

892

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

893

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

894

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

895

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

896

# an address can be selected based on the language.

897

#

898

# The minimum permitted structural representation of an address consists

899

# of a region_code with all remaining information placed in the

900

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

901

# approximately without geocoding, but no semantic reasoning could be

902

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

903

# partially resolved.

904

#

905

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

906

# then geocoding is the recommended way to handle completely unstructured

907

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

908

# localities or administrative areas).

909

"A String",

910

],

911

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

912

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

913

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

914

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

915

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

916

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

917

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

918

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

919

# the latest revision.

920

#

921

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

},

},

},

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

926

#

927

# A URI that hosts the employer's company logo.

928

"keywordSearchableJobCustomAttributes": [ # Optional.

929

#

930

# A list of keys of filterable Job.custom_attributes, whose

931

# corresponding `string_values` are used in keyword search. Jobs with

932

# `string_values` under these specified field keys are returned if any

933

# of the values matches the search keyword. Custom field values with

934

# parenthesis, brackets and special symbols won't be properly searchable,

935

# and those keyword queries need to be surrounded by quotes.

936

"A String",

937

],

938

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

939

#

940

# Client side company identifier, used to uniquely identify the

941

# company.

942

#

943

# The maximum number of allowed characters is 255.

944

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

945

#

946

# The URI representing the company's primary web site or home page,

947

# for example, "https://www.google.com".

948

#

949

# The maximum number of allowed characters is 255.

950

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from

951

# public availability by the service when job content appears suspicious,

952

# abusive, or spammy.

953

"hiringAgency": True or False, # Optional.

954

#

955

# Set to true if it is the hiring agency that post jobs for other

956

# employers.

957

#

958

# Defaults to false if not provided.

959

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

960

#

961

# The employer's company size.

962

},

963

],

964

"metadata": { # Output only. # Additional information for the API invocation, such as the request

965

# tracking id.

966

#

967

# Additional information returned to client, such as debugging information.

968

"requestId": "A String", # A unique id associated with this call.

969

# This id is logged for tracking purposes.

},

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

976

<pre>Retrieves the next page of results.

977

978

Args:

979

previous_request: The request for the previous page. (required)

980

previous_response: The response from the request for the previous page. (required)

981

982

Returns:

983

A request object that you can call 'execute()' on to request the next

984

page. Returns None if there are no more items in the collection.

</pre>

</div>

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

990

<pre>Updates specified company. Company names can't be updated. To update a

991

company name, delete the company and all jobs associated with it, and only

then re-create them.

Args:

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

998

company is created.

999

1000

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

1001

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

1002

body: object, The request body. (required)

1003

The object takes the form of:

{ # Input only.

#

# Request for updating a specified company.

1008

"company": { # A Company resource represents a company in the service. A company is the # Required.

1009

#

1010

# The company resource to replace the current resource in the system.

1011

# entity that owns job postings, that is, the hiring entity responsible for

1012

# employing applicants for the job position.

1013

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

1014

#

1015

# The display name of the company, for example, "Google, LLC".

1016

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

1017

#

1018

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

1019

# company is created.

1020

#

1021

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

1022

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

1023

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

1024

#

1025

# The URI to employer's career site or careers page on the employer's web

1026

# site, for example, "https://careers.google.com".

1027

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

1028

#

1029

# The street address of the company's main headquarters, which may be

1030

# different from the job location. The service attempts

1031

# to geolocate the provided address, and populates a more specific

1032

# location wherever possible in DerivedInfo.headquarters_location.

1033

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

1034

#

1035

# Equal Employment Opportunity legal disclaimer text to be

1036

# associated with all jobs, and typically to be displayed in all

1037

# roles.

1038

#

1039

# The maximum number of allowed characters is 500.

1040

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

1041

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

1042

# Company.hq_location if provided.

1043

#

1044

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

1045

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

1046

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

1047

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

1048

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

1049

# 6.17 miles.

1050

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

1051

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

1052

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

1053

# LocationType#LOCALITY.

1054

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

1055

# of doubles representing degrees latitude and degrees longitude. Unless

1056

# specified otherwise, this must conform to the

1057

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

1058

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

1059

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

1060

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

1061

},

1062

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

1063

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

1064

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

1065

# delivery location.

1066

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

1067

# Box or similar.

1068

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

1069

# mountains).

1070

#

1071

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

1072

# existing data, depending on the type of process.

1073

#

1074

# Advice on address input / editing:

1075

# - Use an i18n-ready address widget such as

1076

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

1077

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

1078

# fields outside countries where that field is used.

1079

#

1080

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

1081

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

1082

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

1083

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

1084

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

1085

# transliterated equivalents.

1086

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

1087

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

1088

# other non-formatting related operations.

1089

#

1090

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

1091

# possibly incorrect default).

1092

#

1093

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

1094

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

1095

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

1096

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

1097

"A String",

1098

],

1099

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

1100

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

1101

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

1102

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

1103

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

1104

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

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

# addresses of a country or region.

1115

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

1116

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

1117

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

1118

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

1119

# in Switzerland this should be left unpopulated.

1120

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

1121

#

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

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

1129

# an address can be selected based on the language.

1130

#

1131

# The minimum permitted structural representation of an address consists

1132

# of a region_code with all remaining information placed in the

1133

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

1134

# approximately without geocoding, but no semantic reasoning could be

1135

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

1136

# partially resolved.

1137

#

1138

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

1139

# then geocoding is the recommended way to handle completely unstructured

1140

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

1141

# localities or administrative areas).

1142

"A String",

1143

],

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

# the latest revision.

1153

#

1154

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

},

},

},

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

1159

#

1160

# A URI that hosts the employer's company logo.

1161

"keywordSearchableJobCustomAttributes": [ # Optional.

1162

#

1163

# A list of keys of filterable Job.custom_attributes, whose

1164

# corresponding `string_values` are used in keyword search. Jobs with

1165

# `string_values` under these specified field keys are returned if any

1166

# of the values matches the search keyword. Custom field values with

1167

# parenthesis, brackets and special symbols won't be properly searchable,

1168

# and those keyword queries need to be surrounded by quotes.

1169

"A String",

1170

],

1171

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

1172

#

1173

# Client side company identifier, used to uniquely identify the

1174

# company.

1175

#

1176

# The maximum number of allowed characters is 255.

1177

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

1178

#

1179

# The URI representing the company's primary web site or home page,

1180

# for example, "https://www.google.com".

1181

#

1182

# The maximum number of allowed characters is 255.

1183

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from

1184

# public availability by the service when job content appears suspicious,

1185

# abusive, or spammy.

1186

"hiringAgency": True or False, # Optional.

1187

#

1188

# Set to true if it is the hiring agency that post jobs for other

1189

# employers.

1190

#

1191

# Defaults to false if not provided.

1192

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

1193

#

1194

# The employer's company size.

1195

},

1196

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

1197

# experience.

1198

#

1199

# If update_mask is provided, only the specified fields in

1200

# company are updated. Otherwise all the fields are updated.

1201

#

1202

# A field mask to specify the company fields to be updated. Only

1203

# top level fields of Company are supported.

1204

}

1205

1206

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1213

1214

{ # A Company resource represents a company in the service. A company is the

1215

# entity that owns job postings, that is, the hiring entity responsible for

1216

# employing applicants for the job position.

1217

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

1218

#

1219

# The display name of the company, for example, "Google, LLC".

1220

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

1221

#

1222

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

1223

# company is created.

1224

#

1225

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

1226

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

1227

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

1228

#

1229

# The URI to employer's career site or careers page on the employer's web

1230

# site, for example, "https://careers.google.com".

1231

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

1232

#

1233

# The street address of the company's main headquarters, which may be

1234

# different from the job location. The service attempts

1235

# to geolocate the provided address, and populates a more specific

1236

# location wherever possible in DerivedInfo.headquarters_location.

1237

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

1238

#

1239

# Equal Employment Opportunity legal disclaimer text to be

1240

# associated with all jobs, and typically to be displayed in all

1241

# roles.

1242

#

1243

# The maximum number of allowed characters is 500.

1244

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

1245

"headquartersLocation": { # Output only. # A structured headquarters location of the company, resolved from

1246

# Company.hq_location if provided.

1247

#

1248

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

1249

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

1250

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

1251

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

1252

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

1253

# 6.17 miles.

1254

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

1255

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

1256

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

1257

# LocationType#LOCALITY.

1258

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

1259

# of doubles representing degrees latitude and degrees longitude. Unless

1260

# specified otherwise, this must conform to the

1261

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

1262

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

1263

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

1264

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

1265

},

1266

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

1267

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

1268

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

1269

# delivery location.

1270

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

1271

# Box or similar.

1272

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

1273

# mountains).

1274

#

1275

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

1276

# existing data, depending on the type of process.

1277

#

1278

# Advice on address input / editing:

1279

# - Use an i18n-ready address widget such as

1280

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

1281

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

1282

# fields outside countries where that field is used.

1283

#

1284

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

1285

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

1286

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

1287

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

1288

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

1289

# transliterated equivalents.

1290

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

1291

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

1292

# other non-formatting related operations.

1293

#

1294

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

1295

# possibly incorrect default).

1296

#

1297

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

1298

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

1299

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

1300

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

1301

"A String",

1302

],

1303

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

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

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

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

# addresses of a country or region.

1319

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

1320

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

1321

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

1322

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

1323

# in Switzerland this should be left unpopulated.

1324

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

1325

#

1326

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

1327

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

1328

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

1329

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

1330

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

1331

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

1332

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

1333

# an address can be selected based on the language.

1334

#

1335

# The minimum permitted structural representation of an address consists

1336

# of a region_code with all remaining information placed in the

1337

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

1338

# approximately without geocoding, but no semantic reasoning could be

1339

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

1340

# partially resolved.

1341

#

1342

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

1343

# then geocoding is the recommended way to handle completely unstructured

1344

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

1345

# localities or administrative areas).

1346

"A String",

1347

],

1348

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

1349

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

1350

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

1351

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

1352

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

1353

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

1354

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

1355

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

1356

# the latest revision.

1357

#

1358

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

},

},

},

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

1363

#

1364

# A URI that hosts the employer's company logo.

1365

"keywordSearchableJobCustomAttributes": [ # Optional.

1366

#

1367

# A list of keys of filterable Job.custom_attributes, whose

1368

# corresponding `string_values` are used in keyword search. Jobs with

1369

# `string_values` under these specified field keys are returned if any

1370

# of the values matches the search keyword. Custom field values with

1371

# parenthesis, brackets and special symbols won't be properly searchable,

1372

# and those keyword queries need to be surrounded by quotes.

1373

"A String",

1374

],

1375

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

1376

#

1377

# Client side company identifier, used to uniquely identify the

1378

# company.

1379

#

1380

# The maximum number of allowed characters is 255.

1381

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

1382

#

1383

# The URI representing the company's primary web site or home page,

1384

# for example, "https://www.google.com".

1385

#

1386

# The maximum number of allowed characters is 255.

1387

"suspended": True or False, # Output only. Indicates whether a company is flagged to be suspended from

1388

# public availability by the service when job content appears suspicious,

1389

# abusive, or spammy.

1390

"hiringAgency": True or False, # Optional.

1391

#

1392

# Set to true if it is the hiring agency that post jobs for other

1393

# employers.

1394

#

1395

# Defaults to false if not provided.

1396

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

1397

#

1398

# The employer's company size.

}</pre>

</div>

</body></html>