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

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

[diff] [blame]

328

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

329

# employing applicants for the job position.

Bu Sun Kim

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

[diff] [blame^]

330

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

331

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

332

# roles.

333

#

334

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

335

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

336

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

337

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

338

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

339

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

340

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

341

"A String",

342

],

Bu Sun Kim

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

[diff] [blame^]

343

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

344

# for example, "Google, LLC.".

345

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

#

# Optional.

#

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

350

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

351

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

352

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

353

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

354

# distinct brand displayed.

355

#

356

# The maximum number of allowed characters is 255.

357

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

358

#

359

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

360

# company is created, for example,

361

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

Bu Sun Kim

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

[diff] [blame]

362

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

363

# availability by the service when job content appears suspicious,

364

# abusive, or spammy.

Bu Sun Kim

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

[diff] [blame]

365

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

366

# employer for billing purposes. Recommended practice is to use

367

# the distributor_company_id.

Bu Sun Kim

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

[diff] [blame^]

368

#

Bu Sun Kim

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

[diff] [blame]

369

# Defaults to same value as distributor_company_id when a value

370

# is not provided.

Bu Sun Kim

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

[diff] [blame^]

371

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

372

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

373

#

374

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

375

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

376

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

377

# different from the job location. The service attempts

378

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

379

# location wherever possible in structured_company_hq_location.

380

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

#

# Required.

#

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

385

# for example, "Google, LLC.".

386

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

387

# the employer.

388

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

389

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

390

# For unsupported types, use `unknown_type_id`.

391

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

392

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

393

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

394

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

395

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

396

},

397

],

398

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

399

# employers.

400

#

401

# Defaults to false if not provided.

Bu Sun Kim

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

[diff] [blame]

402

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

403

# site.

Bu Sun Kim

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

[diff] [blame^]

404

"companySize": "A String", # Optional. The employer's company size.

Bu Sun Kim

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

[diff] [blame]

405

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

Bu Sun Kim

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

[diff] [blame^]

406

#

Dan O'Meara

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

[diff] [blame]

407

# Optional.

Bu Sun Kim

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

[diff] [blame^]

408

#

Dan O'Meara

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

[diff] [blame]

409

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

410

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

411

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

412

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

413

# keyword queries need to be surrounded by quotes.

414

42,

415

],

Bu Sun Kim

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

[diff] [blame]

416

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

Bu Sun Kim

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

[diff] [blame]

417

# resolved from hq_location if possible.

418

#

419

# A resource that represents a location with full geographic

420

# information.

Bu Sun Kim

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

[diff] [blame^]

421

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

422

# of doubles representing degrees latitude and degrees longitude. Unless

423

# specified otherwise, this must conform to the

424

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

425

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

426

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

427

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

428

},

Bu Sun Kim

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

[diff] [blame]

429

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

Bu Sun Kim

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

[diff] [blame]

430

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

431

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

432

# delivery location.

433

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

434

# Box or similar.

435

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

436

# mountains).

437

#

438

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

439

# existing data, depending on the type of process.

440

#

441

# Advice on address input / editing:

442

# - Use an i18n-ready address widget such as

Dan O'Meara

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

[diff] [blame]

443

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

Bu Sun Kim

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

[diff] [blame]

444

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

445

# fields outside countries where that field is used.

446

#

447

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

448

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

Bu Sun Kim

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

[diff] [blame^]

449

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

450

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

451

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

452

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

453

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

454

"A String",

455

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

456

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

457

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

458

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

459

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

Bu Sun Kim

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

[diff] [blame^]

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

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

466

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

467

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

468

# transliterated equivalents.

469

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

470

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

471

# other non-formatting related operations.

472

#

473

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

474

# possibly incorrect default).

475

#

476

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

477

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

478

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

479

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

480

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

481

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

482

# addresses of a country or region.

483

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

484

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

485

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

486

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

487

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

488

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

Bu Sun Kim

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

[diff] [blame]

489

#

490

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

491

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

Bu Sun Kim

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

[diff] [blame]

492

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

493

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

Bu Sun Kim

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

[diff] [blame]

494

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

Bu Sun Kim

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

[diff] [blame]

495

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

496

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

Bu Sun Kim

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

[diff] [blame]

497

# an address can be selected based on the language.

498

#

499

# The minimum permitted structural representation of an address consists

500

# of a region_code with all remaining information placed in the

501

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

502

# approximately without geocoding, but no semantic reasoning could be

