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

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

161

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

162

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

163

# delivery location.

164

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

165

# Box or similar.

166

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

167

# mountains).

168

#

169

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

170

# existing data, depending on the type of process.

171

#

172

# Advice on address input / editing:

173

# - Use an i18n-ready address widget such as

174

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

175

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

176

# fields outside countries where that field is used.

177

#

178

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

179

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

180

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

181

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

182

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

183

# transliterated equivalents.

184

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

185

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

186

# other non-formatting related operations.

187

#

188

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

189

# possibly incorrect default).

190

#

191

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

192

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

193

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

194

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

195

"A String",

196

],

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

# addresses of a country or region.

213

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

214

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

215

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

216

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

217

# in Switzerland this should be left unpopulated.

218

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

219

#

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

# an address can be selected based on the language.

228

#

229

# The minimum permitted structural representation of an address consists

230

# of a region_code with all remaining information placed in the

231

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

232

# approximately without geocoding, but no semantic reasoning could be

233

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

234

# partially resolved.

235

#

236

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

237

# then geocoding is the recommended way to handle completely unstructured

238

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

239

# localities or administrative areas).

240

"A String",

241

],

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

# the latest revision.

251

#

252

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

253

},

254

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

255

# of doubles representing degrees latitude and degrees longitude. Unless

256

# specified otherwise, this must conform to the

257

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

258

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

259

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

260

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

261

},

262

},

263

"companyInfoSources": [ # Optional.

264

#

265

# Identifiers external to the application that help to further identify

266

# the employer.

267

{ # A resource that represents an external Google identifier for a company,

268

# for example, a Google+ business page or a Google Maps business page.

269

# For unsupported types, use `unknown_type_id`.

270

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

271

#

272

# A Google identifier that does not match any of the other types.

273

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

274

#

275

# The numeric identifier for the employer's headquarters on Google Maps,

276

# namely, the Google Maps CID (cell id).

277

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

278

#

279

# The Google's Knowledge Graph value for the employer's company.

280

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

281

#

282

# The numeric identifier for the employer's Google+ business page.

283

},

284

],

285

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

286

#

287

# Equal Employment Opportunity legal disclaimer text to be

288

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

289

# roles.

290

#

291

# The maximum number of allowed characters is 500.

292

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

293

#

294

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

295

# different from the job location. The service attempts

296

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

297

# location wherever possible in structured_company_hq_location.

298

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

299

#

300

# The unique company identifier provided by the client to identify an

301

# employer for billing purposes. Recommended practice is to use

302

# the distributor_company_id.

303

#

304

# Defaults to same value as distributor_company_id when a value

305

# is not provided.

306

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

#

# Optional.

#

# A list of filterable custom fields that should be used in keyword

311

# search. The jobs of this company are returned if any of these custom

312

# fields matches the search keyword. Custom field values with parenthesis,

313

# brackets and special symbols might not be properly searchable, and those

314

# keyword queries need to be surrounded by quotes.

315

42,

316

],

317

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

322

"suspended": True or False, # Output only.

323

#

324

# Indicates whether a company is flagged to be suspended from public

325

# availability by the service when job content appears suspicious,

326

# abusive, or spammy.

327

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

328

#

329

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

330

# site.

331

"hiringAgency": True or False, # Optional.

332

#

333

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

334

# employers.

335

#

336

# Defaults to false if not provided.

337

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

338

#

339

# A client's company identifier, used to uniquely identify the

340

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

341

# and "Google", which the client wishes to use as the company displayed on

342

# the job. Best practice is to create a distinct company identifier for each

343

# distinct brand displayed.

344

#

345

# The maximum number of allowed characters is 255.

346

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

347

#

348

# A URL that hosts the employer's company logo. If provided,

349

# the logo image should be squared at 80x80 pixels.

350

#

351

# The url must be a Google Photos or Google Album url.

352

# Only images in these Google sub-domains are accepted.

353

}

354

355

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

362

363

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

364

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

365

# employing applicants for the job position.

366

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

367

#

368

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

369

# such as, "www.google.com".

370

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

371

#

372

# The employer's company size.

373

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

374

#

375

# The name of the employer to be displayed with the job,

376

# for example, "Google, LLC.".

377

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