503

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

504

# partially resolved.

505

#

506

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

507

# then geocoding is the recommended way to handle completely unstructured

508

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

509

# localities or administrative areas).

Bu Sun Kim

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

[diff] [blame]

510

"A String",

Bu Sun Kim

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

[diff] [blame]

511

],

Bu Sun Kim

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

[diff] [blame]

512

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

513

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

514

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

515

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

516

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

Bu Sun Kim

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

[diff] [blame^]

517

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

Bu Sun Kim

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

[diff] [blame]

518

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

Bu Sun Kim

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

[diff] [blame]

519

# the latest revision.

520

#

521

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

Bu Sun Kim

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

[diff] [blame]

522

},

523

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

524

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

525

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

526

# LocationType#LOCALITY.

527

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

528

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

529

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

530

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

531

# 7885.79 meters.

Bu Sun Kim

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

[diff] [blame]

532

},

Bu Sun Kim

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

[diff] [blame^]

533

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

534

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

535

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

540

<pre>Deletes the specified company.

541

542

Args:

Dan O'Meara

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

[diff] [blame]

543

Bu Sun Kim

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

[diff] [blame]

544

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

Bu Sun Kim

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

[diff] [blame]

545

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

552

553

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

554

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

555

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

556

#

557

# service Foo {

558

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

559

# }

560

#

561

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

}</pre>

</div>

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

567

<pre>Retrieves the specified company.

568

569

Args:

Dan O'Meara

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

[diff] [blame]

570

Bu Sun Kim

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

[diff] [blame]

571

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

Bu Sun Kim

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

[diff] [blame]

572

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

579

580

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

Bu Sun Kim

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

[diff] [blame^]

581

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

582

# employing applicants for the job position.

583

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

584

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

585

# roles.

586

#

587

# The maximum number of allowed characters is 500.

588

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

589

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

590

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

591

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

592

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

593

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

594

"A String",

595

],

596

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

597

# for example, "Google, LLC.".

598

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

#

# Optional.

#

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

603

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

604

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

605

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

606

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

607

# distinct brand displayed.

608

#

609

# The maximum number of allowed characters is 255.

610

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

611

#

612

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

613

# company is created, for example,

614

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

615

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

616

# availability by the service when job content appears suspicious,

617

# abusive, or spammy.

618

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

619

# employer for billing purposes. Recommended practice is to use

620

# the distributor_company_id.

621

#

622

# Defaults to same value as distributor_company_id when a value

623

# is not provided.

624

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

625

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

626

#

627

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

628

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

629

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

630

# different from the job location. The service attempts

631

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

632

# location wherever possible in structured_company_hq_location.

633

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

#

# Required.

#

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

638

# for example, "Google, LLC.".

639

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

640

# the employer.

641

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

642

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

643

# For unsupported types, use `unknown_type_id`.

644

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

645

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

646

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

647

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

648

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

Bu Sun Kim

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

[diff] [blame]

649

},

Bu Sun Kim

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

[diff] [blame^]

650

],

651

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

652

# employers.

653

#

654

# Defaults to false if not provided.

655

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

656

# site.

657

"companySize": "A String", # Optional. The employer's company size.

658

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

#

# Optional.

#

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

663

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

664

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

665

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

666

# keyword queries need to be surrounded by quotes.

667

42,

668

],

669

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

670

# resolved from hq_location if possible.

671

#

672

# A resource that represents a location with full geographic

673

# information.

674

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

675

# of doubles representing degrees latitude and degrees longitude. Unless

676

# specified otherwise, this must conform to the

677

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

678

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

679

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

680

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

681

},

682

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

683

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

684

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

685

# delivery location.

686

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

687

# Box or similar.

688

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

689

# mountains).

Bu Sun Kim

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

[diff] [blame]

690

#

Bu Sun Kim

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

[diff] [blame^]

691

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

692

# existing data, depending on the type of process.

Bu Sun Kim

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

[diff] [blame]

693

#

Bu Sun Kim

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

[diff] [blame^]

694

# Advice on address input / editing:

695

# - Use an i18n-ready address widget such as

696

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

697

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

698

# fields outside countries where that field is used.

Bu Sun Kim

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

[diff] [blame]

699

#

Bu Sun Kim

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

[diff] [blame^]

700

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

701

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

702

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

703

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

704

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

705

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

706

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

707

"A String",

708

],

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

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

717

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

718

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

719

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