378

#

379

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

380

# company is created, for example,

381

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

382

"keywordSearchableCustomAttributes": [ # Optional.

383

#

384

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

385

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

386

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

387

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

388

# parenthesis, brackets and special symbols might not be properly searchable,

389

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

390

"A String",

391

],

392

"title": "A String", # Deprecated. Use display_name instead.

#

# Required.

#

# The name of the employer to be displayed with the job,

397

# for example, "Google, LLC.".

398

"structuredCompanyHqLocation": { # Output only. # Output only.

399

#

400

# A structured headquarters location of the company,

401

# resolved from hq_location if possible.

402

#

403

# A resource that represents a location with full geographic

404

# information.

405

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

406

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

407

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

408

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

409

# 7885.79 meters.

410

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

411

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

412

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

413

# LocationType#LOCALITY.

414

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

415

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

416

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

417

# delivery location.

418

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

419

# Box or similar.

420

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

421

# mountains).

422

#

423

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

424

# existing data, depending on the type of process.

425

#

426

# Advice on address input / editing:

427

# - Use an i18n-ready address widget such as

428

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

429

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

430

# fields outside countries where that field is used.

431

#

432

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

433

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

434

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

435

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

436

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

437

# transliterated equivalents.

438

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

439

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

440

# other non-formatting related operations.

441

#

442

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

443

# possibly incorrect default).

444

#

445

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

446

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

447

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

448

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

449

"A String",

450

],

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

# addresses of a country or region.

467

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

468

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

469

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

470

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

471

# in Switzerland this should be left unpopulated.

472

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

473

#

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

# an address can be selected based on the language.

482

#

483

# The minimum permitted structural representation of an address consists

484

# of a region_code with all remaining information placed in the

485

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

486

# approximately without geocoding, but no semantic reasoning could be

487

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

488

# partially resolved.

489

#

490

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

491

# then geocoding is the recommended way to handle completely unstructured

492

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

493

# localities or administrative areas).

494

"A String",

495

],

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

# the latest revision.

505

#

506

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

507

},

508

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

509

# of doubles representing degrees latitude and degrees longitude. Unless

510

# specified otherwise, this must conform to the

511

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

512

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

513

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

514

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

515

},

516

},

517

"companyInfoSources": [ # Optional.

518

#

519

# Identifiers external to the application that help to further identify

520

# the employer.

521

{ # A resource that represents an external Google identifier for a company,

522

# for example, a Google+ business page or a Google Maps business page.

523

# For unsupported types, use `unknown_type_id`.

524

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

525

#

526

# A Google identifier that does not match any of the other types.

527

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

528

#

529

# The numeric identifier for the employer's headquarters on Google Maps,

530

# namely, the Google Maps CID (cell id).

531

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

532

#

533

# The Google's Knowledge Graph value for the employer's company.

534

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

535

#

536

# The numeric identifier for the employer's Google+ business page.

537

},

538

],

539

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

540

#

541

# Equal Employment Opportunity legal disclaimer text to be

542

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

543

# roles.

544

#

545

# The maximum number of allowed characters is 500.

546

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

547

#

548

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

549

# different from the job location. The service attempts

550

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

551

# location wherever possible in structured_company_hq_location.

552

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

553

#

554

# The unique company identifier provided by the client to identify an

555

# employer for billing purposes. Recommended practice is to use

556

# the distributor_company_id.

557

#

558

# Defaults to same value as distributor_company_id when a value

559

# is not provided.

560

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

#

# Optional.

#

# A list of filterable custom fields that should be used in keyword

565

# search. The jobs of this company are returned if any of these custom

566

# fields matches the search keyword. Custom field values with parenthesis,

567

# brackets and special symbols might not be properly searchable, and those

568

# keyword queries need to be surrounded by quotes.

569

42,

570

],

571

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

576

"suspended": True or False, # Output only.

577

#

578

# Indicates whether a company is flagged to be suspended from public

579

# availability by the service when job content appears suspicious,

580

# abusive, or spammy.

581

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

582

#

583

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

584

# site.

585

"hiringAgency": True or False, # Optional.

586

#

587

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

588

# employers.

589

#

590

# Defaults to false if not provided.

591

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

592

#

593