720

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

721

# transliterated equivalents.

722

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

723

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

724

# other non-formatting related operations.

725

#

726

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

727

# possibly incorrect default).

728

#

729

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

730

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

731

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

732

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

733

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

734

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

735

# addresses of a country or region.

736

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

737

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

738

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

739

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

740

# in Switzerland this should be left unpopulated.

741

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

742

#

743

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

744

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

745

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

746

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

747

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

748

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

749

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

750

# an address can be selected based on the language.

751

#

752

# The minimum permitted structural representation of an address consists

753

# of a region_code with all remaining information placed in the

754

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

755

# approximately without geocoding, but no semantic reasoning could be

756

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

757

# partially resolved.

758

#

759

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

760

# then geocoding is the recommended way to handle completely unstructured

761

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

762

# localities or administrative areas).

763

"A String",

764

],

765

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

766

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

767

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

768

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

769

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

770

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

771

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

772

# the latest revision.

773

#

774

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

775

},

776

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

777

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

778

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

779

# LocationType#LOCALITY.

780

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

781

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

782

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

783

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

784

# 7885.79 meters.

785

},

786

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

787

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

788

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

792

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

Bu Sun Kim

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

[diff] [blame]

793

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

794

795

Args:

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

796

pageSize: integer, Optional. The maximum number of companies to be returned, at most 100.

797

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

Bu Sun Kim

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

[diff] [blame^]

798

pageToken: string, Optional. The starting indicator from which to return results.

Dan O'Meara

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

[diff] [blame]

799

mustHaveOpenJobs: boolean, Optional. Set to true if the companies request must have open jobs.

Bu Sun Kim

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

[diff] [blame]

Defaults to false.

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

804

only those with open jobs are returned.

Bu Sun Kim

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

[diff] [blame]

805

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.

Bu Sun Kim

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

[diff] [blame]

816

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

Bu Sun Kim

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

[diff] [blame]

817

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

Bu Sun Kim

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

[diff] [blame^]

818

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

819

# employing applicants for the job position.

820

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

821

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

822

# roles.

823

#

824

# The maximum number of allowed characters is 500.

825

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

826

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

827

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

828

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

829

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

830

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

831

"A String",

832

],

833

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

834

# for example, "Google, LLC.".

835

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

#

# Optional.

#

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

840

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

841

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

842

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

843

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

844

# distinct brand displayed.

845

#

846

# The maximum number of allowed characters is 255.

847

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

848

#

849

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

850

# company is created, for example,

851

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

852

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

853

# availability by the service when job content appears suspicious,

854

# abusive, or spammy.

855

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

856

# employer for billing purposes. Recommended practice is to use

857

# the distributor_company_id.

858

#

859

# Defaults to same value as distributor_company_id when a value

860

# is not provided.

861

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

862

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

863

#

864

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

865

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

866

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

867

# different from the job location. The service attempts

868

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

869

# location wherever possible in structured_company_hq_location.

870

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

#

# Required.

#

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

875

# for example, "Google, LLC.".

876

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

877

# the employer.

878

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

879

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

880

# For unsupported types, use `unknown_type_id`.

881

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

882

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

883

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

884

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

885

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

Bu Sun Kim

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

[diff] [blame]

886

},

Bu Sun Kim

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

[diff] [blame^]

887

],

888

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

889

# employers.

890

#

891

# Defaults to false if not provided.

892

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

893

# site.

894

"companySize": "A String", # Optional. The employer's company size.

895

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

#

# Optional.

#

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

900

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

901

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

902

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

903

# keyword queries need to be surrounded by quotes.

904

42,

905

],

906

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

907

# resolved from hq_location if possible.

908

#

909

# A resource that represents a location with full geographic

910

# information.

911

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

912

# of doubles representing degrees latitude and degrees longitude. Unless

913

# specified otherwise, this must conform to the

914

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

915

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

916

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

917

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

918

},

919

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

920

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

921

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

922

# delivery location.

923

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

924

# Box or similar.

925

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

926

# mountains).

Bu Sun Kim

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

[diff] [blame]

927

#

Bu Sun Kim

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

[diff] [blame^]

928

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

929

# existing data, depending on the type of process.

Bu Sun Kim

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

[diff] [blame]

930

#

Bu Sun Kim

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

[diff] [blame^]

931

# Advice on address input / editing:

932

# - Use an i18n-ready address widget such as

933

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

934

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

935

# fields outside countries where that field is used.