# A client's company identifier, used to uniquely identify the

594

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

595

# and "Google", which the client wishes to use as the company displayed on

596

# the job. Best practice is to create a distinct company identifier for each

597

# distinct brand displayed.

598

#

599

# The maximum number of allowed characters is 255.

600

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

601

#

602

# A URL that hosts the employer's company logo. If provided,

603

# the logo image should be squared at 80x80 pixels.

604

#

605

# The url must be a Google Photos or Google Album url.

606

# Only images in these Google sub-domains are accepted.

}</pre>

</div>

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

612

<pre>Deletes the specified company.

Args:

The resource name of the company to be deleted,

618

such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". (required)

619

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

626

627

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

628

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

629

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

630

#

631

# service Foo {

632

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

633

# }

634

#

635

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

}</pre>

</div>

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

641

<pre>Retrieves the specified company.

Args:

Resource name of the company to retrieve,

647

such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". (required)

648

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

655

656

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

657

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

658

# employing applicants for the job position.

659

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

660

#

661

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

662

# such as, "www.google.com".

663

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

664

#

665

# The employer's company size.

666

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

667

#

668

# The name of the employer to be displayed with the job,

669

# for example, "Google, LLC.".

670

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

671

#

672

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

673

# company is created, for example,

674

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

675

"keywordSearchableCustomAttributes": [ # Optional.

676

#

677

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

678

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

679

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

680

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

681

# parenthesis, brackets and special symbols might not be properly searchable,

682

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

683

"A String",

684

],

685

"title": "A String", # Deprecated. Use display_name instead.

#

# Required.

#

# The name of the employer to be displayed with the job,

690

# for example, "Google, LLC.".

691

"structuredCompanyHqLocation": { # Output only. # Output only.

692

#

693

# A structured headquarters location of the company,

694

# resolved from hq_location if possible.

695

#

696

# A resource that represents a location with full geographic

697

# information.

698

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

699

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

700

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

701

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

702

# 7885.79 meters.

703

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

704

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

705

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

706

# LocationType#LOCALITY.

707

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

708

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

709

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

710

# delivery location.

711

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

712

# Box or similar.

713

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

714

# mountains).

715

#

716

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

717

# existing data, depending on the type of process.

718

#

719

# Advice on address input / editing:

720

# - Use an i18n-ready address widget such as

721

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

722

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

723

# fields outside countries where that field is used.

724

#

725

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

726

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

727

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

728

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

729

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

730

# transliterated equivalents.

731

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

732

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

733

# other non-formatting related operations.

734

#

735

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

736

# possibly incorrect default).

737

#

738

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

739

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

740

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

741

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

742

"A String",

743

],

744

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

745

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

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

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

759

# addresses of a country or region.

760

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

761

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

762

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

763

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

764

# in Switzerland this should be left unpopulated.

765

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

766

#

767

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

768

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

769

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

770

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

771

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

772

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

773

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

774

# an address can be selected based on the language.

775

#

776

# The minimum permitted structural representation of an address consists

777

# of a region_code with all remaining information placed in the

778

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

779

# approximately without geocoding, but no semantic reasoning could be

780

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

781

# partially resolved.

782

#

783

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

784

# then geocoding is the recommended way to handle completely unstructured

785

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

786

# localities or administrative areas).

787

"A String",

788

],

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

# the latest revision.

798

#

799

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

800

},

801

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

802

# of doubles representing degrees latitude and degrees longitude. Unless

803

# specified otherwise, this must conform to the

804

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

805

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

806

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

807

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

808

},

809

},

810

"companyInfoSources": [ # Optional.

811

#

812

# Identifiers external to the application that help to further identify

813

# the employer.

814

{ # A resource that represents an external Google identifier for a company,

815

# for example, a Google+ business page or a Google Maps business page.

816

# For unsupported types, use `unknown_type_id`.

817

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

818

#

819

# A Google identifier that does not match any of the other types.

820

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

821

#

822

# The numeric identifier for the employer's headquarters on Google Maps,

823

# namely, the Google Maps CID (cell id).

824

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

825

#

826

# The Google's Knowledge Graph value for the employer's company.

827

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

828

#

829

# The numeric identifier for the employer's Google+ business page.

830

},

831

],

832

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

833

#

834

# Equal Employment Opportunity legal disclaimer text to be

835

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

836

# roles.

837

#

838

# The maximum number of allowed characters is 500.

839

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

840

#

841

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

842

# different from the job location. The service attempts

843

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

844

# location wherever possible in structured_company_hq_location.

845

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

846

#

847

# The unique company identifier provided by the client to identify an

848

# employer for billing purposes. Recommended practice is to use

849

# the distributor_company_id.

850

#

851

# Defaults to same value as distributor_company_id when a value

852

# is not provided.

853

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

#

# Optional.

#

# A list of filterable custom fields that should be used in keyword

858

# search. The jobs of this company are returned if any of these custom

859

# fields matches the search keyword. Custom field values with parenthesis,

860

# brackets and special symbols might not be properly searchable, and those

861

# keyword queries need to be surrounded by quotes.

862

42,

863

],

864

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

869

"suspended": True or False, # Output only.

870

#

871

# Indicates whether a company is flagged to be suspended from public

872

# availability by the service when job content appears suspicious,

873

# abusive, or spammy.

874

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

875

#

876

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

877

# site.

878

"hiringAgency": True or False, # Optional.

879

#

880

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

881

# employers.

882

#

883

# Defaults to false if not provided.

884

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

885

#

886

# A client's company identifier, used to uniquely identify the

887

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

888

# and "Google", which the client wishes to use as the company displayed on

889

# the job. Best practice is to create a distinct company identifier for each

890

# distinct brand displayed.

891

#

892

# The maximum number of allowed characters is 255.

893

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

894

#

895

# A URL that hosts the employer's company logo. If provided,

896

# the logo image should be squared at 80x80 pixels.

897

#

898

# The url must be a Google Photos or Google Album url.

899

# Only images in these Google sub-domains are accepted.

}</pre>

</div>

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

905

<pre>Lists all companies associated with a Cloud Talent Solution account.

906

907

Args:

908

pageSize: integer, Optional.

909

910

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

911

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

912

mustHaveOpenJobs: boolean, Optional.

913

914

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

Defaults to false.

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

919

only those with open jobs are returned.

920

pageToken: string, Optional.

921

922

The starting indicator from which to return results.

923

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# The List companies response object.

934

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

935

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

936

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

937

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

938

# employing applicants for the job position.

939

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

940

#

941

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

942

# such as, "www.google.com".

943

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

944

#

945

# The employer's company size.

946

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

947

#

948

# The name of the employer to be displayed with the job,

949

# for example, "Google, LLC.".

950

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

951

#

952

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

953

# company is created, for example,

954

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

955

"keywordSearchableCustomAttributes": [ # Optional.

956

#

957

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

958

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

959

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

960

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

961

# parenthesis, brackets and special symbols might not be properly searchable,

962

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

963

"A String",

964

],

965

"title": "A String", # Deprecated. Use display_name instead.

#

# Required.

#

# The name of the employer to be displayed with the job,

970

# for example, "Google, LLC.".

971

"structuredCompanyHqLocation": { # Output only. # Output only.

972

#

973

# A structured headquarters location of the company,

974

# resolved from hq_location if possible.

975

#

976

# A resource that represents a location with full geographic

977

# information.

978

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

979

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

980

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

981

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

982

# 7885.79 meters.

983

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

984

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

985

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

986

# LocationType#LOCALITY.

987

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

988

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

989

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

990

# delivery location.

991

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

992

# Box or similar.

993

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

994

# mountains).

995

#

996

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

997

# existing data, depending on the type of process.

998

#

999

# Advice on address input / editing:

1000

# - Use an i18n-ready address widget such as

1001

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

1002

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

1003

# fields outside countries where that field is used.

1004

#

1005

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

1006

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

1007

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

1008

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

1009

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

1010

# transliterated equivalents.

1011

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

1012

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

1013

# other non-formatting related operations.

1014

#

1015

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

1016

# possibly incorrect default).

1017

#

1018

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

1019

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

1020

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

1021

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

1022

"A String",

1023

],

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

# addresses of a country or region.

1040

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

1041

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

1042

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

1043

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

1044

# in Switzerland this should be left unpopulated.

1045

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

1046

#

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