Bu Sun Kim

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

[diff] [blame]

936

#

Bu Sun Kim

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

[diff] [blame^]

937

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

938

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

939

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

940

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

941

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

942

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

943

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

944

"A String",

945

],

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

# transliterated equivalents.

959

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

960

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

961

# other non-formatting related operations.

962

#

963

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

964

# possibly incorrect default).

965

#

966

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

967

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

968

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

969

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

970

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

971

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

972

# addresses of a country or region.

973

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

974

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

975

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

976

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

977

# in Switzerland this should be left unpopulated.

978

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

979

#

980

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

981

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

982

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

983

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

984

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

985

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

986

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

987

# an address can be selected based on the language.

988

#

989

# The minimum permitted structural representation of an address consists

990

# of a region_code with all remaining information placed in the

991

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

992

# approximately without geocoding, but no semantic reasoning could be

993

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

994

# partially resolved.

995

#

996

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

997

# then geocoding is the recommended way to handle completely unstructured

998

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

999

# localities or administrative areas).

1000

"A String",

1001

],

1002

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

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

# the latest revision.

1010

#

1011

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

1012

},

1013

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

1014

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

1015

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

1016

# LocationType#LOCALITY.

1017

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

1018

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

1019

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

1020

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

1021

# 7885.79 meters.

Bu Sun Kim

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

[diff] [blame]

1022

},

Bu Sun Kim

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

[diff] [blame^]

1023

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

1024

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

1025

},

Bu Sun Kim

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

[diff] [blame]

1026

],

Bu Sun Kim

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

[diff] [blame]

1027

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

Bu Sun Kim

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

[diff] [blame]

1028

# tracking id.

1029

#

1030

# Additional information returned to client, such as debugging

1031

# information.

Bu Sun Kim

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

[diff] [blame]

1032

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

1033

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

Bu Sun Kim

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

[diff] [blame]

1034

# this API invocation if multiple algorithms are used.

1035

# The default value is empty.

1036

# For search response only.

1037

42,

1038

],

Bu Sun Kim

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

[diff] [blame^]

1039

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

1040

# This id is logged for tracking purposes.

Bu Sun Kim

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

[diff] [blame]

1041

},

Bu Sun Kim

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

[diff] [blame^]

1042

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

1048

<pre>Retrieves the next page of results.

1049

1050

Args:

1051

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

1052

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

1053

1054

Returns:

Bu Sun Kim

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

[diff] [blame]

1055

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

Bu Sun Kim

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

[diff] [blame]

1056

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1061

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

Bu Sun Kim

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

[diff] [blame]

1062

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

Bu Sun Kim

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

[diff] [blame]

1063

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

1070

company is created, for example,

Bu Sun Kim

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

[diff] [blame]

1071

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

Dan O'Meara

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

[diff] [blame]

1072

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1073

The object takes the form of:

1074

1075

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

Bu Sun Kim

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

[diff] [blame^]

1076

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

1077

# employing applicants for the job position.

1078

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

1079

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

1080

# roles.

1081

#

1082

# The maximum number of allowed characters is 500.

1083

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

1084

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

1085

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

1086

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

1087

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

1088

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

1089

"A String",

1090

],

1091

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

1092

# for example, "Google, LLC.".

1093

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

#

# Optional.

#

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

1098

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

1099

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

1100

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

1101

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

1102

# distinct brand displayed.

1103

#

1104

# The maximum number of allowed characters is 255.

1105

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

1106

#

1107

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

1108

# company is created, for example,

1109

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

1110

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

1111

# availability by the service when job content appears suspicious,

1112

# abusive, or spammy.

1113

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

1114

# employer for billing purposes. Recommended practice is to use

1115

# the distributor_company_id.

1116

#

1117

# Defaults to same value as distributor_company_id when a value

1118

# is not provided.

1119

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

1120

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

1121

#

1122

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

1123

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

1124

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

1125

# different from the job location. The service attempts

1126

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

1127

# location wherever possible in structured_company_hq_location.

1128

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

#

# Required.

#

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

1133

# for example, "Google, LLC.".

1134

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

1135

# the employer.

1136

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

1137

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

1138

# For unsupported types, use `unknown_type_id`.

1139

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

1140

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

1141

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

1142

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

1143

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

Bu Sun Kim

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

[diff] [blame]

1144

},

Bu Sun Kim

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

[diff] [blame^]

1145

],

1146

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

1147