# an address can be selected based on the language.

1055

#

1056

# The minimum permitted structural representation of an address consists

1057

# of a region_code with all remaining information placed in the

1058

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

1059

# approximately without geocoding, but no semantic reasoning could be

1060

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

1061

# partially resolved.

1062

#

1063

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

1064

# then geocoding is the recommended way to handle completely unstructured

1065

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

1066

# localities or administrative areas).

1067

"A String",

1068

],

1069

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

1070

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

1071

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

# the latest revision.

1078

#

1079

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

1080

},

1081

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

1082

# of doubles representing degrees latitude and degrees longitude. Unless

1083

# specified otherwise, this must conform to the

1084

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

1085

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

1086

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

1087

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

1088

},

1089

},

1090

"companyInfoSources": [ # Optional.

1091

#

1092

# Identifiers external to the application that help to further identify

1093

# the employer.

1094

{ # A resource that represents an external Google identifier for a company,

1095

# for example, a Google+ business page or a Google Maps business page.

1096

# For unsupported types, use `unknown_type_id`.

1097

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

1098

#

1099

# A Google identifier that does not match any of the other types.

1100

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

1101

#

1102

# The numeric identifier for the employer's headquarters on Google Maps,

1103

# namely, the Google Maps CID (cell id).

1104

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

1105

#

1106

# The Google's Knowledge Graph value for the employer's company.

1107

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

1108

#

1109

# The numeric identifier for the employer's Google+ business page.

1110

},

1111

],

1112

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

1113

#

1114

# Equal Employment Opportunity legal disclaimer text to be

1115

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

1116

# roles.

1117

#

1118

# The maximum number of allowed characters is 500.

1119

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

1120

#

1121

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

1122

# different from the job location. The service attempts

1123

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

1124

# location wherever possible in structured_company_hq_location.

1125

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

1126

#

1127

# The unique company identifier provided by the client to identify an

1128

# employer for billing purposes. Recommended practice is to use

1129

# the distributor_company_id.

1130

#

1131

# Defaults to same value as distributor_company_id when a value

1132

# is not provided.

1133

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

#

# Optional.

#

# A list of filterable custom fields that should be used in keyword

1138

# search. The jobs of this company are returned if any of these custom

1139

# fields matches the search keyword. Custom field values with parenthesis,

1140

# brackets and special symbols might not be properly searchable, and those

1141

# keyword queries need to be surrounded by quotes.

1142

42,

1143

],

1144

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

1149

"suspended": True or False, # Output only.

1150

#

1151

# Indicates whether a company is flagged to be suspended from public

1152

# availability by the service when job content appears suspicious,

1153

# abusive, or spammy.

1154

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

1155

#

1156

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

1157

# site.

1158

"hiringAgency": True or False, # Optional.

1159

#

1160

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

1161

# employers.

1162

#

1163

# Defaults to false if not provided.

1164

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

1165

#

1166

# A client's company identifier, used to uniquely identify the

1167

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

1168

# and "Google", which the client wishes to use as the company displayed on

1169

# the job. Best practice is to create a distinct company identifier for each

1170

# distinct brand displayed.

1171

#

1172

# The maximum number of allowed characters is 255.

1173

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

1174

#

1175

# A URL that hosts the employer's company logo. If provided,

1176

# the logo image should be squared at 80x80 pixels.

1177

#

1178

# The url must be a Google Photos or Google Album url.

1179

# Only images in these Google sub-domains are accepted.

1180

},

1181

],

1182

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

1183

# tracking id.

1184

#

1185

# Additional information returned to client, such as debugging

1186

# information.

1187

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

1188

# This id is logged for tracking purposes.

1189

"experimentIdList": [ # Identifiers for the versions of the search algorithm used during

1190

# this API invocation if multiple algorithms are used.

1191

# The default value is empty.

1192

# For search response only.

1193

42,

1194

],

1195

"mode": "A String", # For search response only. Indicates the mode of a performed search.

},

}</pre>

</div>

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

1202

<pre>Retrieves the next page of results.

1203

1204

Args:

1205

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

1206

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

1207

1208

Returns:

1209

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

1210

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

</pre>

</div>

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

1216

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

1217

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

1224

company is created, for example,

1225

"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". (required)

1226

body: object, The request body. (required)

1227

The object takes the form of:

1228

1229

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

1230

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

1231

# employing applicants for the job position.

1232

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

1233

#

1234

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

1235

# such as, "www.google.com".

1236

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

1237

#

1238

# The employer's company size.

1239

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

1240

#

1241

# The name of the employer to be displayed with the job,

1242

# for example, "Google, LLC.".

1243

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

1244

#

1245

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

1246

# company is created, for example,

1247

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

1248

"keywordSearchableCustomAttributes": [ # Optional.

1249

#

1250

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

1251

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

1252

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

1253

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

1254

# parenthesis, brackets and special symbols might not be properly searchable,

1255

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

1256

"A String",

1257

],

1258

"title": "A String", # Deprecated. Use display_name instead.

#

# Required.

#

# The name of the employer to be displayed with the job,

1263

# for example, "Google, LLC.".

1264

"structuredCompanyHqLocation": { # Output only. # Output only.

1265

#

1266

# A structured headquarters location of the company,

1267

# resolved from hq_location if possible.

1268

#

1269

# A resource that represents a location with full geographic

1270

# information.

1271

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

1272

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

1273

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

1274

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

1275

# 7885.79 meters.

1276

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

1277

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

1278

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

1279

# LocationType#LOCALITY.

1280

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

1281

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

1282

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

1283

# delivery location.

1284

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

1285

# Box or similar.

1286

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

1287

# mountains).

1288

#

1289

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

1290

# existing data, depending on the type of process.

1291

#

1292

# Advice on address input / editing:

1293

# - Use an i18n-ready address widget such as

1294

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

1295

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

1296

# fields outside countries where that field is used.

1297

#

1298

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

1299

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

1300

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

1301

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

1302

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

1303

# transliterated equivalents.

1304

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

1305

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

1306

# other non-formatting related operations.

1307

#

1308

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

1309

# possibly incorrect default).

1310

#

1311

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

1312

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

1313

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

1314

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

1315

"A String",

1316

],

1317

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

1318

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

1319

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

1320

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

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

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

1331

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

1332

# addresses of a country or region.

1333

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

1334

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

1335

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

1336

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

1337

# in Switzerland this should be left unpopulated.

1338

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

1339

#

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

# an address can be selected based on the language.

1348

#

1349

# The minimum permitted structural representation of an address consists

1350

# of a region_code with all remaining information placed in the

1351

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

1352

# approximately without geocoding, but no semantic reasoning could be

1353

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

1354

# partially resolved.

1355

#

1356

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

1357

# then geocoding is the recommended way to handle completely unstructured

1358

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

1359

# localities or administrative areas).

1360

"A String",

1361

],

1362

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

1363

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

1364

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

1365

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

1366

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

1367

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

1368

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

1369

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

1370

# the latest revision.

1371

#

1372

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

1373

},

1374

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

1375

# of doubles representing degrees latitude and degrees longitude. Unless

1376

# specified otherwise, this must conform to the

1377

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

1378

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

1379

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

1380

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

1381

},

1382

},

1383

"companyInfoSources": [ # Optional.

1384

#

1385

# Identifiers external to the application that help to further identify

1386

# the employer.

1387

{ # A resource that represents an external Google identifier for a company,

1388

# for example, a Google+ business page or a Google Maps business page.

1389

# For unsupported types, use `unknown_type_id`.

1390

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

1391

#

1392

# A Google identifier that does not match any of the other types.

1393

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

1394

#

1395

# The numeric identifier for the employer's headquarters on Google Maps,

1396

# namely, the Google Maps CID (cell id).

1397

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

1398

#

1399

# The Google's Knowledge Graph value for the employer's company.

1400

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

1401

#

1402

# The numeric identifier for the employer's Google+ business page.

1403

},

1404

],

1405

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

1406

#

1407

# Equal Employment Opportunity legal disclaimer text to be

1408

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

1409

# roles.

1410

#

1411

# The maximum number of allowed characters is 500.

1412

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

1413

#

1414

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

1415

# different from the job location. The service attempts

1416

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

1417

# location wherever possible in structured_company_hq_location.

1418

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

1419

#

1420

# The unique company identifier provided by the client to identify an

1421