# employers.

1148

#

1149

# Defaults to false if not provided.

1150

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

1151

# site.

1152

"companySize": "A String", # Optional. The employer's company size.

1153

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

#

# Optional.

#

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

1158

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

1159

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

1160

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

1161

# keyword queries need to be surrounded by quotes.

1162

42,

1163

],

1164

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

1165

# resolved from hq_location if possible.

1166

#

1167

# A resource that represents a location with full geographic

1168

# information.

1169

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

1170

# of doubles representing degrees latitude and degrees longitude. Unless

1171

# specified otherwise, this must conform to the

1172

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

1173

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

1174

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

1175

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

1176

},

1177

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

1178

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

1179

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

1180

# delivery location.

1181

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

1182

# Box or similar.

1183

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

1184

# mountains).

1185

#

1186

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

1187

# existing data, depending on the type of process.

1188

#

1189

# Advice on address input / editing:

1190

# - Use an i18n-ready address widget such as

1191

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

1192

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

1193

# fields outside countries where that field is used.

1194

#

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

"A String",

1203

],

1204

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

1205

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

1206

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

1207

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

1208

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

1209

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

1210

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

1211

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

1212

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

1213

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

1214

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

1215

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

1216

# transliterated equivalents.

1217

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

1218

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

1219

# other non-formatting related operations.

1220

#

1221

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

1222

# possibly incorrect default).

1223

#

1224

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

1225

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

1226

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

1227

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

1228

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

1229

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

1230

# addresses of a country or region.

1231

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

1232

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

1233

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

1234

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

1235

# in Switzerland this should be left unpopulated.

1236

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

1237

#

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

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

1245

# an address can be selected based on the language.

1246

#

1247

# The minimum permitted structural representation of an address consists

1248

# of a region_code with all remaining information placed in the

1249

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

1250

# approximately without geocoding, but no semantic reasoning could be

1251

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

1252

# partially resolved.

1253

#

1254

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

1255

# then geocoding is the recommended way to handle completely unstructured

1256

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

1257

# localities or administrative areas).

1258

"A String",

1259

],

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1266

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

1267

# the latest revision.

1268

#

1269

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

1270

},

1271

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

1272

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

1273

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

1274

# LocationType#LOCALITY.

1275

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

1276

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

1277

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

1278

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

1279

# 7885.79 meters.

1280

},

1281

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

1282

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

1283

}

Bu Sun Kim

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

[diff] [blame]

1284

1285

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

1286

experience.

1287

1288

If update_company_fields is provided, only the specified fields in

1289

company are updated. Otherwise all the fields are updated.

1290

1291

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

* displayName

* website

* imageUrl

* companySize

* distributorBillingCompanyId

* companyInfoSources

* careerPageLink

* hiringAgency

* hqLocation

* eeoText

* keywordSearchableCustomAttributes

1304

* title (deprecated)

1305

* keywordSearchableCustomFields (deprecated)

1306

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1313

1314

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

Bu Sun Kim

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

[diff] [blame^]

1315

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

1316

# employing applicants for the job position.

1317

"eeoText": "A String", # Optional. Equal Employment Opportunity legal disclaimer text to be

1318

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

1319

# roles.

1320

#

1321

# The maximum number of allowed characters is 500.

1322

"keywordSearchableCustomAttributes": [ # Optional. A list of keys of filterable Job.custom_attributes, whose

1323

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

1324

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

1325

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

1326

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

1327

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

1328

"A String",

1329

],

1330

"displayName": "A String", # Required. The name of the employer to be displayed with the job,

1331

# for example, "Google, LLC.".

1332

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

#

# Optional.

#

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

1337

"distributorCompanyId": "A String", # Required. A client's company identifier, used to uniquely identify the

1338

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

1339

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

1340

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

1341

# distinct brand displayed.

1342

#

1343

# The maximum number of allowed characters is 255.

1344

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

1345

#

1346

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

1347

# company is created, for example,

1348

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

1349

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

1350

# availability by the service when job content appears suspicious,

1351

# abusive, or spammy.

1352

"distributorBillingCompanyId": "A String", # Optional. The unique company identifier provided by the client to identify an

1353

# employer for billing purposes. Recommended practice is to use

1354

# the distributor_company_id.

1355

#

1356

# Defaults to same value as distributor_company_id when a value

1357

# is not provided.

1358

"imageUrl": "A String", # Optional. A URL that hosts the employer's company logo. If provided,