# employer for billing purposes. Recommended practice is to use

1422

# the distributor_company_id.

1423

#

1424

# Defaults to same value as distributor_company_id when a value

1425

# is not provided.

1426

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

#

# Optional.

#

# A list of filterable custom fields that should be used in keyword

1431

# search. The jobs of this company are returned if any of these custom

1432

# fields matches the search keyword. Custom field values with parenthesis,

1433

# brackets and special symbols might not be properly searchable, and those

1434

# keyword queries need to be surrounded by quotes.

1435

42,

1436

],

1437

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

1442

"suspended": True or False, # Output only.

1443

#

1444

# Indicates whether a company is flagged to be suspended from public

1445

# availability by the service when job content appears suspicious,

1446

# abusive, or spammy.

1447

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

1448

#

1449

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

1450

# site.

1451

"hiringAgency": True or False, # Optional.

1452

#

1453

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

1454

# employers.

1455

#

1456

# Defaults to false if not provided.

1457

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

1458

#

1459

# A client's company identifier, used to uniquely identify the

1460

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

1461

# and "Google", which the client wishes to use as the company displayed on

1462

# the job. Best practice is to create a distinct company identifier for each

1463

# distinct brand displayed.

1464

#

1465

# The maximum number of allowed characters is 255.

1466

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

1467

#

1468

# A URL that hosts the employer's company logo. If provided,

1469

# the logo image should be squared at 80x80 pixels.

1470

#

1471

# The url must be a Google Photos or Google Album url.

1472

# Only images in these Google sub-domains are accepted.

1473

}

1474

1475

updateCompanyFields: string, Optional but strongly recommended to be provided for the best service

1476

experience.

1477

1478

If update_company_fields is provided, only the specified fields in

1479

company are updated. Otherwise all the fields are updated.

1480

1481

A field mask to specify the company fields to update. Valid values are:

* displayName

* website

* imageUrl

* companySize

* distributorBillingCompanyId

* companyInfoSources

* careerPageLink

* hiringAgency

* hqLocation

* eeoText

* keywordSearchableCustomAttributes

1494

* title (deprecated)

1495

* keywordSearchableCustomFields (deprecated)

1496

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1503

1504

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

1505

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

1506

# employing applicants for the job position.

1507

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

1508

#

1509

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

1510

# such as, "www.google.com".

1511

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

1512

#

1513

# The employer's company size.

1514

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

1515

#

1516

# The name of the employer to be displayed with the job,

1517

# for example, "Google, LLC.".

1518

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

1519

#

1520

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

1521

# company is created, for example,

1522

# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".

1523

"keywordSearchableCustomAttributes": [ # Optional.

1524

#

1525

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

1526

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

1527

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

1528

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

1529

# parenthesis, brackets and special symbols might not be properly searchable,

1530

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

1531

"A String",

1532

],

1533

"title": "A String", # Deprecated. Use display_name instead.

#

# Required.

#

# The name of the employer to be displayed with the job,

1538

# for example, "Google, LLC.".

1539

"structuredCompanyHqLocation": { # Output only. # Output only.

1540

#

1541

# A structured headquarters location of the company,

1542

# resolved from hq_location if possible.

1543

#

1544

# A resource that represents a location with full geographic

1545

# information.

1546

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

1547

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

1548

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

1549

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

1550

# 7885.79 meters.

1551

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

1552

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

1553

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

1554

# LocationType#LOCALITY.

1555

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

1556

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

1557

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

1558

# delivery location.

1559

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

1560

# Box or similar.

1561

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

1562

# mountains).

1563

#

1564

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

1565

# existing data, depending on the type of process.

1566

#

1567

# Advice on address input / editing:

1568

# - Use an i18n-ready address widget such as

1569

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

1570

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

1571

# fields outside countries where that field is used.

1572

#

1573

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

1574

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

1575

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

1576

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

1577

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

1578

# transliterated equivalents.

1579

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

1580

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

1581

# other non-formatting related operations.

1582

#

1583

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

1584

# possibly incorrect default).

1585

#

1586

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

1587

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

1588

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

1589

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

1590

"A String",

1591

],

1592

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

1593

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

1594

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

1595

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

1596

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

1597

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

1598

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

1599

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

1600

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

1601

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

1602

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

1603

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

1604

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

1605

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

1606

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

1607

# addresses of a country or region.

1608

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

1609

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

1610

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

1611

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

1612

# in Switzerland this should be left unpopulated.

1613

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

1614

#

1615

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

1616

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

1617

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

1618

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

1619

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

1620

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

1621

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

1622

# an address can be selected based on the language.

1623

#

1624

# The minimum permitted structural representation of an address consists

1625

# of a region_code with all remaining information placed in the

1626

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

1627

# approximately without geocoding, but no semantic reasoning could be

1628

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

1629

# partially resolved.

1630

#

1631

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

1632

# then geocoding is the recommended way to handle completely unstructured

1633

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

1634

# localities or administrative areas).

1635

"A String",

1636

],

1637

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

1638

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

1639

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

1640

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

1641

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

1642

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

1643

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

1644

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

1645

# the latest revision.

1646

#

1647

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

1648

},

1649

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

1650

# of doubles representing degrees latitude and degrees longitude. Unless

1651

# specified otherwise, this must conform to the

1652

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

1653

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

1654

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

1655

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

1656

},

1657

},

1658

"companyInfoSources": [ # Optional.

1659

#

1660

# Identifiers external to the application that help to further identify

1661

# the employer.

1662

{ # A resource that represents an external Google identifier for a company,

1663

# for example, a Google+ business page or a Google Maps business page.

1664

# For unsupported types, use `unknown_type_id`.

1665

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

1666

#

1667

# A Google identifier that does not match any of the other types.

1668

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

1669

#

1670

# The numeric identifier for the employer's headquarters on Google Maps,

1671

# namely, the Google Maps CID (cell id).

1672

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

1673

#

1674

# The Google's Knowledge Graph value for the employer's company.

1675

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

1676

#

1677

# The numeric identifier for the employer's Google+ business page.

1678

},

1679

],

1680

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

1681

#

1682

# Equal Employment Opportunity legal disclaimer text to be

1683

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

1684

# roles.

1685

#

1686

# The maximum number of allowed characters is 500.

1687

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

1688

#

1689

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

1690

# different from the job location. The service attempts

1691

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

1692

# location wherever possible in structured_company_hq_location.

1693

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

1694

#

1695

# The unique company identifier provided by the client to identify an

1696

# employer for billing purposes. Recommended practice is to use

1697

# the distributor_company_id.

1698

#

1699

# Defaults to same value as distributor_company_id when a value

1700

# is not provided.

1701

"keywordSearchableCustomFields": [ # Deprecated. Use keyword_searchable_custom_attributes instead.

#

# Optional.

#

# A list of filterable custom fields that should be used in keyword

1706

# search. The jobs of this company are returned if any of these custom

1707

# fields matches the search keyword. Custom field values with parenthesis,

1708

# brackets and special symbols might not be properly searchable, and those

1709

# keyword queries need to be surrounded by quotes.

1710

42,

1711

],

1712

"disableLocationOptimization": True or False, # Deprecated. Do not use this field.

#

# Optional.

#

# This field is no longer used. Any value set to it is ignored.

1717

"suspended": True or False, # Output only.

1718

#

1719

# Indicates whether a company is flagged to be suspended from public

1720

# availability by the service when job content appears suspicious,

1721

# abusive, or spammy.

1722

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

1723

#

1724

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

1725

# site.

1726

"hiringAgency": True or False, # Optional.

1727

#

1728

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

1729

# employers.

1730

#

1731

# Defaults to false if not provided.

1732

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

1733

#

1734

# A client's company identifier, used to uniquely identify the

1735

# company. If an employer has a subsidiary or sub-brand, such as "Alphabet"

1736

# and "Google", which the client wishes to use as the company displayed on

1737

# the job. Best practice is to create a distinct company identifier for each

1738

# distinct brand displayed.

1739

#

1740

# The maximum number of allowed characters is 255.

1741

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

1742

#

1743

# A URL that hosts the employer's company logo. If provided,

1744

# the logo image should be squared at 80x80 pixels.

1745

#

1746

# The url must be a Google Photos or Google Album url.

1747

# Only images in these Google sub-domains are accepted.

}</pre>

</div>

</body></html>