1359

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

1360

#

1361

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

1362

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

1363

"hqLocation": "A String", # Optional. The street address of the company's main headquarters, which may be

1364

# different from the job location. The service attempts

1365

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

1366

# location wherever possible in structured_company_hq_location.

1367

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

#

# Required.

#

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

1372

# for example, "Google, LLC.".

1373

"companyInfoSources": [ # Optional. Identifiers external to the application that help to further identify

1374

# the employer.

1375

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

1376

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

1377

# For unsupported types, use `unknown_type_id`.

1378

"unknownTypeId": "A String", # Optional. A Google identifier that does not match any of the other types.

1379

"gplusId": "A String", # Optional. The numeric identifier for the employer's Google+ business page.

1380

"freebaseMid": "A String", # Optional. The Google's Knowledge Graph value for the employer's company.

1381

"mapsCid": "A String", # Optional. The numeric identifier for the employer's headquarters on Google Maps,

1382

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

Bu Sun Kim

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

[diff] [blame]

1383

},

Bu Sun Kim

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

[diff] [blame^]

1384

],

1385

"hiringAgency": True or False, # Optional. Set to true if it is the hiring agency that post jobs for other

1386

# employers.

1387

#

1388

# Defaults to false if not provided.

1389

"careerPageLink": "A String", # Optional. The URL to employer's career site or careers page on the employer's web

1390

# site.

1391

"companySize": "A String", # Optional. The employer's company size.

1392

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

#

# Optional.

#

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

1397

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

1398

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

1399

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

1400

# keyword queries need to be surrounded by quotes.

1401

42,

1402

],

1403

"structuredCompanyHqLocation": { # Output only. # Output only. A structured headquarters location of the company,

1404

# resolved from hq_location if possible.

1405

#

1406

# A resource that represents a location with full geographic

1407

# information.

1408

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

1409

# of doubles representing degrees latitude and degrees longitude. Unless

1410

# specified otherwise, this must conform to the

1411

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

1412

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

1413

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

1414

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

1415

},

1416

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

1417

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

1418

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

1419

# delivery location.

1420

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

1421

# Box or similar.

1422

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

1423

# mountains).

Bu Sun Kim

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

[diff] [blame]

1424

#

Bu Sun Kim

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

[diff] [blame^]

1425

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

1426

# existing data, depending on the type of process.

Bu Sun Kim

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

[diff] [blame]

1427

#

Bu Sun Kim

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

[diff] [blame^]

1428

# Advice on address input / editing:

1429

# - Use an i18n-ready address widget such as

1430

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

1431

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

1432

# fields outside countries where that field is used.

Bu Sun Kim

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

[diff] [blame]

1433

#

Bu Sun Kim

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

[diff] [blame^]

1434

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

1435

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

1436

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

1437

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

1438

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

1439

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

1440

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

1441

"A String",

1442

],

1443

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

1444

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

1445

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

1446

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

1447

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

1448

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

1449

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

1450

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

1451

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

1452

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

1453

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

1454

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

1455

# transliterated equivalents.

1456

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

1457

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

1458

# other non-formatting related operations.

1459

#

1460

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

1461

# possibly incorrect default).

1462

#

1463

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

1464

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

1465

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

1466

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

1467

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

1468

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

1469

# addresses of a country or region.

1470

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

1471

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

1472

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

1473

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

1474

# in Switzerland this should be left unpopulated.

1475

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

1476

#

1477

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

1478

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

1479

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

1480

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

1481

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

1482

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

1483

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

1484

# an address can be selected based on the language.

1485

#

1486

# The minimum permitted structural representation of an address consists

1487

# of a region_code with all remaining information placed in the

1488

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

1489

# approximately without geocoding, but no semantic reasoning could be

1490

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

1491

# partially resolved.

1492

#

1493

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

1494

# then geocoding is the recommended way to handle completely unstructured

1495

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

1496

# localities or administrative areas).

1497

"A String",

1498

],

1499

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

1500

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

1501

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

1502

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

1503

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

1504

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

1505

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

1506

# the latest revision.

1507

#

1508

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

1509

},

1510

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

1511

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

1512

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

1513

# LocationType#LOCALITY.

1514

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

1515

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

1516

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

1517

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

1518

# 7885.79 meters.

1519

},

1520

"website": "A String", # Optional. The URL representing the company's primary web site or home page,

1521

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

1522

}</pre>

Bu Sun Kim