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

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

[diff] [blame^]

462

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

463

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

464

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

465

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

466

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

467

# addresses of a country or region.

468

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

469

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

470

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

471

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

472

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

473

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

Bu Sun Kim

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

[diff] [blame]

474

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

475

#

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

# an address can be selected based on the language.

484

#

485

# The minimum permitted structural representation of an address consists

486

# of a region_code with all remaining information placed in the

487

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

488

# approximately without geocoding, but no semantic reasoning could be

489

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

490

# partially resolved.

491

#

492

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

493

# then geocoding is the recommended way to handle completely unstructured

494

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

495

# localities or administrative areas).

496

"A String",

497

],

Bu Sun Kim

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

[diff] [blame^]

498

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

499

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

500

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

501

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

502

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

Bu Sun Kim

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

[diff] [blame]

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

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

513

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

514

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

515

# transliterated equivalents.

516

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

517

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

518

# other non-formatting related operations.

519

#

520

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

521

# possibly incorrect default).

522

#

523

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

524

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

525

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

526

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

527

"A String",

528

],

529

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

530

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

531

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

532

# the latest revision.

533

#

534

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

Bu Sun Kim

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

[diff] [blame]

535

},

536

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

537

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

538

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

539

# LocationType#LOCALITY.

540

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

541

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

542

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

543

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

544

# 7885.79 meters.

545

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

546

# of doubles representing degrees latitude and degrees longitude. Unless

547

# specified otherwise, this must conform to the

548

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

549

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

550

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

551

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

552

},

553

},

554

],

Bu Sun Kim

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

[diff] [blame]

555

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

560

# filterable_custom_fields. These fields are distinct in that the data

561

# in these fields are not indexed. Therefore, the client cannot search

562

# against them, nor can the client use them to list jobs.

563

#

564

# The key of the map can be any valid string.

565

"a_key": { # Resource that represents the custom data not captured by the standard fields.

566

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

572

#

573

# Optional but strongly recommended to be provided for the best service

574

# experience.

575

#

576

# The expiration date of the job in UTC time. After 12 am on this date, the

577

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

578

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

579

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

580

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

581

# opened again by using a future expiration date. It can also remain expired.

582

# Updating an expired job to be open fails if there is another existing open

583

# job with same requisition_id, company_name and language_code.

584

#

585

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

586

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

587

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

588

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

589

# out.

590

#

591

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

592

# ignored and treated as expiry date not provided.

593

#

594

# If this value is not provided on job creation or is invalid, the job

595

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

596

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

597

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

598

#

599

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

600

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

601

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

602

# updated, the job expires after 30 days from the job's last update time.

603

# Otherwise the expiration date isn't updated.

Bu Sun Kim

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

[diff] [blame]

604

# and time zone are either specified elsewhere or are not significant. The date

605

# is relative to the Proleptic Gregorian Calendar. This can represent:

606

#

607

# * A full date, with non-zero year, month and day values

608

# * A month and day value, with a zero year, e.g. an anniversary

609

# * A year on its own, with zero month and day values

610

# * A year and month value, with a zero day, e.g. a credit card expiration date

611

#

612

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

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

[diff] [blame]

613

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

Bu Sun Kim

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

[diff] [blame]

614

# if specifying a year by itself or a year and month where the day is not

615

# significant.

Bu Sun Kim

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

[diff] [blame]

616

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

Bu Sun Kim

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

[diff] [blame]

617

# a year.

Bu Sun Kim

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

[diff] [blame]

618

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

619

# month and day.

Bu Sun Kim

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

[diff] [blame]

620

},

Bu Sun Kim

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

[diff] [blame]

621

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

622

# is used for contracting engagements.

623

# Dates prior to 1970/1/1 and invalid date formats are ignored.

624

# and time zone are either specified elsewhere or are not significant. The date

625

# is relative to the Proleptic Gregorian Calendar. This can represent:

Bu Sun Kim

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

[diff] [blame]

626

#

Bu Sun Kim

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

[diff] [blame]

627

# * A full date, with non-zero year, month and day values

628

# * A month and day value, with a zero year, e.g. an anniversary

629

# * A year on its own, with zero month and day values

630

# * A year and month value, with a zero day, e.g. a credit card expiration date

Bu Sun Kim

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

[diff] [blame]

631

#

Bu Sun Kim

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

[diff] [blame]

632

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

633

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

634

# if specifying a year by itself or a year and month where the day is not

635

# significant.

636

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

637

# a year.

638

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

639

# month and day.

640

},

641

"educationLevels": [ # Optional. The desired education level for the job, such as

642

# "Bachelors", "Masters", "Doctorate".

643

"A String",

Bu Sun Kim

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

[diff] [blame]

644

],

Bu Sun Kim

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

[diff] [blame]

645

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

Bu Sun Kim

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

[diff] [blame]

646

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

647

#

648

# This field is a more general combination of the deprecated id-based

649

# filterable_custom_fields and string-based

650

# non_filterable_custom_fields.

651

#

652

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

653

# pattern: a-zA-Z*.

654

#

655

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

656

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

657

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

658

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

659

# is 50KB.

Bu Sun Kim

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

[diff] [blame]

660

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

Bu Sun Kim

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

[diff] [blame]

661

"longValue": "A String", # Optional but at least one of string_values or long_value must

662

# be specified.

663

#

664

# This field is used to perform number range search.

665

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

666

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

667

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

Bu Sun Kim

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

[diff] [blame]

668

# be specified.

669

#

670

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

671

# `CASE_INSENSITIVE_MATCH`) search.

672

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

673

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

674

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

675

# unfilterable `string_values` is 50KB.

676

#

677

# Empty strings are not allowed.

Bu Sun Kim

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

[diff] [blame]

678

"values": [ # Required. String values.

679

"A String",

Bu Sun Kim

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

[diff] [blame]

680

],

681

},

Bu Sun Kim

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

[diff] [blame^]

682

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

683

# If false, values are not searchable.

684

#

685

# Default is false.

Bu Sun Kim

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

[diff] [blame]

686

},

687

},

Bu Sun Kim

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

[diff] [blame]

688

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

693

# the standard fields such as job_title, company_name, or

694

# level. These custom fields store arbitrary

695

# string values, and can be used for purposes not covered by

696

# the structured fields. For the best search experience, use of the

697

# structured rather than custom fields is recommended.

698

#

699

# Data stored in these custom fields fields are indexed and

700

# searched against by keyword searches (see

701

# SearchJobsRequest.custom_field_filters][]).

702

#

703

# The map key must be a number between 1-20. If an invalid key is

704

# provided on job create or update, an error is returned.

705

"a_key": { # Resource that represents the custom data not captured by the standard fields.

706

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

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

712

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

713

#

714

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

715

# For more information, see

716

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

717

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

718

#

719

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

720

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

721

# defaults to 'en_US'.

722

"visibility": "A String", # Optional. The visibility of the job.

723

# Defaults to JobVisibility.PRIVATE if not specified.

724

# Currently only JobVisibility.PRIVATE is supported.

725

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

726

#

727

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

728

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

729

# requisition_id since this value is unique.

730

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

Bu Sun Kim

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

[diff] [blame]

731

# provided.

732

#

733

# A unique company identifier used by job distributors to identify an

Bu Sun Kim

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

[diff] [blame]

734

# employer's company entity. company_name takes precedence over

Bu Sun Kim

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

[diff] [blame]

735

# this field, and is the recommended field to use to identify companies.

736

#

737

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame]

738

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

739

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

740

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

741

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

742

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

743

#

744

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

745

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

746

# value is the time the request arrives at the server.

747

# and time zone are either specified elsewhere or are not significant. The date

748

# is relative to the Proleptic Gregorian Calendar. This can represent:

749

#

750

# * A full date, with non-zero year, month and day values

751

# * A month and day value, with a zero year, e.g. an anniversary

752

# * A year on its own, with zero month and day values

753

# * A year and month value, with a zero day, e.g. a credit card expiration date

754

#

755

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

756

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

757

# if specifying a year by itself or a year and month where the day is not

758

# significant.

759

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

760

# a year.

761

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

762

# month and day.

763

},

764

"applicationUrls": [ # Optional but at least one of application_urls,

765

# application_email_list or application_instruction must be

766

# specified.

767

#

768

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

769

# link to an online application form.

770

#

771

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

772

"A String",

773

],

774

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

775

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

776

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

777

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

778

# to be created if there is another job with the same requisition_id,

779

# company_name and language_code.

780

#

781

# The maximum number of allowed characters is 255.

782

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

783

# job. The use of this field is recommended

784

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

785

#

786

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

787

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

788

#

789

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

Bu Sun Kim

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

[diff] [blame^]

790

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

Bu Sun Kim

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

[diff] [blame]

791

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

792

# is used for contracting engagements.

793

# Dates prior to 1970/1/1 and invalid date formats are ignored.

794

# and time zone are either specified elsewhere or are not significant. The date

795

# is relative to the Proleptic Gregorian Calendar. This can represent:

796

#

797

# * A full date, with non-zero year, month and day values

798

# * A month and day value, with a zero year, e.g. an anniversary

799

# * A year on its own, with zero month and day values

800

# * A year and month value, with a zero day, e.g. a credit card expiration date

801

#

802

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

803

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

804

# if specifying a year by itself or a year and month where the day is not

805

# significant.

806

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

807

# a year.

808

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

809

# month and day.

810

},

Bu Sun Kim

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

[diff] [blame]

811

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

812

"applicationInstruction": "A String", # Optional but at least one of application_urls,

813

# application_email_list or application_instruction must be

814

# specified.

815

#

816

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

817

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

818

#

819

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

820

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

821

#

822

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

823

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

824

"A String",

825

],

826

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

827

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

828

#

829

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

830

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

# full time or

# part time.

"A String",

],

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

836

#

837

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

838

#

839

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

840

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

841

#

842

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

843

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

844

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

845

# multiple jobs with the same requisition_id, company_name and

846

# language_code are not allowed. If the original requisition_id must

847

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

848

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

849

# for better search experience.

850

#

851

# The maximum number of allowed characters is 500.

852

"A String",

853

],

854

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

859

#

860

# This field replaces compensation_info. Only

861

# CompensationInfo.entries or extended_compensation_info can be set,

862

# otherwise an exception is thrown.

863

#

864

# Describes job compensation.

865

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

866

# currency code.

867

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

868

#

869

# Compensation range.

870

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

871

#

872

# Decimal number.

873

"micros": 42, # Micro (10^-6) units.

874

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

875

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

876

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

877

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

878

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

879

"units": "A String", # Whole units.

880

},

881

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

882

#

883

# Decimal number.

884

"micros": 42, # Micro (10^-6) units.

885

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

886

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

887

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

888

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

889

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

890

"units": "A String", # Whole units.

891

},

892

},

893

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

894

#

895

# At most one entry can be of type

896

# ExtendedCompensationInfo.CompensationType.BASE, which is

897

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

898

{ # Deprecated. See CompensationInfo.

899

#

900

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

901

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

902

#

903

# Annualization: One compensation entry can be annualized if

904

# - it contains valid amount or range.

905

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

906

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

907

# expected_units_per_year.

Bu Sun Kim

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

[diff] [blame^]

908

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

909

#

910

# Decimal number.

911

"micros": 42, # Micro (10^-6) units.

912

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

913

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

914

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

915

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

916

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

917

"units": "A String", # Whole units.

918

},

919

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

Bu Sun Kim

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

[diff] [blame]

920

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

921

#

922

# Compensation range.

923

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

924

#

925

# Decimal number.

926

"micros": 42, # Micro (10^-6) units.

927

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

928

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

929

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

930

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

931

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

932

"units": "A String", # Whole units.

933

},

934

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

935

#

936

# Decimal number.

937

"micros": 42, # Micro (10^-6) units.

938

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

939

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

940

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

941

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

942

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

943

"units": "A String", # Whole units.

944

},

945

},

946

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

947

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

948

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

957

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

958

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

959

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

960

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

961

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

962

"units": "A String", # Whole units.

963

},

964

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

965

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

966

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

967

#

968

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

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

[diff] [blame]

969

},

970

],

971

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

972

# the job's all CompensationEntry cannot be annualized.

973

# See CompensationEntry for explanation on annualization and base

974

# compensation entry.

975

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

976

#

977

# Compensation range.

978

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

979

#

980

# Decimal number.

981

"micros": 42, # Micro (10^-6) units.

982

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

983

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

984

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

985

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

986

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

987

"units": "A String", # Whole units.

988

},

989

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

990

#

991

# Decimal number.

992

"micros": 42, # Micro (10^-6) units.

993

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

994

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

995

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

996

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

997

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

998

"units": "A String", # Whole units.

999

},

1000

},

1001

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

1002

# the job's base compensation entry cannot be annualized.

1003

# See CompensationEntry for explanation on annualization and base

1004

# compensation entry.

1005

},

1006

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

1007

# provided.

1008

#

1009

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

1010

# /companies/foo. This field takes precedence over the

1011

# distributor-assigned company identifier, distributor_company_id.

1012

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

1013

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

1014

# provided on the job object for responsibilities,

1015

# qualifications, and other job characteristics. Use of

1016

# these separate job fields is recommended.

1017

#

1018

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

1019

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

1020

#

1021

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

1022

"applicationEmailList": [ # Optional but at least one of application_urls,

1023

# application_email_list or application_instruction must be

1024

# specified.

1025

#

1026

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

1027

# applications can be sent.

1028

#

1029

# The maximum number of allowed characters is 255.

1030

"A String",

1031

],

Bu Sun Kim

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

[diff] [blame]

1032

},

Bu Sun Kim

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

[diff] [blame^]

1033

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

1034

#

1035

# Options for job processing.

1036

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

1037

#

1038

# * description

1039

# * applicationInstruction

# * incentives

# * qualifications

# * responsibilities

#

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

1045

#

1046

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

1047

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

1048

# more precise address for the job.

1049

},

1050

"disableStreetAddressResolution": True or False, # Deprecated. Please use processing_options. This flag is ignored if

1051

# processing_options is set.

#

# Optional.

#

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

1056

# more precise address for the job.

Bu Sun Kim

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

[diff] [blame]

1057

}

1058

1059

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1066

Bu Sun Kim

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

[diff] [blame]

1067

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

1068

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

Bu Sun Kim

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

[diff] [blame]

1069

# entity responsible for the job.

Bu Sun Kim

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

[diff] [blame^]

1070

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

1071

#

1072

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

1073

"region": "A String", # Optional. The job Region (for example, state, country) throughout which the job

1074

# is available. If this field is set, a

1075

# LocationFilter in a search query within the job region

1076

# finds this job if an exact location match is not specified.

1077

# If this field is set, setting job locations

1078

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

1079

"referenceUrl": "A String", # Output only. The URL of a web page that displays job details.

1080

"companyTitle": "A String", # Deprecated. Use company_display_name instead.

Bu Sun Kim

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

[diff] [blame]

1081

#

Bu Sun Kim

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

[diff] [blame]

1082

# Output only.

Bu Sun Kim

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

[diff] [blame]

1083

#

Bu Sun Kim

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

[diff] [blame]

1084

# The name of the company listing the job.

Bu Sun Kim

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

[diff] [blame^]

1085

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

1086

# recommended as an alternative to using the more general description

1087

# field.

1088

#

1089

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

1090

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

1091

#

1092

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

Bu Sun Kim

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

[diff] [blame]

1093

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

Bu Sun Kim

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

[diff] [blame]

1094

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

1095

# all compensation entries' CompensationEntry.compensation times

1096

# CompensationEntry.expected_units_per_year.

1097

#

1098

# See CompensationEntry for explanation on compensation annualization.

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

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

1101

# match the currency code of

1102

# min_compensation.

Bu Sun Kim

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

[diff] [blame^]

1103

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

1104

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

1105

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

Bu Sun Kim

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

[diff] [blame]

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

Bu Sun Kim

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

[diff] [blame^]

1112

},

1113

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

1114

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

1115

# currency code of max_compensation.

Bu Sun Kim

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

[diff] [blame]

1116

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

1117

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

1118

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

Bu Sun Kim

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

[diff] [blame^]

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

Bu Sun Kim

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

[diff] [blame]

1125

},

1126

},

1127

"min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# A lower bound on a range for compensation or pay for the job.

1132

# The currency type is specified in compensation_amount.

Bu Sun Kim

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

[diff] [blame^]

1133

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

1134

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

1135

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

Bu Sun Kim

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

[diff] [blame]

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

Bu Sun Kim

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

[diff] [blame]

1142

},

1143

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

Bu Sun Kim

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

[diff] [blame]

1144

#

1145

# At most one entry can be of type

1146

# CompensationInfo.CompensationType.BASE, which is

1147

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

1148

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

1149

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

1150

#

1151

# Annualization: One compensation entry can be annualized if

1152

# - it contains valid amount or range.

1153

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

1154

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

1155

# expected_units_per_year.

Bu Sun Kim

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

[diff] [blame]

1156

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

Bu Sun Kim

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

[diff] [blame]

1157

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

1158

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

Bu Sun Kim

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

[diff] [blame]

1164

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

1165

# indicate equity terms or provide additional context to an estimated

1166

# bonus.

1167

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

1168

#

1169

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

1170

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

Bu Sun Kim

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

[diff] [blame^]

1171

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

1172

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

1173

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

Bu Sun Kim

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

[diff] [blame]

1174

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

Bu Sun Kim

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

[diff] [blame]

1175

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

1176

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

1177

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

1178

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

1179

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

Bu Sun Kim

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

[diff] [blame]

1180

},

Bu Sun Kim

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

[diff] [blame]

1181

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

Bu Sun Kim

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

[diff] [blame^]

1182

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

1183

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

1184

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

1185

# match the currency code of

1186

# min_compensation.

1187

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

1188

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

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

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

1196

},

1197

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

1198

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

1199

# currency code of max_compensation.

1200

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

1201

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

1202

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

1203

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

1204

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

1205

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

1206

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

1207

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

1208

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

1209

},

1210

},

Bu Sun Kim

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

[diff] [blame]

1211

},

1212

],

Bu Sun Kim

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

[diff] [blame^]

1213

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

1214

# base compensation entry's CompensationEntry.compensation times

1215

# CompensationEntry.expected_units_per_year.

1216

#

1217

# See CompensationEntry for explanation on compensation annualization.

1218

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

1219

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

1220

# match the currency code of

1221

# min_compensation.

1222

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

1223

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

1224

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

1225

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

1226

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

1227

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

1228

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

1229

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

1230

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

1231

},

1232

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

1233

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

1234

# currency code of max_compensation.

1235

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

1236

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

1237

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

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

},

1245

},

1246

"amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# The amount of compensation or pay for the job.

1251

# As an alternative, compensation_amount_min and

1252

# compensation_amount_max may be used to define a range of

1253

# compensation.

1254

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

1255

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

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

},

1264

"type": "A String", # Deprecated. Use entries instead.

#

# Optional.

#

# Type of job compensation.

1269

"max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# An upper bound on a range for compensation or pay for the job.

1274

# The currency type is specified in compensation_amount.

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

1283

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

1284

},

Bu Sun Kim

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

[diff] [blame]

1285

},

Bu Sun Kim

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

[diff] [blame]

1286

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

Bu Sun Kim

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

[diff] [blame]

1287

# experience.

1288

#

1289

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

1290

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

Bu Sun Kim

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

[diff] [blame]

1291

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

Bu Sun Kim

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

[diff] [blame]

1292

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

1293

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

1294

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

1295

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

1296

# requisition_id, company_name and language_code.

1297

#

1298

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

1299

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

1300

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

1301

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

1302

# out.

1303

# The format of this field is RFC 3339 date strings. Example:

1304

# 2000-01-01T00:00:00.999999999Z

1305

# See

1306

# [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).

1307

#

1308

# A valid date range is between 1970-01-01T00:00:00.0Z and

1309

# 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire

1310

# time not provided.

1311

#

1312

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

Bu Sun Kim

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

[diff] [blame]

1313

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

Bu Sun Kim

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

[diff] [blame]

1314

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

1315

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

1316

#

1317

# If this value is not provided but expiry_date is, expiry_date is

1318

# used.

1319

#

1320

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

1321

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

1322

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

Bu Sun Kim

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

[diff] [blame]

1323

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

1324

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

1325

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

Bu Sun Kim

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

[diff] [blame^]

1326

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

1327

# position.

1328

#

1329

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame]

1330

"jobLocations": [ # Output only. Structured locations of the job, resolved from locations.

1331

{ # Output only.

1332

#

1333

# A resource that represents a location with full geographic

1334

# information.

1335

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

1336

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

1337

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

1338

# delivery location.

1339

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

1340

# Box or similar.

1341

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

1342

# mountains).

1343

#

1344

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

1345

# existing data, depending on the type of process.

1346

#

1347

# Advice on address input / editing:

1348

# - Use an i18n-ready address widget such as

1349

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

1350

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

1351

# fields outside countries where that field is used.

1352

#

1353

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

1354

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

Bu Sun Kim

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

[diff] [blame^]

1355

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

1356

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

1357

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

1358

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

1359

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

1360

# addresses of a country or region.

1361

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

1362

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

1363

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

1364

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

1365

# in Switzerland this should be left unpopulated.

Bu Sun Kim

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

[diff] [blame]

1366

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

Bu Sun Kim

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

[diff] [blame]

1367

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

1368

#

1369

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

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

1376

# an address can be selected based on the language.

1377

#

1378

# The minimum permitted structural representation of an address consists

1379

# of a region_code with all remaining information placed in the

1380

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

1381

# approximately without geocoding, but no semantic reasoning could be

1382

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

1383

# partially resolved.

1384

#

1385

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

1386

# then geocoding is the recommended way to handle completely unstructured

1387

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

1388

# localities or administrative areas).

1389

"A String",

1390

],

Bu Sun Kim

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

[diff] [blame^]

1391

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

1392

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

1393

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

1394

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

1395

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

Bu Sun Kim

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

[diff] [blame]

1396

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

1397

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

1398

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

1399

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

1400

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

1401

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

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

# transliterated equivalents.

1409

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

1410

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

1411

# other non-formatting related operations.

1412

#

1413

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

1414

# possibly incorrect default).

1415

#

1416

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

1417

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

1418

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

1419

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

1420

"A String",

1421

],

1422

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

1423

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

1424

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

1425

# the latest revision.

1426

#

1427

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

Bu Sun Kim

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

[diff] [blame]

1428

},

1429

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

1430

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

1431

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

1432

# LocationType#LOCALITY.

1433

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

1434

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

1435

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

1436

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

1437

# 7885.79 meters.

1438

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

1439

# of doubles representing degrees latitude and degrees longitude. Unless

1440

# specified otherwise, this must conform to the

1441

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

1442

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

1443

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

1444

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

1445

},

1446

},

1447

],

Bu Sun Kim

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

[diff] [blame]

1448

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

1453

# filterable_custom_fields. These fields are distinct in that the data

1454

# in these fields are not indexed. Therefore, the client cannot search

1455

# against them, nor can the client use them to list jobs.

1456

#

1457

# The key of the map can be any valid string.

1458

"a_key": { # Resource that represents the custom data not captured by the standard fields.

1459

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

1465

#

1466

# Optional but strongly recommended to be provided for the best service

1467

# experience.

1468

#

1469

# The expiration date of the job in UTC time. After 12 am on this date, the

1470

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

1471

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

1472

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

1473

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

1474

# opened again by using a future expiration date. It can also remain expired.

1475

# Updating an expired job to be open fails if there is another existing open

1476

# job with same requisition_id, company_name and language_code.

1477

#

1478

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

1479

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

1480

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

1481

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

1482

# out.

1483

#

1484

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

1485

# ignored and treated as expiry date not provided.

1486

#

1487

# If this value is not provided on job creation or is invalid, the job

1488

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

1489

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

1490

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

1491

#

1492

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

1493

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

1494

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

1495

# updated, the job expires after 30 days from the job's last update time.

1496

# Otherwise the expiration date isn't updated.

Bu Sun Kim

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

[diff] [blame]

1497

# and time zone are either specified elsewhere or are not significant. The date

1498

# is relative to the Proleptic Gregorian Calendar. This can represent:

1499

#

1500

# * A full date, with non-zero year, month and day values

1501

# * A month and day value, with a zero year, e.g. an anniversary

1502

# * A year on its own, with zero month and day values

1503

# * A year and month value, with a zero day, e.g. a credit card expiration date

1504

#

1505

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

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

[diff] [blame]

1506

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

Bu Sun Kim

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

[diff] [blame]

1507

# if specifying a year by itself or a year and month where the day is not

1508

# significant.

Bu Sun Kim

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

[diff] [blame]

1509

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

Bu Sun Kim

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

[diff] [blame]

1510

# a year.

Bu Sun Kim

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

[diff] [blame]

1511

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

1512

# month and day.

Bu Sun Kim

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

[diff] [blame]

1513

},

Bu Sun Kim

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

[diff] [blame]

1514

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

1515

# is used for contracting engagements.

1516

# Dates prior to 1970/1/1 and invalid date formats are ignored.

1517

# and time zone are either specified elsewhere or are not significant. The date

1518

# is relative to the Proleptic Gregorian Calendar. This can represent:

Bu Sun Kim

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

[diff] [blame]

1519

#

Bu Sun Kim

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

[diff] [blame]

1520

# * A full date, with non-zero year, month and day values

1521

# * A month and day value, with a zero year, e.g. an anniversary

1522

# * A year on its own, with zero month and day values

1523

# * A year and month value, with a zero day, e.g. a credit card expiration date

Bu Sun Kim

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

[diff] [blame]

1524

#

Bu Sun Kim

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

[diff] [blame]

1525

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

1526

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

1527

# if specifying a year by itself or a year and month where the day is not

1528

# significant.

1529

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

1530

# a year.

1531

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

1532

# month and day.

1533

},

1534

"educationLevels": [ # Optional. The desired education level for the job, such as

1535

# "Bachelors", "Masters", "Doctorate".

1536

"A String",

Bu Sun Kim

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

[diff] [blame]

1537

],

Bu Sun Kim

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

[diff] [blame]

1538

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

Bu Sun Kim

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

[diff] [blame]

1539

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

1540

#

1541

# This field is a more general combination of the deprecated id-based

1542

# filterable_custom_fields and string-based

1543

# non_filterable_custom_fields.

1544

#

1545

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

1546

# pattern: a-zA-Z*.

1547

#

1548

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

1549

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

1550

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

1551

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

1552

# is 50KB.

Bu Sun Kim

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

[diff] [blame]

1553

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

Bu Sun Kim

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

[diff] [blame]

1554

"longValue": "A String", # Optional but at least one of string_values or long_value must

1555

# be specified.

1556

#

1557

# This field is used to perform number range search.

1558

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

1559

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

1560

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

Bu Sun Kim

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

[diff] [blame]

1561

# be specified.

1562

#

1563

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

1564

# `CASE_INSENSITIVE_MATCH`) search.

1565

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

1566

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

1567

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

1568

# unfilterable `string_values` is 50KB.

1569

#

1570

# Empty strings are not allowed.

Bu Sun Kim

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

[diff] [blame]

1571

"values": [ # Required. String values.

1572

"A String",

Bu Sun Kim

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

[diff] [blame]

1573

],

1574

},

Bu Sun Kim

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

[diff] [blame^]

1575

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

1576

# If false, values are not searchable.

1577

#

1578

# Default is false.

Bu Sun Kim

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

[diff] [blame]

1579

},

1580

},

Bu Sun Kim

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

[diff] [blame]

1581

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

1586

# the standard fields such as job_title, company_name, or

1587

# level. These custom fields store arbitrary

1588

# string values, and can be used for purposes not covered by

1589

# the structured fields. For the best search experience, use of the

1590

# structured rather than custom fields is recommended.

1591

#

1592

# Data stored in these custom fields fields are indexed and

1593

# searched against by keyword searches (see

1594

# SearchJobsRequest.custom_field_filters][]).

1595

#

1596

# The map key must be a number between 1-20. If an invalid key is

1597

# provided on job create or update, an error is returned.

1598

"a_key": { # Resource that represents the custom data not captured by the standard fields.

1599

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

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

1605

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

1606

#

1607

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

1608

# For more information, see

1609

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

1610

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

1611

#

1612

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

1613

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

1614

# defaults to 'en_US'.

1615

"visibility": "A String", # Optional. The visibility of the job.

1616

# Defaults to JobVisibility.PRIVATE if not specified.

1617

# Currently only JobVisibility.PRIVATE is supported.

1618

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

1619

#

1620

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

1621

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

1622

# requisition_id since this value is unique.

1623

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

Bu Sun Kim

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

[diff] [blame]

1624

# provided.

1625

#

1626

# A unique company identifier used by job distributors to identify an

Bu Sun Kim

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

[diff] [blame]

1627

# employer's company entity. company_name takes precedence over

Bu Sun Kim

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

[diff] [blame]

1628

# this field, and is the recommended field to use to identify companies.

1629

#

1630

# The maximum number of allowed characters is 255.

Bu Sun Kim

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

[diff] [blame]

1631

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

1632

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

1633

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

1634

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

1635

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

1636

#

1637

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

1638

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

1639

# value is the time the request arrives at the server.

1640

# and time zone are either specified elsewhere or are not significant. The date

1641

# is relative to the Proleptic Gregorian Calendar. This can represent:

1642

#

1643

# * A full date, with non-zero year, month and day values

1644

# * A month and day value, with a zero year, e.g. an anniversary

1645

# * A year on its own, with zero month and day values

1646

# * A year and month value, with a zero day, e.g. a credit card expiration date

1647

#

1648

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

1649

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

1650

# if specifying a year by itself or a year and month where the day is not

1651

# significant.

1652

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

1653

# a year.

1654

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

1655

# month and day.

1656

},

1657

"applicationUrls": [ # Optional but at least one of application_urls,

1658

# application_email_list or application_instruction must be

1659

# specified.

1660

#

1661

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

1662

# link to an online application form.

1663

#

1664

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

1665

"A String",

1666

],

1667

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

1668

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

1669

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

1670

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

1671

# to be created if there is another job with the same requisition_id,

1672

# company_name and language_code.

1673

#

1674

# The maximum number of allowed characters is 255.

1675

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

1676

# job. The use of this field is recommended

1677

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

1678

#

1679

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

1680

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

1681

#

1682

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

Bu Sun Kim

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

[diff] [blame^]

1683

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

Bu Sun Kim

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

[diff] [blame]

1684

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

1685

# is used for contracting engagements.

1686

# Dates prior to 1970/1/1 and invalid date formats are ignored.

1687

# and time zone are either specified elsewhere or are not significant. The date

1688

# is relative to the Proleptic Gregorian Calendar. This can represent:

1689

#

1690

# * A full date, with non-zero year, month and day values

1691

# * A month and day value, with a zero year, e.g. an anniversary

1692

# * A year on its own, with zero month and day values

1693

# * A year and month value, with a zero day, e.g. a credit card expiration date

1694

#

1695

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

1696

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

1697

# if specifying a year by itself or a year and month where the day is not

1698

# significant.

1699

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

1700

# a year.

1701

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

1702

# month and day.

1703

},

Bu Sun Kim

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

[diff] [blame]

1704

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

1705

"applicationInstruction": "A String", # Optional but at least one of application_urls,

1706

# application_email_list or application_instruction must be

1707

# specified.

1708

#

1709

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

1710

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

1711

#

1712

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

1713

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

1714

#

1715

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

1716

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

1717

"A String",

1718

],

1719

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

1720

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

1721

#

1722

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

1723

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

# full time or

# part time.

"A String",

],

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

1729

#

1730

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

1731

#

1732

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

1733

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

1734

#

1735

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

1736

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

1737

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

1738

# multiple jobs with the same requisition_id, company_name and

1739

# language_code are not allowed. If the original requisition_id must

1740

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

1741

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

1742

# for better search experience.

1743

#

1744

# The maximum number of allowed characters is 500.

1745

"A String",

1746

],

1747

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

1752

#

1753

# This field replaces compensation_info. Only

1754

# CompensationInfo.entries or extended_compensation_info can be set,

1755

# otherwise an exception is thrown.

1756

#

1757

# Describes job compensation.

1758

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

1759

# currency code.

1760

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

1761

#

1762

# Compensation range.

1763

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

1764

#

1765

# Decimal number.

1766

"micros": 42, # Micro (10^-6) units.

1767

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

1768

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

1769

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

1770

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

1771

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

1772

"units": "A String", # Whole units.

1773

},

1774

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

1775

#

1776

# Decimal number.

1777

"micros": 42, # Micro (10^-6) units.

1778

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

1779

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

1780

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

1781

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

1782

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

1783

"units": "A String", # Whole units.

1784

},

1785

},

1786

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

1787

#

1788

# At most one entry can be of type

1789

# ExtendedCompensationInfo.CompensationType.BASE, which is

1790

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

1791

{ # Deprecated. See CompensationInfo.

1792

#

1793

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

1794

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

1795

#

1796

# Annualization: One compensation entry can be annualized if

1797

# - it contains valid amount or range.

1798

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

1799

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

1800

# expected_units_per_year.

Bu Sun Kim

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

[diff] [blame^]

1801

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

1802

#

1803

# Decimal number.

1804

"micros": 42, # Micro (10^-6) units.

1805

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

1806

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

1807

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

1808

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

1809

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

1810

"units": "A String", # Whole units.

1811

},

1812

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

Bu Sun Kim

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

[diff] [blame]

1813

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

1814

#

1815

# Compensation range.

1816

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

1817

#

1818

# Decimal number.

1819

"micros": 42, # Micro (10^-6) units.

1820

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

1821

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

1822

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

1823

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

1824

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

1825

"units": "A String", # Whole units.

1826

},

1827

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

1828

#

1829

# Decimal number.

1830

"micros": 42, # Micro (10^-6) units.

1831

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

1832

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

1833

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

1834

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

1835

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

1836

"units": "A String", # Whole units.

1837

},

1838

},

1839

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

1840

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

1841

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

1850

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

1851

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

1852

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

1853

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

1854

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

1855

"units": "A String", # Whole units.

1856

},

1857

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

1858

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

1859

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

1860

#

1861

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

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

[diff] [blame]

1862

},

1863

],

1864

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

1865

# the job's all CompensationEntry cannot be annualized.

1866

# See CompensationEntry for explanation on annualization and base

1867

# compensation entry.

1868

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

1869

#

1870

# Compensation range.

1871

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

1872

#

1873

# Decimal number.

1874

"micros": 42, # Micro (10^-6) units.

1875

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

1876

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

1877

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

1878

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

1879

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

1880

"units": "A String", # Whole units.

1881

},

1882

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

1883

#

1884

# Decimal number.

1885

"micros": 42, # Micro (10^-6) units.

1886

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

1887

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

1888

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

1889

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

1890

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

1891

"units": "A String", # Whole units.

1892

},

1893

},

1894

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

1895

# the job's base compensation entry cannot be annualized.

1896

# See CompensationEntry for explanation on annualization and base

1897

# compensation entry.

1898

},

1899

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

1900

# provided.

1901

#

1902

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

1903

# /companies/foo. This field takes precedence over the

1904

# distributor-assigned company identifier, distributor_company_id.

1905

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

1906

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

1907

# provided on the job object for responsibilities,

1908

# qualifications, and other job characteristics. Use of

1909

# these separate job fields is recommended.

1910

#

1911

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

1912

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

1913

#

1914

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

1915

"applicationEmailList": [ # Optional but at least one of application_urls,

1916

# application_email_list or application_instruction must be

1917

# specified.

1918

#

1919

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

1920

# applications can be sent.

1921

#

1922

# The maximum number of allowed characters is 255.

1923

"A String",

1924

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1929

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

Bu Sun Kim

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

[diff] [blame]

1930

<pre>Deletes the specified job.

1931

1932

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

1933

up to 5 minutes.

1934

1935

Args:

Bu Sun Kim

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

[diff] [blame]

1936

name: string, Required. The resource name of the job to be deleted, such as "jobs/11111111". (required)

Bu Sun Kim

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

[diff] [blame]

1937

disableFastProcess: boolean, Deprecated. This field is not working anymore.

Optional.

If set to true, this call waits for all processing steps to complete

1942

before the job is cleaned up. Otherwise, the call returns while some

1943

steps are still taking place asynchronously, hence faster.

Bu Sun Kim

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

[diff] [blame]

1944

x__xgafv: string, V1 error format.

1945

Allowed values

1946

1 - v1 error format

1947

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

1948

1949

Returns:

1950

An object of the form:

1951

1952

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

1953

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

1954

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

1955

#

1956

# service Foo {

1957

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

1958

# }

1959

#

1960

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

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1965

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

Bu Sun Kim

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

[diff] [blame]

1966

<pre>Deprecated. Use BatchDeleteJobs instead.

1967

1968

Deletes the specified job by filter. You can specify whether to

1969

synchronously wait for validation, indexing, and general processing to be

1970

completed before the response is returned.

1971

1972

Args:

Dan O'Meara

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

[diff] [blame]

1973

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1974

The object takes the form of:

1975

1976

{ # Deprecated. Use BatchDeleteJobsRequest instead.

#

# Input only.

#

# Delete job by filter request.

1981

#

1982

# The job typically becomes unsearchable within 10 seconds, but it may take

1983

# up to 5 minutes.

Bu Sun Kim

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

[diff] [blame]

1984

"disableFastProcess": True or False, # Optional. If set to true, this call waits for all processing steps to complete

1985

# before the job is cleaned up. Otherwise, the call returns while some

1986

# steps are still taking place asynchronously, hence faster.

1987

"filter": { # Deprecated. Use BatchDeleteJobsRequest instead. # Required. Restrictions on the scope of the delete request.

Bu Sun Kim

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

[diff] [blame]

#

# Input only.

#

# Filter for jobs to be deleted.

Bu Sun Kim

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

[diff] [blame]

1992

"requisitionId": "A String", # Required. The requisition ID (or posting ID) assigned by the client to identify a

Bu Sun Kim

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

[diff] [blame]

1993

# job. This is intended for client identification and tracking of

1994

# listings.

1995

# name takes precedence over this field

1996

# The maximum number of allowed characters is 225.

1997

},

Bu Sun Kim

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

[diff] [blame]

1998

}

1999

2000

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2007

2008

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

2009

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

2010

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

2011

#

2012

# service Foo {

2013

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

2014

# }

2015

#

2016

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

}</pre>

</div>

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

2022

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

2023

within the last 90 days.

2024

2025

Args:

Bu Sun Kim

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

[diff] [blame]

2026

name: string, Required. The resource name of the job to retrieve, such as "jobs/11111111". (required)

Bu Sun Kim

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

[diff] [blame]

2027

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2034

Bu Sun Kim

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

[diff] [blame]

2035

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

2036

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

Bu Sun Kim

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

[diff] [blame]

2037

# entity responsible for the job.

Bu Sun Kim

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

[diff] [blame^]

2038

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

2039

#

2040

# The maximum number of allowed characters is 500.

Bu Sun Kim

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

[diff] [blame]

2041

"region": "A String", # Optional. The job Region (for example, state, country) throughout which the job

2042

# is available. If this field is set, a

2043

# LocationFilter in a search query within the job region

2044

# finds this job if an exact location match is not specified.

2045

# If this field is set, setting job locations

2046

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

2047

"referenceUrl": "A String", # Output only. The URL of a web page that displays job details.

2048

"companyTitle": "A String", # Deprecated. Use company_display_name instead.

Bu Sun Kim

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

[diff] [blame]

2049

#

Bu Sun Kim

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

[diff] [blame]

2050

# Output only.

Bu Sun Kim

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

[diff] [blame]

2051

#

Bu Sun Kim

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

[diff] [blame]

2052

# The name of the company listing the job.

Bu Sun Kim

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

[diff] [blame^]

2053

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

2054

# recommended as an alternative to using the more general description

2055

# field.

2056

#

2057

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

2058

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

2059

#

2060

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

Bu Sun Kim

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

[diff] [blame]

2061

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

Bu Sun Kim

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

[diff] [blame]

2062

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

2063

# all compensation entries' CompensationEntry.compensation times

2064

# CompensationEntry.expected_units_per_year.

2065

#

2066

# See CompensationEntry for explanation on compensation annualization.

Bu Sun Kim

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

[diff] [blame]

2067

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

2068

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

2069

# match the currency code of

2070

# min_compensation.

Bu Sun Kim

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

[diff] [blame^]

2071

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

2072

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

2073

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

Bu Sun Kim

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

[diff] [blame]

2074

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

2075

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

2076

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

2077

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

2078

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

2079

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

Bu Sun Kim

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

[diff] [blame^]

2080

},

2081

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

2082

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

2083

# currency code of max_compensation.

Bu Sun Kim

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

[diff] [blame]

2084

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

2085

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

2086

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

Bu Sun Kim

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

[diff] [blame^]

2087

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

2088

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

2089

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

2090

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

2091

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

2092

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

Bu Sun Kim

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

[diff] [blame]

2093

},

2094

},

2095

"min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# A lower bound on a range for compensation or pay for the job.

2100

# The currency type is specified in compensation_amount.

Bu Sun Kim

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

[diff] [blame^]

2101

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

2102

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

2103

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

Bu Sun Kim

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

[diff] [blame]

2104

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

2105

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

2106

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

2107

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

2108

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

2109

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

Bu Sun Kim

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

[diff] [blame]

2110

},

2111

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

Bu Sun Kim

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

[diff] [blame]

2112

#

2113

# At most one entry can be of type

2114

# CompensationInfo.CompensationType.BASE, which is

2115

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

2116

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

2117

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

2118

#

2119

# Annualization: One compensation entry can be annualized if

2120

# - it contains valid amount or range.

2121

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

2122

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

2123

# expected_units_per_year.

Bu Sun Kim

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

[diff] [blame]

2124

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

Bu Sun Kim

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

[diff] [blame]

2125

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

2126

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

Bu Sun Kim

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

[diff] [blame]

2132

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

2133

# indicate equity terms or provide additional context to an estimated

2134

# bonus.

2135

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

2136

#

2137

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

2138

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

Bu Sun Kim

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

[diff] [blame^]

2139

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

2140

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

2141

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

Bu Sun Kim

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

[diff] [blame]

2142

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

Bu Sun Kim

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

[diff] [blame]

2143

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

2144

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

2145

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

2146

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

2147

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

Bu Sun Kim

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

[diff] [blame]

2148

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2149

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2150

"range": { # Compensation range. # Optional. Compensation range.

2151

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2152

# to a maximal compensation value and the currency code is set to

2153

# match the currency code of

2154

# min_compensation.

2155

"units": "A String", # The whole units of the amount.

2156

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2157

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2158

"nanos": 42, # Number of nano (10^-9) units of the amount.

2159

# The value must be between -999,999,999 and +999,999,999 inclusive.

2160

# If `units` is positive, `nanos` must be positive or zero.

2161

# If `units` is zero, `nanos` can be positive, zero, or negative.

2162

# If `units` is negative, `nanos` must be negative or zero.

2163

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2164

},

2165

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2166

# to zero and the currency code is set to match the

2167

# currency code of max_compensation.

2168

"units": "A String", # The whole units of the amount.

2169

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2170

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2171

"nanos": 42, # Number of nano (10^-9) units of the amount.

2172

# The value must be between -999,999,999 and +999,999,999 inclusive.

2173

# If `units` is positive, `nanos` must be positive or zero.

2174

# If `units` is zero, `nanos` can be positive, zero, or negative.

2175

# If `units` is negative, `nanos` must be negative or zero.

2176

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2177

},

2178

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2179

},

2180

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2181

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

2182

# base compensation entry's CompensationEntry.compensation times

2183

# CompensationEntry.expected_units_per_year.

2184

#

2185

# See CompensationEntry for explanation on compensation annualization.

2186

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2187

# to a maximal compensation value and the currency code is set to

2188

# match the currency code of

2189

# min_compensation.

2190

"units": "A String", # The whole units of the amount.

2191

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2192

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2193

"nanos": 42, # Number of nano (10^-9) units of the amount.

2194

# The value must be between -999,999,999 and +999,999,999 inclusive.

2195

# If `units` is positive, `nanos` must be positive or zero.

2196

# If `units` is zero, `nanos` can be positive, zero, or negative.

2197

# If `units` is negative, `nanos` must be negative or zero.

2198

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2199

},

2200

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2201

# to zero and the currency code is set to match the

2202

# currency code of max_compensation.

2203

"units": "A String", # The whole units of the amount.

2204

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2205

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2206

"nanos": 42, # Number of nano (10^-9) units of the amount.

2207

# The value must be between -999,999,999 and +999,999,999 inclusive.

2208

# If `units` is positive, `nanos` must be positive or zero.

2209

# If `units` is zero, `nanos` can be positive, zero, or negative.

2210

# If `units` is negative, `nanos` must be negative or zero.

2211

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2212

},

2213

},

2214

"amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# The amount of compensation or pay for the job.

2219

# As an alternative, compensation_amount_min and

2220

# compensation_amount_max may be used to define a range of

2221

# compensation.

2222

"units": "A String", # The whole units of the amount.

2223

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2224

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2225

"nanos": 42, # Number of nano (10^-9) units of the amount.

2226

# The value must be between -999,999,999 and +999,999,999 inclusive.

2227

# If `units` is positive, `nanos` must be positive or zero.

2228

# If `units` is zero, `nanos` can be positive, zero, or negative.

2229

# If `units` is negative, `nanos` must be negative or zero.

2230

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2231

},

2232

"type": "A String", # Deprecated. Use entries instead.

#

# Optional.

#

# Type of job compensation.

2237

"max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# An upper bound on a range for compensation or pay for the job.

2242

# The currency type is specified in compensation_amount.

2243

"units": "A String", # The whole units of the amount.

2244

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2245

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2246

"nanos": 42, # Number of nano (10^-9) units of the amount.

2247

# The value must be between -999,999,999 and +999,999,999 inclusive.

2248

# If `units` is positive, `nanos` must be positive or zero.

2249

# If `units` is zero, `nanos` can be positive, zero, or negative.

2250

# If `units` is negative, `nanos` must be negative or zero.

2251

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2252

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2253

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2254

"expireTime": "A String", # Optional but strongly recommended for the best service

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2255

# experience.

2256

#

2257

# The expiration timestamp of the job. After this timestamp, the

2258

# job is marked as expired, and it no longer appears in search results. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2259

# expired job can't be deleted or listed by the DeleteJob and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2260

# ListJobs APIs, but it can be retrieved with the GetJob API or

2261

# updated with the UpdateJob API. An expired job can be updated and

2262

# opened again by using a future expiration timestamp. Updating an expired

2263

# job fails if there is another existing open job with same

2264

# requisition_id, company_name and language_code.

2265

#

2266

# The expired jobs are retained in our system for 90 days. However, the

2267

# overall expired job count cannot exceed 3 times the maximum of open jobs

2268

# count over the past week, otherwise jobs with earlier expire time are

2269

# cleaned first. Expired jobs are no longer accessible after they are cleaned

2270

# out.

2271

# The format of this field is RFC 3339 date strings. Example:

2272

# 2000-01-01T00:00:00.999999999Z

2273

# See

2274

# [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).

2275

#

2276

# A valid date range is between 1970-01-01T00:00:00.0Z and

2277

# 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire

2278

# time not provided.

2279

#

2280

# If this value is not provided at the time of job creation or is invalid,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2281

# the job posting expires after 30 days from the job's creation time. For

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2282

# example, if the job was created on 2017/01/01 13:00AM UTC with an

2283

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

2284

#

2285

# If this value is not provided but expiry_date is, expiry_date is

2286

# used.

2287

#

2288

# If this value is not provided on job update, it depends on the field masks

2289

# set by UpdateJobRequest.update_job_fields. If the field masks include

2290

# expiry_time, or the masks are empty meaning that every field is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2291

# updated, the job posting expires after 30 days from the job's last

2292

# update time. Otherwise the expiration date isn't updated.

2293

"updateTime": "A String", # Output only. The timestamp when this job was last updated.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2294

"department": "A String", # Optional. The department or functional area within the company with the open

2295

# position.

2296

#

2297

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2298

"jobLocations": [ # Output only. Structured locations of the job, resolved from locations.

2299

{ # Output only.

2300

#

2301

# A resource that represents a location with full geographic

2302

# information.

2303

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

2304

# such as postal delivery and payments addresses. Given a postal address,

2305

# a postal service can deliver items to a premises, P.O. Box, or other

2306

# delivery location.

2307

# Given a postal address, a postal service can deliver items to a premise, P.O.

2308

# Box or similar.

2309

# It is not intended to model geographical locations (roads, towns,

2310

# mountains).

2311

#

2312

# In typical usage an address would be created via user input or from importing

2313

# existing data, depending on the type of process.

2314

#

2315

# Advice on address input / editing:

2316

# - Use an i18n-ready address widget such as

2317

# https://github.com/google/libaddressinput)

2318

# - Users should not be presented with UI elements for input or editing of

2319

# fields outside countries where that field is used.

2320

#

2321

# For more guidance on how to use this schema, please see:

2322

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2323

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

2324

# Examples: US city, IT comune, UK post town.

2325

# In regions of the world where localities are not well defined or do not fit

2326

# into this structure well, leave locality empty and use address_lines.

2327

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

2328

# addresses of a country or region.

2329

# For example, this can be a state, a province, an oblast, or a prefecture.

2330

# Specifically, for Spain this is the province and not the autonomous

2331

# community (e.g. "Barcelona" and not "Catalonia").

2332

# Many countries don't use an administrative area in postal addresses. E.g.

2333

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2334

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2335

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

2336

#

2337

# Because values in address_lines do not have type information and may

2338

# sometimes contain multiple values in a single field (e.g.

2339

# "Austin, TX"), it is important that the line order is clear. The order of

2340

# address lines should be "envelope order" for the country/region of the

2341

# address. In places where this can vary (e.g. Japan), address_language is

2342

# used to make it explicit (e.g. "ja" for large-to-small ordering and

2343

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

2344

# an address can be selected based on the language.

2345

#

2346

# The minimum permitted structural representation of an address consists

2347

# of a region_code with all remaining information placed in the

2348

# address_lines. It would be possible to format such an address very

2349

# approximately without geocoding, but no semantic reasoning could be

2350

# made about any of the address components until it was at least

2351

# partially resolved.

2352

#

2353

# Creating an address only containing a region_code and address_lines, and

2354

# then geocoding is the recommended way to handle completely unstructured

2355

# addresses (as opposed to guessing which parts of the address should be

2356

# localities or administrative areas).

2357

"A String",

2358

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2359

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

2360

# is never inferred and it is up to the user to ensure the value is

2361

# correct. See http://cldr.unicode.org/ and

2362

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

2363

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2364

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

2365

# postal codes to be present, but where they are used, they may trigger

2366

# additional validation with other parts of the address (e.g. state/zip

2367

# validation in the U.S.A.).

2368

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

2369

# in most regions. Where it is used, the value is either a string like

2370

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

2371

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

2372

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

2373

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

2374

# known). This is often the UI language of the input form or is expected

2375

# to match one of the languages used in the address' country/region, or their

2376

# transliterated equivalents.

2377

# This can affect formatting in certain countries, but is not critical

2378

# to the correctness of the data and will never affect any validation or

2379

# other non-formatting related operations.

2380

#

2381

# If this value is not known, it should be omitted (rather than specifying a

2382

# possibly incorrect default).

2383

#

2384

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

2385

"recipients": [ # Optional. The recipient at the address.

2386

# This field may, under certain circumstances, contain multiline information.

2387

# For example, it might contain "care of" information.

2388

"A String",

2389

],

2390

"sublocality": "A String", # Optional. Sublocality of the address.

2391

# For example, this can be neighborhoods, boroughs, districts.

2392

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

2393

# the latest revision.

2394

#

2395

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2396

},

2397

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

2398

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

2399

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

2400

# LocationType#LOCALITY.

2401

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

2402

# location bounding box in which a circle with the specified radius

2403

# centered from LatLng coves the area associated with the job location.

2404

# For example, currently, "Mountain View, CA, USA" has a radius of

2405

# 7885.79 meters.

2406

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

2407

# of doubles representing degrees latitude and degrees longitude. Unless

2408

# specified otherwise, this must conform to the

2409

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

2410

# standard</a>. Values must be within normalized ranges.

2411

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

2412

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

2413

},

2414

},

2415

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2416

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

2421

# filterable_custom_fields. These fields are distinct in that the data

2422

# in these fields are not indexed. Therefore, the client cannot search

2423

# against them, nor can the client use them to list jobs.

2424

#

2425

# The key of the map can be any valid string.

2426

"a_key": { # Resource that represents the custom data not captured by the standard fields.

2427

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

2433

#

2434

# Optional but strongly recommended to be provided for the best service

2435

# experience.

2436

#

2437

# The expiration date of the job in UTC time. After 12 am on this date, the

2438

# job is marked as expired, and it no longer appears in search results.

2439

# The expired job can't be deleted or listed by the DeleteJob and

2440

# ListJobs APIs, but it can be retrieved with the GetJob API or

2441

# updated with the UpdateJob API. An expired job can be updated and

2442

# opened again by using a future expiration date. It can also remain expired.

2443

# Updating an expired job to be open fails if there is another existing open

2444

# job with same requisition_id, company_name and language_code.

2445

#

2446

# The expired jobs are retained in our system for 90 days. However, the

2447

# overall expired job count cannot exceed 3 times the maximum of open jobs

2448

# count over the past week, otherwise jobs with earlier expire time are

2449

# removed first. Expired jobs are no longer accessible after they are cleaned

2450

# out.

2451

#

2452

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

2453

# ignored and treated as expiry date not provided.

2454

#

2455

# If this value is not provided on job creation or is invalid, the job

2456

# posting expires after 30 days from the job's creation time. For example, if

2457

# the job was created on 2017/01/01 13:00AM UTC with an unspecified

2458

# expiration date, the job expires after 2017/01/31 13:00AM UTC.

2459

#

2460

# If this value is not provided on job update, it depends on the field masks

2461

# set by UpdateJobRequest.update_job_fields. If the field masks include

2462

# expiry_date, or the masks are empty meaning that every field is

2463

# updated, the job expires after 30 days from the job's last update time.

2464

# Otherwise the expiration date isn't updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2465

# and time zone are either specified elsewhere or are not significant. The date

2466

# is relative to the Proleptic Gregorian Calendar. This can represent:

2467

#

2468

# * A full date, with non-zero year, month and day values

2469

# * A month and day value, with a zero year, e.g. an anniversary

2470

# * A year on its own, with zero month and day values

2471

# * A year and month value, with a zero day, e.g. a credit card expiration date

2472

#

2473

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2474

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2475

# if specifying a year by itself or a year and month where the day is not

2476

# significant.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2477

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2478

# a year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2479

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

2480

# month and day.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2481

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2482

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

2483

# is used for contracting engagements.

2484

# Dates prior to 1970/1/1 and invalid date formats are ignored.

2485

# and time zone are either specified elsewhere or are not significant. The date

2486

# is relative to the Proleptic Gregorian Calendar. This can represent:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2487

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2488

# * A full date, with non-zero year, month and day values

2489

# * A month and day value, with a zero year, e.g. an anniversary

2490

# * A year on its own, with zero month and day values

2491

# * A year and month value, with a zero day, e.g. a credit card expiration date

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2492

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2493

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

2494

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

2495

# if specifying a year by itself or a year and month where the day is not

2496

# significant.

2497

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

2498

# a year.

2499

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

2500

# month and day.

2501

},

2502

"educationLevels": [ # Optional. The desired education level for the job, such as

2503

# "Bachelors", "Masters", "Doctorate".

2504

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2505

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2506

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2507

# attributes that are not covered by the provided structured fields.

2508

#

2509

# This field is a more general combination of the deprecated id-based

2510

# filterable_custom_fields and string-based

2511

# non_filterable_custom_fields.

2512

#

2513

# The keys of the map are strings up to 64 bytes and must match the

2514

# pattern: a-zA-Z*.

2515

#

2516

# At most 100 filterable and at most 100 unfilterable keys are supported.

2517

# For filterable `string_values`, across all keys at most 200 values are

2518

# allowed, with each string no more than 255 characters. For unfilterable

2519

# `string_values`, the maximum total size of `string_values` across all keys

2520

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2521

"a_key": { # Custom attribute values that are either filterable or non-filterable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2522

"longValue": "A String", # Optional but at least one of string_values or long_value must

2523

# be specified.

2524

#

2525

# This field is used to perform number range search.

2526

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For

2527

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

2528

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2529

# be specified.

2530

#

2531

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

2532

# `CASE_INSENSITIVE_MATCH`) search.

2533

# For filterable `string_values`, a maximum total number of 200 values

2534

# is allowed, with each `string_value` has a byte size of no more than

2535

# 255B. For unfilterable `string_values`, the maximum total byte size of

2536

# unfilterable `string_values` is 50KB.

2537

#

2538

# Empty strings are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2539

"values": [ # Required. String values.

2540

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2541

],

2542

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2543

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

2544

# If false, values are not searchable.

2545

#

2546

# Default is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2547

},

2548

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2549

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

2554

# the standard fields such as job_title, company_name, or

2555

# level. These custom fields store arbitrary

2556

# string values, and can be used for purposes not covered by

2557

# the structured fields. For the best search experience, use of the

2558

# structured rather than custom fields is recommended.

2559

#

2560

# Data stored in these custom fields fields are indexed and

2561

# searched against by keyword searches (see

2562

# SearchJobsRequest.custom_field_filters][]).

2563

#

2564

# The map key must be a number between 1-20. If an invalid key is

2565

# provided on job create or update, an error is returned.

2566

"a_key": { # Resource that represents the custom data not captured by the standard fields.

2567

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

2573

# any requirements for fluency that are associated with the job.

2574

#

2575

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

2576

# For more information, see

2577

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

2578

# class="external" target="_blank" }.

2579

#

2580

# If this field is unspecified and Job.description is present, detected

2581

# language code based on Job.description is assigned, otherwise

2582

# defaults to 'en_US'.

2583

"visibility": "A String", # Optional. The visibility of the job.

2584

# Defaults to JobVisibility.PRIVATE if not specified.

2585

# Currently only JobVisibility.PRIVATE is supported.

2586

"name": "A String", # Required during job update.

2587

#

2588

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

2589

# of this field in job queries and API calls is preferred over the use of

2590

# requisition_id since this value is unique.

2591

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2592

# provided.

2593

#

2594

# A unique company identifier used by job distributors to identify an

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2595

# employer's company entity. company_name takes precedence over

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2596

# this field, and is the recommended field to use to identify companies.

2597

#

2598

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2599

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

2600

# The value determines the sort order of the jobs returned when searching for

2601

# jobs using the featured jobs search call, with higher promotional values

2602

# being returned first and ties being resolved by relevance sort. Only the

2603

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

2604

#

2605

# Default value is 0, and negative values are treated as 0.

2606

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

2607

# value is the time the request arrives at the server.

2608

# and time zone are either specified elsewhere or are not significant. The date

2609

# is relative to the Proleptic Gregorian Calendar. This can represent:

2610

#

2611

# * A full date, with non-zero year, month and day values

2612

# * A month and day value, with a zero year, e.g. an anniversary

2613

# * A year on its own, with zero month and day values

2614

# * A year and month value, with a zero day, e.g. a credit card expiration date

2615

#

2616

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

2617

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

2618

# if specifying a year by itself or a year and month where the day is not

2619

# significant.

2620

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

2621

# a year.

2622

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

2623

# month and day.

2624

},

2625

"applicationUrls": [ # Optional but at least one of application_urls,

2626

# application_email_list or application_instruction must be

2627

# specified.

2628

#

2629

# Use this URL field to direct an applicant to a website, for example to

2630

# link to an online application form.

2631

#

2632

# The maximum number of allowed characters is 2,000.

2633

"A String",

2634

],

2635

"companyDisplayName": "A String", # Output only. The name of the company listing the job.

2636

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

2637

# client to identify a job. This field is intended to be used by clients

2638

# for client identification and tracking of listings. A job is not allowed

2639

# to be created if there is another job with the same requisition_id,

2640

# company_name and language_code.

2641

#

2642

# The maximum number of allowed characters is 255.

2643

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

2644

# job. The use of this field is recommended

2645

# as an alternative to using the more general description field.

2646

#

2647

# This field accepts and sanitizes HTML input, and also accepts

2648

# bold, italic, ordered list, and unordered list markup tags.

2649

#

2650

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2651

"createTime": "A String", # Output only. The timestamp when this job was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2652

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

2653

# is used for contracting engagements.

2654

# Dates prior to 1970/1/1 and invalid date formats are ignored.

2655

# and time zone are either specified elsewhere or are not significant. The date

2656

# is relative to the Proleptic Gregorian Calendar. This can represent:

2657

#

2658

# * A full date, with non-zero year, month and day values

2659

# * A month and day value, with a zero year, e.g. an anniversary

2660

# * A year on its own, with zero month and day values

2661

# * A year and month value, with a zero day, e.g. a credit card expiration date

2662

#

2663

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

2664

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

2665

# if specifying a year by itself or a year and month where the day is not

2666

# significant.

2667

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

2668

# a year.

2669

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

2670

# month and day.

2671

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2672

"level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

2673

"applicationInstruction": "A String", # Optional but at least one of application_urls,

2674

# application_email_list or application_instruction must be

2675

# specified.

2676

#

2677

# Use this field to provide instructions, such as "Mail your application

2678

# to ...", that a candidate can follow to apply for the job.

2679

#

2680

# This field accepts and sanitizes HTML input, and also accepts

2681

# bold, italic, ordered list, and unordered list markup tags.

2682

#

2683

# The maximum number of allowed characters is 3,000.

2684

"benefits": [ # Optional. The benefits included with the job.

2685

"A String",

2686

],

2687

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

2688

# incentives associated with the job not including salary or pay.

2689

#

2690

# The maximum number of allowed characters is 10,000.

2691

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"locations": [ # Optional but strongly recommended for the best service experience.

2697

#

2698

# Location(s) where the emploeyer is looking to hire for this job posting.

2699

#

2700

# Specifying the full street address(es) of the hiring location enables

2701

# better API results, especially job searches by commute time.

2702

#

2703

# At most 50 locations are allowed for best search performance. If a job has

2704

# more locations, it is suggested to split it into multiple jobs with unique

2705

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

2706

# multiple jobs with the same requisition_id, company_name and

2707

# language_code are not allowed. If the original requisition_id must

2708

# be preserved, a custom field should be used for storage. It is also

2709

# suggested to group the locations that close to each other in the same job

2710

# for better search experience.

2711

#

2712

# The maximum number of allowed characters is 500.

2713

"A String",

2714

],

2715

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

2720

#

2721

# This field replaces compensation_info. Only

2722

# CompensationInfo.entries or extended_compensation_info can be set,

2723

# otherwise an exception is thrown.

2724

#

2725

# Describes job compensation.

2726

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

2727

# currency code.

2728

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

2729

#

2730

# Compensation range.

2731

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

2732

#

2733

# Decimal number.

2734

"micros": 42, # Micro (10^-6) units.

2735

# The value must be between -999,999 and +999,999 inclusive.

2736

# If `units` is positive, `micros` must be positive or zero.

2737

# If `units` is zero, `micros` can be positive, zero, or negative.

2738

# If `units` is negative, `micros` must be negative or zero.

2739

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2740

"units": "A String", # Whole units.

2741

},

2742

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

2743

#

2744

# Decimal number.

2745

"micros": 42, # Micro (10^-6) units.

2746

# The value must be between -999,999 and +999,999 inclusive.

2747

# If `units` is positive, `micros` must be positive or zero.

2748

# If `units` is zero, `micros` can be positive, zero, or negative.

2749

# If `units` is negative, `micros` must be negative or zero.

2750

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2751

"units": "A String", # Whole units.

2752

},

2753

},

2754

"entries": [ # Optional. Job compensation information.

2755

#

2756

# At most one entry can be of type

2757

# ExtendedCompensationInfo.CompensationType.BASE, which is

2758

# referred as ** base compensation entry ** for the job.

2759

{ # Deprecated. See CompensationInfo.

2760

#

2761

# A compensation entry that represents one component of compensation, such

2762

# as base pay, bonus, or other compensation type.

2763

#

2764

# Annualization: One compensation entry can be annualized if

2765

# - it contains valid amount or range.

2766

# - and its expected_units_per_year is set or can be derived.

2767

# Its annualized range is determined as (amount or range) times

2768

# expected_units_per_year.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2769

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

2770

#

2771

# Decimal number.

2772

"micros": 42, # Micro (10^-6) units.

2773

# The value must be between -999,999 and +999,999 inclusive.

2774

# If `units` is positive, `micros` must be positive or zero.

2775

# If `units` is zero, `micros` can be positive, zero, or negative.

2776

# If `units` is negative, `micros` must be negative or zero.

2777

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2778

"units": "A String", # Whole units.

2779

},

2780

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2781

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

2782

#

2783

# Compensation range.

2784

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

2785

#

2786

# Decimal number.

2787

"micros": 42, # Micro (10^-6) units.

2788

# The value must be between -999,999 and +999,999 inclusive.

2789

# If `units` is positive, `micros` must be positive or zero.

2790

# If `units` is zero, `micros` can be positive, zero, or negative.

2791

# If `units` is negative, `micros` must be negative or zero.

2792

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2793

"units": "A String", # Whole units.

2794

},

2795

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

2796

#

2797

# Decimal number.

2798

"micros": 42, # Micro (10^-6) units.

2799

# The value must be between -999,999 and +999,999 inclusive.

2800

# If `units` is positive, `micros` must be positive or zero.

2801

# If `units` is zero, `micros` can be positive, zero, or negative.

2802

# If `units` is negative, `micros` must be negative or zero.

2803

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2804

"units": "A String", # Whole units.

2805

},

2806

},

2807

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

2808

# Job.employment_types is FULLTIME, a default value is inferred

2809

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

2818

# The value must be between -999,999 and +999,999 inclusive.

2819

# If `units` is positive, `micros` must be positive or zero.

2820

# If `units` is zero, `micros` can be positive, zero, or negative.

2821

# If `units` is negative, `micros` must be negative or zero.

2822

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2823

"units": "A String", # Whole units.

2824

},

2825

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

2826

"description": "A String", # Optional. Compensation description.

2827

"unit": "A String", # Optional. Frequency of the specified amount.

2828

#

2829

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2830

},

2831

],

2832

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

2833

# the job's all CompensationEntry cannot be annualized.

2834

# See CompensationEntry for explanation on annualization and base

2835

# compensation entry.

2836

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

2837

#

2838

# Compensation range.

2839

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

2840

#

2841

# Decimal number.

2842

"micros": 42, # Micro (10^-6) units.

2843

# The value must be between -999,999 and +999,999 inclusive.

2844

# If `units` is positive, `micros` must be positive or zero.

2845

# If `units` is zero, `micros` can be positive, zero, or negative.

2846

# If `units` is negative, `micros` must be negative or zero.

2847

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2848

"units": "A String", # Whole units.

2849

},

2850

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

2851

#

2852

# Decimal number.

2853

"micros": 42, # Micro (10^-6) units.

2854

# The value must be between -999,999 and +999,999 inclusive.

2855

# If `units` is positive, `micros` must be positive or zero.

2856

# If `units` is zero, `micros` can be positive, zero, or negative.

2857

# If `units` is negative, `micros` must be negative or zero.

2858

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

2859

"units": "A String", # Whole units.

2860

},

2861

},

2862

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

2863

# the job's base compensation entry cannot be annualized.

2864

# See CompensationEntry for explanation on annualization and base

2865

# compensation entry.

2866

},

2867

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

2868

# provided.

2869

#

2870

# The resource name of the company listing the job, such as

2871

# /companies/foo. This field takes precedence over the

2872

# distributor-assigned company identifier, distributor_company_id.

2873

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

2874

# description of the company and related information. Separate fields are

2875

# provided on the job object for responsibilities,

2876

# qualifications, and other job characteristics. Use of

2877

# these separate job fields is recommended.

2878

#

2879

# This field accepts and sanitizes HTML input, and also accepts

2880

# bold, italic, ordered list, and unordered list markup tags.

2881

#

2882

# The maximum number of allowed characters is 100,000.

2883

"applicationEmailList": [ # Optional but at least one of application_urls,

2884

# application_email_list or application_instruction must be

2885

# specified.

2886

#

2887

# Use this field to specify email address(es) to which resumes or

2888

# applications can be sent.

2889

#

2890

# The maximum number of allowed characters is 255.

2891

"A String",

2892

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2897

<code class="details" id="histogram">histogram(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2898

<pre>Deprecated. Use SearchJobsRequest.histogram_facets instead to make

2899

a single call with both search and histogram.

2900

2901

Retrieves a histogram for the given

2902

GetHistogramRequest. This call provides a structured

2903

count of jobs that match against the search query, grouped by specified

2904

facets.

2905

2906

This call constrains the visibility of jobs

2907

present in the database, and only counts jobs the caller has

2908

permission to search against.

2909

2910

For example, use this call to generate the

2911

number of jobs in the U.S. by state.

2912

2913

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2914

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2915

The object takes the form of:

2916

2917

{ # Deprecated. Use SearchJobsRequest.histogram_facets instead to make

2918

# a single call with both search and histogram.

#

# Input only.

#

# A request for the `GetHistogram` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2923

"query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2924

#

2925

# The query required to perform a search query or histogram.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2926

"query": "A String", # Optional. The query string that matches against the job title, description, and

2927

# location fields.

2928

#

2929

# The maximum query size is 255 bytes.

2930

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

2931

# Job.compensation_info. For example, if the filter is specified

2932

# as "Hourly job with per-hour compensation > $15", only jobs meeting

2933

# these criteria are searched. If a filter isn't defined, all open jobs

2934

# are searched.

2935

#

2936

# Filter on job compensation type and amount.

2937

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

2938

"units": [ # Required. Specify desired `base compensation entry's`

2939

# CompensationInfo.CompensationUnit.

2940

"A String",

2941

],

2942

"range": { # Compensation range. # Optional. Compensation range.

2943

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

2944

# to a maximal compensation value and the currency code is set to

2945

# match the currency code of

2946

# min_compensation.

2947

"units": "A String", # The whole units of the amount.

2948

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2949

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2950

"nanos": 42, # Number of nano (10^-9) units of the amount.

2951

# The value must be between -999,999,999 and +999,999,999 inclusive.

2952

# If `units` is positive, `nanos` must be positive or zero.

2953

# If `units` is zero, `nanos` can be positive, zero, or negative.

2954

# If `units` is negative, `nanos` must be negative or zero.

2955

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2956

},

2957

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

2958

# to zero and the currency code is set to match the

2959

# currency code of max_compensation.

2960

"units": "A String", # The whole units of the amount.

2961

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2962

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2963

"nanos": 42, # Number of nano (10^-9) units of the amount.

2964

# The value must be between -999,999,999 and +999,999,999 inclusive.

2965

# If `units` is positive, `nanos` must be positive or zero.

2966

# If `units` is zero, `nanos` can be positive, zero, or negative.

2967

# If `units` is negative, `nanos` must be negative or zero.

2968

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2969

},

2970

},

2971

"type": "A String", # Required. Type of filter.

2972

},

2973

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

2974

# service attempts to correct a misspelled query,

2975

# for example, "enginee" is corrected to "engineer".

2976

#

2977

# Defaults to false: a spell check is performed.

2978

"companyDisplayNames": [ # Optional. This filter specifies the exact company display

2979

# name of the jobs to search against.

2980

#

2981

# If a value isn't specified, jobs within the search results are

2982

# associated with any company.

2983

#

2984

# If multiple values are specified, jobs within the search results may be

2985

# associated with any of the specified companies.

2986

#

2987

# At most 20 company display name filters are allowed.

2988

"A String",

2989

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2990

"companyNames": [ # Optional. This filter specifies the company entities to search against.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2991

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2992

# If a value isn't specified, jobs are searched for against all

2993

# companies.

2994

#

2995

# If multiple values are specified, jobs are searched against the

2996

# companies specified.

2997

#

2998

# At most 20 company filters are allowed.

2999

"A String",

3000

],

3001

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

3002

# search against, such as EmploymentType.FULL_TIME.

3003

#

3004

# If a value is not specified, jobs in the search results include any

3005

# employment type.

3006

#

3007

# If multiple values are specified, jobs in the search results include

3008

# any of the specified employment types.

3009

"A String",

3010

],

3011

"categories": [ # Optional. The category filter specifies the categories of jobs to search against.

3012

# See Category for more information.

3013

#

3014

# If a value is not specified, jobs from any category are searched against.

3015

#

3016

# If multiple values are specified, jobs from any of the specified

3017

# categories are searched against.

3018

"A String",

3019

],

3020

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3021

# Job.custom_attributes marked as `filterable`.

3022

#

3023

# The syntax for this expression is a subset of Google SQL syntax.

3024

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3025

# Supported operators are: =, !=, <, <=, >, >= where the left of the operator

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3026

# is a custom field key and the right of the operator is a number or string

3027

# (surrounded by quotes) value.

3028

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3029

# Supported functions are LOWER(<field_name>) to

3030

# perform case insensitive match and EMPTY(<field_name>) to filter on the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3031

# existence of a key.

3032

#

3033

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3034

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3035

# comparisons/functions are allowed in the expression. The expression

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3036

# must be < 2000 characters in length.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3037

#

3038

# Sample Query:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3039

# (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100

3040

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3041

# search against. See LocationFilter for more information.

3042

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3043

# If a location value isn't specified, jobs fitting the other search

3044

# criteria are retrieved regardless of where they're located.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3045

#

3046

# If multiple values are specified, jobs are retrieved from any of the

3047

# specified locations. If different values are specified for the

3048

# LocationFilter.distance_in_miles parameter, the maximum provided

3049

# distance is used for all locations.

3050

#

3051

# At most 5 location filters are allowed.

3052

{ # Input only.

3053

#

3054

# Geographic region of the search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3055

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used

3056

# to address ambiguity of the user-input location, e.g. "Liverpool"

3057

# against "Liverpool, NY, US" or "Liverpool, UK".

3058

#

3059

# Set this field if all the jobs to search against are from a same region,

3060

# or jobs are world-wide but the job seeker is from a specific region.

3061

#

3062

# See http://cldr.unicode.org/ and

3063

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3064

# for details. Example: "CH" for Switzerland.

3065

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

3066

# identified as a city or smaller. When the location being searched for is a

3067

# state or larger, this field is ignored.

3068

"isTelecommute": True or False, # Optional. Allows the client to return jobs without a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3069

# set location, specifically, telecommuting jobs (telecomuting is considered

3070

# by the service as a special location.

3071

# Job.allow_telecommute indicates if a job permits telecommuting.

3072

# If this field is true, telecommuting jobs are searched, and

3073

# name and lat_lng are

3074

# ignored.

3075

# This filter can be used by itself to search exclusively for telecommuting

3076

# jobs, or it can be combined with another location

3077

# filter to search for a combination of job locations,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3078

# such as "Mountain View" or "telecommuting" jobs. However, when used in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3079

# combination with other location filters, telecommuting jobs can be

3080

# treated as less relevant than other jobs in the search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3081

"name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

3082

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3083

# search. This field is ignored if `location_name` is provided.

3084

# of doubles representing degrees latitude and degrees longitude. Unless

3085

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3086

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3087

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3088

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3089

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3090

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3091

},

3092

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3093

"publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched

3094

# against, for example, DateRange.PAST_MONTH. If a value isn't

3095

# specified, all open jobs are searched against regardless of their

3096

# published date.

3097

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for

3098

# example, driving or public transit). Note: This only works with COMMUTE

3099

# MODE. When specified, [JobQuery.location_filters] is

3100

# ignored.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3101

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3102

# Currently we don't support sorting by commute time.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3103

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3104

# Parameters needed for commute search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3105

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

3106

# commute time.

3107

# of doubles representing degrees latitude and degrees longitude. Unless

3108

# specified otherwise, this must conform to the

3109

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3110

# standard</a>. Values must be within normalized ranges.

3111

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3112

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3113

},

3114

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

3115

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

3116

# Must not be present if departure_hour_local is specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3117

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

3118

# integer between 0 and 23, representing the hour in the time zone of the

3119

# start_location. Must not be present if road_traffic is specified.

3120

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

3121

# For city level addresses, the city center is used. For state and coarser

3122

# level addresses, text matching is used.

3123

# If this field is set to `false` or is not specified, only jobs that include

3124

# street level addresses will be returned by commute search.

3125

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

3126

# (one hour). Format is `123s`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3127

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3128

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

3129

# for example, "en-US".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3130

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3131

# If a value isn't specified, the search results can contain jobs in any

3132

# locale.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3133

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3134

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3135

# Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".

3136

# For more information, see

3137

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3138

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3139

# At most 10 language code filters are allowed.

3140

"A String",

3141

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3142

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3143

"filters": { # Input only. # Deprecated. Use query instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# Optional.

#

# Restrictions on the scope of the histogram.

3148

#

3149

# Deprecated. Use JobQuery instead.

3150

#

3151

# The filters required to perform a search query or histogram.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3152

"categories": [ # Optional. The category filter specifies the categories of jobs to search against.

3153

# See Category for more information.

3154

#

3155

# If a value is not specified, jobs from any category are searched against.

3156

#

3157

# If multiple values are specified, jobs from any of the specified

3158

# categories are searched against.

3159

"A String",

3160

],

3161

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

3162

# Job.custom_attributes that are marked as `filterable`.

3163

#

3164

# The syntax for this expression is a subset of Google SQL syntax.

3165

#

3166

# Supported operators are: =, !=, <, <=, >, >= where the left of the operator

3167

# is a custom field key and the right of the operator is a number or string

3168

# (surrounded by quotes) value.

3169

#

3170

# Supported functions are LOWER(<field_name>) to

3171

# perform case insensitive match and EMPTY(<field_name>) to filter on the

3172

# existence of a key.

3173

#

3174

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

3175

# nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can

3176

# be a maximum of 100 comparisons/functions in the expression. The expression

3177

# must be < 3000 bytes in length.

3178

#

3179

# Sample Query:

3180

# (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3181

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3182

# search against. See LocationFilter for more information.

3183

#

3184

# If a location value is not specified, jobs are retrieved

3185

# from all locations.

3186

#

3187

# If multiple values are specified, jobs are retrieved from any of the

3188

# specified locations. If different values are specified for the

3189

# LocationFilter.distance_in_miles parameter, the maximum provided

3190

# distance is used for all locations.

3191

#

3192

# At most 5 location filters are allowed.

3193

{ # Input only.

3194

#

3195

# Geographic region of the search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3196

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used

3197

# to address ambiguity of the user-input location, e.g. "Liverpool"

3198

# against "Liverpool, NY, US" or "Liverpool, UK".

3199

#

3200

# Set this field if all the jobs to search against are from a same region,

3201

# or jobs are world-wide but the job seeker is from a specific region.

3202

#

3203

# See http://cldr.unicode.org/ and

3204

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3205

# for details. Example: "CH" for Switzerland.

3206

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

3207

# identified as a city or smaller. When the location being searched for is a

3208

# state or larger, this field is ignored.

3209

"isTelecommute": True or False, # Optional. Allows the client to return jobs without a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3210

# set location, specifically, telecommuting jobs (telecomuting is considered

3211

# by the service as a special location.

3212

# Job.allow_telecommute indicates if a job permits telecommuting.

3213

# If this field is true, telecommuting jobs are searched, and

3214

# name and lat_lng are

3215

# ignored.

3216

# This filter can be used by itself to search exclusively for telecommuting

3217

# jobs, or it can be combined with another location

3218

# filter to search for a combination of job locations,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3219

# such as "Mountain View" or "telecommuting" jobs. However, when used in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3220

# combination with other location filters, telecommuting jobs can be

3221

# treated as less relevant than other jobs in the search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3222

"name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

3223

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3224

# search. This field is ignored if `location_name` is provided.

3225

# of doubles representing degrees latitude and degrees longitude. Unless

3226

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3227

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3228

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3229

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3230

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3231

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3232

},

3233

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3234

"publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched

3235

# against, for example, DateRange.PAST_MONTH. If a value is not

3236

# specified, all open jobs are searched against regardless of the

3237

# date they were published.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3238

"companyTitles": [ # Optional. This filter specifies the exact company titles

3239

# of jobs to search against.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3240

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3241

# If a value is not specified, jobs within the search results can be

3242

# associated with any company.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3243

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3244

# If multiple values are specified, jobs within the search results may be

3245

# associated with any of the specified companies.

3246

#

3247

# At most 20 company title filters are allowed.

3248

"A String",

3249

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3250

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

3251

# for example, "en-US".

3252

#

3253

# If a value is not specified, the search results may contain jobs in any

# locale.

#

#

# Language codes should be in BCP-47 format, for example, "en-US" or

3258

# "sr-Latn". For more information, see [Tags for Identifying

3259

# Languages](https://tools.ietf.org/html/bcp47).

3260

#

3261

# At most 10 language code filters are allowed.

3262

"A String",

3263

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3264

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g.

3265

# driving or public transit). Note: this only works with COMMUTE

3266

# MODE. When specified, [JobFilters.location_filters] will be

3267

# ignored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3268

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3269

# Currently we do not support sorting by commute time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3270

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3271

# Parameters needed for commute search.

3272

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

3273

# commute time.

3274

# of doubles representing degrees latitude and degrees longitude. Unless

3275

# specified otherwise, this must conform to the

3276

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3277

# standard</a>. Values must be within normalized ranges.

3278

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3279

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3280

},

3281

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

3282

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

3283

# Must not be present if departure_hour_local is specified.

3284

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

3285

# integer between 0 and 23, representing the hour in the time zone of the

3286

# start_location. Must not be present if road_traffic is specified.

3287

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

3288

# For city level addresses, the city center is used. For state and coarser

3289

# level addresses, text matching is used.

3290

# If this field is set to `false` or is not specified, only jobs that include

3291

# street level addresses will be returned by commute search.

3292

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

3293

# (one hour). Format is `123s`.

3294

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3295

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3296

# Job.compensation_info. For example, if the filter is specified

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3297

# as "Hourly job with per-hour compensation > $15", only jobs that meet

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3298

# this criteria are searched. If a filter is not defined, all open jobs

3299

# are searched.

3300

#

3301

# Filter on job compensation type and amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3302

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

3303

"units": [ # Required. Specify desired `base compensation entry's`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3304

# CompensationInfo.CompensationUnit.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3305

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3306

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3307

"range": { # Compensation range. # Optional. Compensation range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3308

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3309

# to a maximal compensation value and the currency code is set to

3310

# match the currency code of

3311

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3312

"units": "A String", # The whole units of the amount.

3313

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3314

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3315

"nanos": 42, # Number of nano (10^-9) units of the amount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3316

# The value must be between -999,999,999 and +999,999,999 inclusive.

3317

# If `units` is positive, `nanos` must be positive or zero.

3318

# If `units` is zero, `nanos` can be positive, zero, or negative.

3319

# If `units` is negative, `nanos` must be negative or zero.

3320

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3321

},

3322

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3323

# to zero and the currency code is set to match the

3324

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3325

"units": "A String", # The whole units of the amount.

3326

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3327

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3328

"nanos": 42, # Number of nano (10^-9) units of the amount.

3329

# The value must be between -999,999,999 and +999,999,999 inclusive.

3330

# If `units` is positive, `nanos` must be positive or zero.

3331

# If `units` is zero, `nanos` can be positive, zero, or negative.

3332

# If `units` is negative, `nanos` must be negative or zero.

3333

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3334

},

3335

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3336

"type": "A String", # Required. Type of filter.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3337

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3338

"query": "A String", # Optional. The query filter contains the keywords that match against the job

3339

# title, description, and location fields.

3340

#

3341

# The maximum query size is 255 bytes/characters.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3342

"customFieldFilters": { # Deprecated. Use custom_attribute_filter instead.

#

# Optional.

#

# This filter specifies searching against

3347

# custom field values. See Job.filterable_custom_fields for information.

3348

# The key value specifies a number between 1-20 (the service

3349

# supports 20 custom fields) corresponding to the desired custom field map

3350

# value. If an invalid key is provided or specified together with

3351

# custom_attribute_filter, an error is thrown.

3352

"a_key": { # Input only.

3353

#

3354

# Custom field filter of the search.

3355

"type": "A String", # Optional. The type of filter.

3356

# Defaults to FilterType.OR.

3357

"queries": [ # Required. The query strings for the filter.

"A String",

],

},

},

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

3363

# service attempts to correct a misspelled query,

3364

# for example, "enginee" is corrected to "engineer".

3365

#

3366

# Defaults to false: a spell check is performed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3367

"extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter.

#

# Optional.

#

# This search filter is applied only to

3372

# Job.extended_compensation_info. For example, if the filter is specified

3373

# as "Hourly job with per-hour compensation > $15", only jobs that meet

3374

# these criteria are searched. If a filter is not defined, all open jobs

# are searched.

#

# Input only.

#

# Filter on job compensation type and amount.

3380

"includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

3381

"compensationUnits": [ # Required. Specify desired `base compensation entry's`

3382

# ExtendedCompensationInfo.CompensationUnit.

3383

"A String",

3384

],

3385

"type": "A String", # Required. Type of filter.

3386

"currency": "A String", # Optional. Specify currency in 3-letter

3387

# [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If

3388

# unspecified, jobs are returned regardless of currency.

3389

"compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

3390

#

3391

# Compensation range.

3392

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

3393

#

3394

# Decimal number.

3395

"micros": 42, # Micro (10^-6) units.

3396

# The value must be between -999,999 and +999,999 inclusive.

3397

# If `units` is positive, `micros` must be positive or zero.

3398

# If `units` is zero, `micros` can be positive, zero, or negative.

3399

# If `units` is negative, `micros` must be negative or zero.

3400

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

3401

"units": "A String", # Whole units.

3402

},

3403

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

3404

#

3405

# Decimal number.

3406

"micros": 42, # Micro (10^-6) units.

3407

# The value must be between -999,999 and +999,999 inclusive.

3408

# If `units` is positive, `micros` must be positive or zero.

3409

# If `units` is zero, `micros` can be positive, zero, or negative.

3410

# If `units` is negative, `micros` must be negative or zero.

3411

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

3412

"units": "A String", # Whole units.

3413

},

3414

},

3415

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3416

"companyNames": [ # Optional. The company names filter specifies the company entities to search

3417

# against.

3418

#

3419

# If a value is not specified, jobs are searched for against all companies.

3420

#

3421

# If multiple values are specified, jobs are searched against the

3422

# specified companies.

3423

#

3424

# At most 20 company filters are allowed.

3425

"A String",

3426

],

3427

"tenantJobOnly": True or False, # Deprecated. Do not use this field.

3428

#

3429

# This flag controls whether the job search should be restricted to jobs

3430

# owned by the current user.

3431

#

3432

# Defaults to false where all jobs accessible to the

3433

# user are searched against.

3434

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

3435

# search against, such as EmploymentType.FULL_TIME.

3436

#

3437

# If a value is not specified, jobs in the search results include any

3438

# employment type.

3439

#

3440

# If multiple values are specified, jobs in the search results include any

3441

# of the specified employment types.

3442

"A String",

3443

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3444

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3445

"allowBroadening": True or False, # Optional. Controls whether to broaden the search to avoid too few results for a

3446

# given query in instances where a search has sparse results. Results from a

3447

# broadened query is a superset of the results from the original query.

3448

#

3449

# Defaults to false.

3450

"requestMetadata": { # Input only. # Meta information, such as `user_id`, collected from the job searcher or

3451

# other entity conducting a job search, is used to improve the service's

3452

# search quality. Users determine identifier values, which must be

3453

# unique and consist.

3454

#

3455

# Meta information related to the job searcher or entity

3456

# conducting the job search. This information is used to improve the

3457

# performance of the service.

3458

"sessionId": "A String", # Required. A unique session identification string. A session is defined as the

3459

# duration of an end user's interaction with the service over a period.

3460

# Obfuscate this field for privacy concerns before

3461

# providing it to the API.

3462

#

3463

# If this field is not available for some reason, please send "UNKNOWN". Note

3464

# that any improvements to the service model for a particular tenant site,

3465

# rely on this field being set correctly to some unique session_id.

3466

"domain": "A String", # Required. The client-defined scope or source of the service call, which typically

3467

# is the domain on

3468

# which the service has been implemented and is currently being run.

3469

#

3470

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

3471

# job board www.foo.com and career site www.bar.com, then this field is

3472

# set to "foo.com" for use on the job board, and "bar.com" for use on the

3473

# career site.

3474

#

3475

# If this field is not available for some reason, send "UNKNOWN". Note that

3476

# any improvements to the service model for a particular tenant site rely on

3477

# this field being set correctly to some domain.

3478

"userId": "A String", # Required. A unique user identification string, as determined by the client. The

3479

# client is responsible for ensuring client-level uniqueness of this value

3480

# in order to have the strongest positive impact on search quality.

3481

# Obfuscate this field for privacy concerns before

3482

# providing it to the service.

3483

#

3484

# If this field is not available for some reason, please send "UNKNOWN". Note

3485

# that any improvements to the service model for a particular tenant site,

3486

# rely on this field being set correctly to some unique user_id.

3487

"deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the

3488

# service.

3489

#

3490

# Device information collected from the job seeker, candidate, or

3491

# other entity conducting the job search. Providing this information improves

3492

# the quality of the search results across devices.

3493

"id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes

3494

# the device from other devices.

3495

"deviceType": "A String", # Optional. Type of the device.

3496

},

3497

},

3498

"searchTypes": [ # Required. A list of facets that specify the histogram data to be calculated

3499

# against and returned.

3500

#

3501

# Histogram response times can be slow, and counts

3502

# can be approximations. This call may be temporarily or permanently removed

3503

# prior to the production release of Cloud Talent Solution.

3504

"A String",

3505

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3506

}

3507

3508

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3515

3516

{ # Deprecated. Use SearchJobsRequest.histogram_facets instead to make

3517

# a single call with both search and histogram.

#

# Output only.

#

# The response of the GetHistogram method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3522

"metadata": { # Output only. # Additional information for the API invocation, such as the request

3523

# tracking id.

3524

#

3525

# Additional information returned to client, such as debugging

3526

# information.

3527

"requestId": "A String", # A unique id associated with this call.

3528

# This id is logged for tracking purposes.

3529

"mode": "A String", # For search response only. Indicates the mode of a performed search.

3530

"experimentIdList": [ # Identifiers for the versions of the search algorithm used during

3531

# this API invocation if multiple algorithms are used.

3532

# The default value is empty.

3533

# For search response only.

3534

42,

3535

],

3536

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3537

"results": [ # The Histogram results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3538

{ # Output only.

3539

#

3540

# Result of a histogram call. The response contains the histogram map for the

3541

# search type specified by HistogramResult.field.

3542

# The response is a map of each filter value to the corresponding count of

3543

# jobs for that filter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3544

"values": { # A map from the values of field to the number of jobs with that value

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3545

# in this search result.

3546

#

3547

# Key: search type (filter names, such as the companyName).

3548

#

3549

# Values: the count of jobs that match the filter for this search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3550

"a_key": 42,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3551

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3552

"searchType": "A String", # The Histogram search filters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3553

},

3554

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3559

<code class="details" id="list">list(filter=None, pageToken=None, idsOnly=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3560

<pre>Lists jobs by filter.

3561

3562

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3563

filter: string, Required. The filter string specifies the jobs to be enumerated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3564

3565

Supported operator: =, AND

3566

3567

The fields eligible for filtering are:

3568

3569

* `companyName` (Required)

3570

* `requisitionId` (Optional)

Sample Query:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3574

* companyName = "companies/123"

3575

* companyName = "companies/123" AND requisitionId = "req-1"

3576

pageToken: string, Optional. The starting point of a query result.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3577

idsOnly: boolean, Optional. If set to `true`, only Job.name, Job.requisition_id and

3578

Job.language_code will be returned.

3579

3580

A typical use case is to synchronize job repositories.

3581

3582

Defaults to false.

3583

pageSize: integer, Optional. The maximum number of jobs to be returned per page of results.

3584

3585

If ids_only is set to true, the maximum allowed page size

3586

is 1000. Otherwise, the maximum allowed page size is 100.

3587

3588

Default is 100 if empty or a number < 1 is specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3589

x__xgafv: string, V1 error format.

3590

Allowed values

3591

1 - v1 error format

3592

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3593

3594

Returns:

3595

An object of the form:

{ # Output only.

#

# List jobs response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3600

"metadata": { # Output only. # Additional information for the API invocation, such as the request

3601

# tracking id.

3602

#

3603

# Additional information returned to client, such as debugging

3604

# information.

3605

"requestId": "A String", # A unique id associated with this call.

3606

# This id is logged for tracking purposes.

3607

"mode": "A String", # For search response only. Indicates the mode of a performed search.

3608

"experimentIdList": [ # Identifiers for the versions of the search algorithm used during

3609

# this API invocation if multiple algorithms are used.

3610

# The default value is empty.

3611

# For search response only.

42,

],

},

"jobs": [ # The Jobs for a given company.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3616

#

3617

# The maximum number of items returned is based on the limit field

3618

# provided in the request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3619

{ # A Job resource represents a job posting (also referred to as a "job listing"

3620

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3621

# entity responsible for the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3622

"jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"

3623

#

3624

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3625

"region": "A String", # Optional. The job Region (for example, state, country) throughout which the job

3626

# is available. If this field is set, a

3627

# LocationFilter in a search query within the job region

3628

# finds this job if an exact location match is not specified.

3629

# If this field is set, setting job locations

3630

# to the same location level as this field is strongly recommended.

3631

"referenceUrl": "A String", # Output only. The URL of a web page that displays job details.

3632

"companyTitle": "A String", # Deprecated. Use company_display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3633

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3634

# Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3635

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3636

# The name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3637

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

3638

# recommended as an alternative to using the more general description

3639

# field.

3640

#

3641

# This field accepts and sanitizes HTML input, and also accepts

3642

# bold, italic, ordered list, and unordered list markup tags.

3643

#

3644

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3645

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3646

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

3647

# all compensation entries' CompensationEntry.compensation times

3648

# CompensationEntry.expected_units_per_year.

3649

#

3650

# See CompensationEntry for explanation on compensation annualization.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3651

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3652

# to a maximal compensation value and the currency code is set to

3653

# match the currency code of

3654

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3655

"units": "A String", # The whole units of the amount.

3656

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3657

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3658

"nanos": 42, # Number of nano (10^-9) units of the amount.

3659

# The value must be between -999,999,999 and +999,999,999 inclusive.

3660

# If `units` is positive, `nanos` must be positive or zero.

3661

# If `units` is zero, `nanos` can be positive, zero, or negative.

3662

# If `units` is negative, `nanos` must be negative or zero.

3663

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3664

},

3665

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3666

# to zero and the currency code is set to match the

3667

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3668

"units": "A String", # The whole units of the amount.

3669

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3670

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3671

"nanos": 42, # Number of nano (10^-9) units of the amount.

3672

# The value must be between -999,999,999 and +999,999,999 inclusive.

3673

# If `units` is positive, `nanos` must be positive or zero.

3674

# If `units` is zero, `nanos` can be positive, zero, or negative.

3675

# If `units` is negative, `nanos` must be negative or zero.

3676

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3677

},

3678

},

3679

"min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# A lower bound on a range for compensation or pay for the job.

3684

# The currency type is specified in compensation_amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3685

"units": "A String", # The whole units of the amount.

3686

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3687

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3688

"nanos": 42, # Number of nano (10^-9) units of the amount.

3689

# The value must be between -999,999,999 and +999,999,999 inclusive.

3690

# If `units` is positive, `nanos` must be positive or zero.

3691

# If `units` is zero, `nanos` can be positive, zero, or negative.

3692

# If `units` is negative, `nanos` must be negative or zero.

3693

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3694

},

3695

"entries": [ # Optional. Job compensation information.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3696

#

3697

# At most one entry can be of type

3698

# CompensationInfo.CompensationType.BASE, which is

3699

# referred as ** base compensation entry ** for the job.

3700

{ # A compensation entry that represents one component of compensation, such

3701

# as base pay, bonus, or other compensation type.

3702

#

3703

# Annualization: One compensation entry can be annualized if

3704

# - it contains valid amount or range.

3705

# - and its expected_units_per_year is set or can be derived.

3706

# Its annualized range is determined as (amount or range) times

3707

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3708

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3709

# Job.employment_types is FULLTIME, a default value is inferred

3710

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3716

"description": "A String", # Optional. Compensation description. For example, could

3717

# indicate equity terms or provide additional context to an estimated

3718

# bonus.

3719

"unit": "A String", # Optional. Frequency of the specified amount.

3720

#

3721

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

3722

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3723

"units": "A String", # The whole units of the amount.

3724

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3725

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3726

"nanos": 42, # Number of nano (10^-9) units of the amount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3727

# The value must be between -999,999,999 and +999,999,999 inclusive.

3728

# If `units` is positive, `nanos` must be positive or zero.

3729

# If `units` is zero, `nanos` can be positive, zero, or negative.

3730

# If `units` is negative, `nanos` must be negative or zero.

3731

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3732

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3733

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3734

"range": { # Compensation range. # Optional. Compensation range.

3735

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3736

# to a maximal compensation value and the currency code is set to

3737

# match the currency code of

3738

# min_compensation.

3739

"units": "A String", # The whole units of the amount.

3740

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3741

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3742

"nanos": 42, # Number of nano (10^-9) units of the amount.

3743

# The value must be between -999,999,999 and +999,999,999 inclusive.

3744

# If `units` is positive, `nanos` must be positive or zero.

3745

# If `units` is zero, `nanos` can be positive, zero, or negative.

3746

# If `units` is negative, `nanos` must be negative or zero.

3747

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3748

},

3749

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3750

# to zero and the currency code is set to match the

3751

# currency code of max_compensation.

3752

"units": "A String", # The whole units of the amount.

3753

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3754

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3755

"nanos": 42, # Number of nano (10^-9) units of the amount.

3756

# The value must be between -999,999,999 and +999,999,999 inclusive.

3757

# If `units` is positive, `nanos` must be positive or zero.

3758

# If `units` is zero, `nanos` can be positive, zero, or negative.

3759

# If `units` is negative, `nanos` must be negative or zero.

3760

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3761

},

3762

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3763

},

3764

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3765

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

3766

# base compensation entry's CompensationEntry.compensation times

3767

# CompensationEntry.expected_units_per_year.

3768

#

3769

# See CompensationEntry for explanation on compensation annualization.

3770

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

3771

# to a maximal compensation value and the currency code is set to

3772

# match the currency code of

3773

# min_compensation.

3774

"units": "A String", # The whole units of the amount.

3775

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3776

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3777

"nanos": 42, # Number of nano (10^-9) units of the amount.

3778

# The value must be between -999,999,999 and +999,999,999 inclusive.

3779

# If `units` is positive, `nanos` must be positive or zero.

3780

# If `units` is zero, `nanos` can be positive, zero, or negative.

3781

# If `units` is negative, `nanos` must be negative or zero.

3782

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3783

},

3784

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

3785

# to zero and the currency code is set to match the

3786

# currency code of max_compensation.

3787

"units": "A String", # The whole units of the amount.

3788

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3789

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3790

"nanos": 42, # Number of nano (10^-9) units of the amount.

3791

# The value must be between -999,999,999 and +999,999,999 inclusive.

3792

# If `units` is positive, `nanos` must be positive or zero.

3793

# If `units` is zero, `nanos` can be positive, zero, or negative.

3794

# If `units` is negative, `nanos` must be negative or zero.

3795

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3796

},

3797

},

3798

"amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# The amount of compensation or pay for the job.

3803

# As an alternative, compensation_amount_min and

3804

# compensation_amount_max may be used to define a range of

3805

# compensation.

3806

"units": "A String", # The whole units of the amount.

3807

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3808

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3809

"nanos": 42, # Number of nano (10^-9) units of the amount.

3810

# The value must be between -999,999,999 and +999,999,999 inclusive.

3811

# If `units` is positive, `nanos` must be positive or zero.

3812

# If `units` is zero, `nanos` can be positive, zero, or negative.

3813

# If `units` is negative, `nanos` must be negative or zero.

3814

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3815

},

3816

"type": "A String", # Deprecated. Use entries instead.

#

# Optional.

#

# Type of job compensation.

3821

"max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# An upper bound on a range for compensation or pay for the job.

3826

# The currency type is specified in compensation_amount.

3827

"units": "A String", # The whole units of the amount.

3828

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3829

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3830

"nanos": 42, # Number of nano (10^-9) units of the amount.

3831

# The value must be between -999,999,999 and +999,999,999 inclusive.

3832

# If `units` is positive, `nanos` must be positive or zero.

3833

# If `units` is zero, `nanos` can be positive, zero, or negative.

3834

# If `units` is negative, `nanos` must be negative or zero.

3835

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3836

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3837

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3838

"expireTime": "A String", # Optional but strongly recommended for the best service

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3839

# experience.

3840

#

3841

# The expiration timestamp of the job. After this timestamp, the

3842

# job is marked as expired, and it no longer appears in search results. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3843

# expired job can't be deleted or listed by the DeleteJob and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3844

# ListJobs APIs, but it can be retrieved with the GetJob API or

3845

# updated with the UpdateJob API. An expired job can be updated and

3846

# opened again by using a future expiration timestamp. Updating an expired

3847

# job fails if there is another existing open job with same

3848

# requisition_id, company_name and language_code.

3849

#

3850

# The expired jobs are retained in our system for 90 days. However, the

3851

# overall expired job count cannot exceed 3 times the maximum of open jobs

3852

# count over the past week, otherwise jobs with earlier expire time are

3853

# cleaned first. Expired jobs are no longer accessible after they are cleaned

3854

# out.

3855

# The format of this field is RFC 3339 date strings. Example:

3856

# 2000-01-01T00:00:00.999999999Z

3857

# See

3858

# [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).

3859

#

3860

# A valid date range is between 1970-01-01T00:00:00.0Z and

3861

# 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire

3862

# time not provided.

3863

#

3864

# If this value is not provided at the time of job creation or is invalid,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3865

# the job posting expires after 30 days from the job's creation time. For

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3866

# example, if the job was created on 2017/01/01 13:00AM UTC with an

3867

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

3868

#

3869

# If this value is not provided but expiry_date is, expiry_date is

3870

# used.

3871

#

3872

# If this value is not provided on job update, it depends on the field masks

3873

# set by UpdateJobRequest.update_job_fields. If the field masks include

3874

# expiry_time, or the masks are empty meaning that every field is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3875

# updated, the job posting expires after 30 days from the job's last

3876

# update time. Otherwise the expiration date isn't updated.

3877

"updateTime": "A String", # Output only. The timestamp when this job was last updated.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3878

"department": "A String", # Optional. The department or functional area within the company with the open

3879

# position.

3880

#

3881

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3882

"jobLocations": [ # Output only. Structured locations of the job, resolved from locations.

3883

{ # Output only.

3884

#

3885

# A resource that represents a location with full geographic

3886

# information.

3887

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

3888

# such as postal delivery and payments addresses. Given a postal address,

3889

# a postal service can deliver items to a premises, P.O. Box, or other

3890

# delivery location.

3891

# Given a postal address, a postal service can deliver items to a premise, P.O.

3892

# Box or similar.

3893

# It is not intended to model geographical locations (roads, towns,

3894

# mountains).

3895

#

3896

# In typical usage an address would be created via user input or from importing

3897

# existing data, depending on the type of process.

3898

#

3899

# Advice on address input / editing:

3900

# - Use an i18n-ready address widget such as

3901

# https://github.com/google/libaddressinput)

3902

# - Users should not be presented with UI elements for input or editing of

3903

# fields outside countries where that field is used.

3904

#

3905

# For more guidance on how to use this schema, please see:

3906

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3907

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

3908

# Examples: US city, IT comune, UK post town.

3909

# In regions of the world where localities are not well defined or do not fit

3910

# into this structure well, leave locality empty and use address_lines.

3911

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

3912

# addresses of a country or region.

3913

# For example, this can be a state, a province, an oblast, or a prefecture.

3914

# Specifically, for Spain this is the province and not the autonomous

3915

# community (e.g. "Barcelona" and not "Catalonia").

3916

# Many countries don't use an administrative area in postal addresses. E.g.

3917

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3918

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3919

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

3920

#

3921

# Because values in address_lines do not have type information and may

3922

# sometimes contain multiple values in a single field (e.g.

3923

# "Austin, TX"), it is important that the line order is clear. The order of

3924

# address lines should be "envelope order" for the country/region of the

3925

# address. In places where this can vary (e.g. Japan), address_language is

3926

# used to make it explicit (e.g. "ja" for large-to-small ordering and

3927

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

3928

# an address can be selected based on the language.

3929

#

3930

# The minimum permitted structural representation of an address consists

3931

# of a region_code with all remaining information placed in the

3932

# address_lines. It would be possible to format such an address very

3933

# approximately without geocoding, but no semantic reasoning could be

3934

# made about any of the address components until it was at least

3935

# partially resolved.

3936

#

3937

# Creating an address only containing a region_code and address_lines, and

3938

# then geocoding is the recommended way to handle completely unstructured

3939

# addresses (as opposed to guessing which parts of the address should be

3940

# localities or administrative areas).

3941

"A String",

3942

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3943

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

3944

# is never inferred and it is up to the user to ensure the value is

3945

# correct. See http://cldr.unicode.org/ and

3946

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

3947

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3948

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

3949

# postal codes to be present, but where they are used, they may trigger

3950

# additional validation with other parts of the address (e.g. state/zip

3951

# validation in the U.S.A.).

3952

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

3953

# in most regions. Where it is used, the value is either a string like

3954

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

3955

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

3956

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

3957

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

3958

# known). This is often the UI language of the input form or is expected

3959

# to match one of the languages used in the address' country/region, or their

3960

# transliterated equivalents.

3961

# This can affect formatting in certain countries, but is not critical

3962

# to the correctness of the data and will never affect any validation or

3963

# other non-formatting related operations.

3964

#

3965

# If this value is not known, it should be omitted (rather than specifying a

3966

# possibly incorrect default).

3967

#

3968

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

3969

"recipients": [ # Optional. The recipient at the address.

3970

# This field may, under certain circumstances, contain multiline information.

3971

# For example, it might contain "care of" information.

3972

"A String",

3973

],

3974

"sublocality": "A String", # Optional. Sublocality of the address.

3975

# For example, this can be neighborhoods, boroughs, districts.

3976

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

3977

# the latest revision.

3978

#

3979

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3980

},

3981

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

3982

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

3983

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

3984

# LocationType#LOCALITY.

3985

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

3986

# location bounding box in which a circle with the specified radius

3987

# centered from LatLng coves the area associated with the job location.

3988

# For example, currently, "Mountain View, CA, USA" has a radius of

3989

# 7885.79 meters.

3990

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

3991

# of doubles representing degrees latitude and degrees longitude. Unless

3992

# specified otherwise, this must conform to the

3993

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

3994

# standard</a>. Values must be within normalized ranges.

3995

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

3996

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

3997

},

3998

},

3999

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4000

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

4005

# filterable_custom_fields. These fields are distinct in that the data

4006

# in these fields are not indexed. Therefore, the client cannot search

4007

# against them, nor can the client use them to list jobs.

4008

#

4009

# The key of the map can be any valid string.

4010

"a_key": { # Resource that represents the custom data not captured by the standard fields.

4011

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

4017

#

4018

# Optional but strongly recommended to be provided for the best service

4019

# experience.

4020

#

4021

# The expiration date of the job in UTC time. After 12 am on this date, the

4022

# job is marked as expired, and it no longer appears in search results.

4023

# The expired job can't be deleted or listed by the DeleteJob and

4024

# ListJobs APIs, but it can be retrieved with the GetJob API or

4025

# updated with the UpdateJob API. An expired job can be updated and

4026

# opened again by using a future expiration date. It can also remain expired.

4027

# Updating an expired job to be open fails if there is another existing open

4028

# job with same requisition_id, company_name and language_code.

4029

#

4030

# The expired jobs are retained in our system for 90 days. However, the

4031

# overall expired job count cannot exceed 3 times the maximum of open jobs

4032

# count over the past week, otherwise jobs with earlier expire time are

4033

# removed first. Expired jobs are no longer accessible after they are cleaned

4034

# out.

4035

#

4036

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

4037

# ignored and treated as expiry date not provided.

4038

#

4039

# If this value is not provided on job creation or is invalid, the job

4040

# posting expires after 30 days from the job's creation time. For example, if

4041

# the job was created on 2017/01/01 13:00AM UTC with an unspecified

4042

# expiration date, the job expires after 2017/01/31 13:00AM UTC.

4043

#

4044

# If this value is not provided on job update, it depends on the field masks

4045

# set by UpdateJobRequest.update_job_fields. If the field masks include

4046

# expiry_date, or the masks are empty meaning that every field is

4047

# updated, the job expires after 30 days from the job's last update time.

4048

# Otherwise the expiration date isn't updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4049

# and time zone are either specified elsewhere or are not significant. The date

4050

# is relative to the Proleptic Gregorian Calendar. This can represent:

4051

#

4052

# * A full date, with non-zero year, month and day values

4053

# * A month and day value, with a zero year, e.g. an anniversary

4054

# * A year on its own, with zero month and day values

4055

# * A year and month value, with a zero day, e.g. a credit card expiration date

4056

#

4057

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4058

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4059

# if specifying a year by itself or a year and month where the day is not

4060

# significant.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4061

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4062

# a year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4063

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

4064

# month and day.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4065

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4066

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

4067

# is used for contracting engagements.

4068

# Dates prior to 1970/1/1 and invalid date formats are ignored.

4069

# and time zone are either specified elsewhere or are not significant. The date

4070

# is relative to the Proleptic Gregorian Calendar. This can represent:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4071

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4072

# * A full date, with non-zero year, month and day values

4073

# * A month and day value, with a zero year, e.g. an anniversary

4074

# * A year on its own, with zero month and day values

4075

# * A year and month value, with a zero day, e.g. a credit card expiration date

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4076

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4077

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

4078

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

4079

# if specifying a year by itself or a year and month where the day is not

4080

# significant.

4081

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

4082

# a year.

4083

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

4084

# month and day.

4085

},

4086

"educationLevels": [ # Optional. The desired education level for the job, such as

4087

# "Bachelors", "Masters", "Doctorate".

4088

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4089

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4090

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4091

# attributes that are not covered by the provided structured fields.

4092

#

4093

# This field is a more general combination of the deprecated id-based

4094

# filterable_custom_fields and string-based

4095

# non_filterable_custom_fields.

4096

#

4097

# The keys of the map are strings up to 64 bytes and must match the

4098

# pattern: a-zA-Z*.

4099

#

4100

# At most 100 filterable and at most 100 unfilterable keys are supported.

4101

# For filterable `string_values`, across all keys at most 200 values are

4102

# allowed, with each string no more than 255 characters. For unfilterable

4103

# `string_values`, the maximum total size of `string_values` across all keys

4104

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4105

"a_key": { # Custom attribute values that are either filterable or non-filterable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4106

"longValue": "A String", # Optional but at least one of string_values or long_value must

4107

# be specified.

4108

#

4109

# This field is used to perform number range search.

4110

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For

4111

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

4112

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4113

# be specified.

4114

#

4115

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

4116

# `CASE_INSENSITIVE_MATCH`) search.

4117

# For filterable `string_values`, a maximum total number of 200 values

4118

# is allowed, with each `string_value` has a byte size of no more than

4119

# 255B. For unfilterable `string_values`, the maximum total byte size of

4120

# unfilterable `string_values` is 50KB.

4121

#

4122

# Empty strings are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4123

"values": [ # Required. String values.

4124

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4125

],

4126

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4127

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

4128

# If false, values are not searchable.

4129

#

4130

# Default is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4131

},

4132

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4133

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

4138

# the standard fields such as job_title, company_name, or

4139

# level. These custom fields store arbitrary

4140

# string values, and can be used for purposes not covered by

4141

# the structured fields. For the best search experience, use of the

4142

# structured rather than custom fields is recommended.

4143

#

4144

# Data stored in these custom fields fields are indexed and

4145

# searched against by keyword searches (see

4146

# SearchJobsRequest.custom_field_filters][]).

4147

#

4148

# The map key must be a number between 1-20. If an invalid key is

4149

# provided on job create or update, an error is returned.

4150

"a_key": { # Resource that represents the custom data not captured by the standard fields.

4151

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

4157

# any requirements for fluency that are associated with the job.

4158

#

4159

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

4160

# For more information, see

4161

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

4162

# class="external" target="_blank" }.

4163

#

4164

# If this field is unspecified and Job.description is present, detected

4165

# language code based on Job.description is assigned, otherwise

4166

# defaults to 'en_US'.

4167

"visibility": "A String", # Optional. The visibility of the job.

4168

# Defaults to JobVisibility.PRIVATE if not specified.

4169

# Currently only JobVisibility.PRIVATE is supported.

4170

"name": "A String", # Required during job update.

4171

#

4172

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

4173

# of this field in job queries and API calls is preferred over the use of

4174

# requisition_id since this value is unique.

4175

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4176

# provided.

4177

#

4178

# A unique company identifier used by job distributors to identify an

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4179

# employer's company entity. company_name takes precedence over

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4180

# this field, and is the recommended field to use to identify companies.

4181

#

4182

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4183

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

4184

# The value determines the sort order of the jobs returned when searching for

4185

# jobs using the featured jobs search call, with higher promotional values

4186

# being returned first and ties being resolved by relevance sort. Only the

4187

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

4188

#

4189

# Default value is 0, and negative values are treated as 0.

4190

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

4191

# value is the time the request arrives at the server.

4192

# and time zone are either specified elsewhere or are not significant. The date

4193

# is relative to the Proleptic Gregorian Calendar. This can represent:

4194

#

4195

# * A full date, with non-zero year, month and day values

4196

# * A month and day value, with a zero year, e.g. an anniversary

4197

# * A year on its own, with zero month and day values

4198

# * A year and month value, with a zero day, e.g. a credit card expiration date

4199

#

4200

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

4201

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

4202

# if specifying a year by itself or a year and month where the day is not

4203

# significant.

4204

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

4205

# a year.

4206

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

4207

# month and day.

4208

},

4209

"applicationUrls": [ # Optional but at least one of application_urls,

4210

# application_email_list or application_instruction must be

4211

# specified.

4212

#

4213

# Use this URL field to direct an applicant to a website, for example to

4214

# link to an online application form.

4215

#

4216

# The maximum number of allowed characters is 2,000.

4217

"A String",

4218

],

4219

"companyDisplayName": "A String", # Output only. The name of the company listing the job.

4220

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

4221

# client to identify a job. This field is intended to be used by clients

4222

# for client identification and tracking of listings. A job is not allowed

4223

# to be created if there is another job with the same requisition_id,

4224

# company_name and language_code.

4225

#

4226

# The maximum number of allowed characters is 255.

4227

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

4228

# job. The use of this field is recommended

4229

# as an alternative to using the more general description field.

4230

#

4231

# This field accepts and sanitizes HTML input, and also accepts

4232

# bold, italic, ordered list, and unordered list markup tags.

4233

#

4234

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4235

"createTime": "A String", # Output only. The timestamp when this job was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4236

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

4237

# is used for contracting engagements.

4238

# Dates prior to 1970/1/1 and invalid date formats are ignored.

4239

# and time zone are either specified elsewhere or are not significant. The date

4240

# is relative to the Proleptic Gregorian Calendar. This can represent:

4241

#

4242

# * A full date, with non-zero year, month and day values

4243

# * A month and day value, with a zero year, e.g. an anniversary

4244

# * A year on its own, with zero month and day values

4245

# * A year and month value, with a zero day, e.g. a credit card expiration date

4246

#

4247

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

4248

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

4249

# if specifying a year by itself or a year and month where the day is not

4250

# significant.

4251

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

4252

# a year.

4253

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

4254

# month and day.

4255

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4256

"level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

4257

"applicationInstruction": "A String", # Optional but at least one of application_urls,

4258

# application_email_list or application_instruction must be

4259

# specified.

4260

#

4261

# Use this field to provide instructions, such as "Mail your application

4262

# to ...", that a candidate can follow to apply for the job.

4263

#

4264

# This field accepts and sanitizes HTML input, and also accepts

4265

# bold, italic, ordered list, and unordered list markup tags.

4266

#

4267

# The maximum number of allowed characters is 3,000.

4268

"benefits": [ # Optional. The benefits included with the job.

4269

"A String",

4270

],

4271

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

4272

# incentives associated with the job not including salary or pay.

4273

#

4274

# The maximum number of allowed characters is 10,000.

4275

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"locations": [ # Optional but strongly recommended for the best service experience.

4281

#

4282

# Location(s) where the emploeyer is looking to hire for this job posting.

4283

#

4284

# Specifying the full street address(es) of the hiring location enables

4285

# better API results, especially job searches by commute time.

4286

#

4287

# At most 50 locations are allowed for best search performance. If a job has

4288

# more locations, it is suggested to split it into multiple jobs with unique

4289

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

4290

# multiple jobs with the same requisition_id, company_name and

4291

# language_code are not allowed. If the original requisition_id must

4292

# be preserved, a custom field should be used for storage. It is also

4293

# suggested to group the locations that close to each other in the same job

4294

# for better search experience.

4295

#

4296

# The maximum number of allowed characters is 500.

4297

"A String",

4298

],

4299

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

4304

#

4305

# This field replaces compensation_info. Only

4306

# CompensationInfo.entries or extended_compensation_info can be set,

4307

# otherwise an exception is thrown.

4308

#

4309

# Describes job compensation.

4310

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

4311

# currency code.

4312

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

4313

#

4314

# Compensation range.

4315

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

4316

#

4317

# Decimal number.

4318

"micros": 42, # Micro (10^-6) units.

4319

# The value must be between -999,999 and +999,999 inclusive.

4320

# If `units` is positive, `micros` must be positive or zero.

4321

# If `units` is zero, `micros` can be positive, zero, or negative.

4322

# If `units` is negative, `micros` must be negative or zero.

4323

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4324

"units": "A String", # Whole units.

4325

},

4326

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

4327

#

4328

# Decimal number.

4329

"micros": 42, # Micro (10^-6) units.

4330

# The value must be between -999,999 and +999,999 inclusive.

4331

# If `units` is positive, `micros` must be positive or zero.

4332

# If `units` is zero, `micros` can be positive, zero, or negative.

4333

# If `units` is negative, `micros` must be negative or zero.

4334

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4335

"units": "A String", # Whole units.

4336

},

4337

},

4338

"entries": [ # Optional. Job compensation information.

4339

#

4340

# At most one entry can be of type

4341

# ExtendedCompensationInfo.CompensationType.BASE, which is

4342

# referred as ** base compensation entry ** for the job.

4343

{ # Deprecated. See CompensationInfo.

4344

#

4345

# A compensation entry that represents one component of compensation, such

4346

# as base pay, bonus, or other compensation type.

4347

#

4348

# Annualization: One compensation entry can be annualized if

4349

# - it contains valid amount or range.

4350

# - and its expected_units_per_year is set or can be derived.

4351

# Its annualized range is determined as (amount or range) times

4352

# expected_units_per_year.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4353

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

4354

#

4355

# Decimal number.

4356

"micros": 42, # Micro (10^-6) units.

4357

# The value must be between -999,999 and +999,999 inclusive.

4358

# If `units` is positive, `micros` must be positive or zero.

4359

# If `units` is zero, `micros` can be positive, zero, or negative.

4360

# If `units` is negative, `micros` must be negative or zero.

4361

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4362

"units": "A String", # Whole units.

4363

},

4364

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4365

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

4366

#

4367

# Compensation range.

4368

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

4369

#

4370

# Decimal number.

4371

"micros": 42, # Micro (10^-6) units.

4372

# The value must be between -999,999 and +999,999 inclusive.

4373

# If `units` is positive, `micros` must be positive or zero.

4374

# If `units` is zero, `micros` can be positive, zero, or negative.

4375

# If `units` is negative, `micros` must be negative or zero.

4376

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4377

"units": "A String", # Whole units.

4378

},

4379

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

4380

#

4381

# Decimal number.

4382

"micros": 42, # Micro (10^-6) units.

4383

# The value must be between -999,999 and +999,999 inclusive.

4384

# If `units` is positive, `micros` must be positive or zero.

4385

# If `units` is zero, `micros` can be positive, zero, or negative.

4386

# If `units` is negative, `micros` must be negative or zero.

4387

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4388

"units": "A String", # Whole units.

4389

},

4390

},

4391

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

4392

# Job.employment_types is FULLTIME, a default value is inferred

4393

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

4402

# The value must be between -999,999 and +999,999 inclusive.

4403

# If `units` is positive, `micros` must be positive or zero.

4404

# If `units` is zero, `micros` can be positive, zero, or negative.

4405

# If `units` is negative, `micros` must be negative or zero.

4406

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4407

"units": "A String", # Whole units.

4408

},

4409

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

4410

"description": "A String", # Optional. Compensation description.

4411

"unit": "A String", # Optional. Frequency of the specified amount.

4412

#

4413

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4414

},

4415

],

4416

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

4417

# the job's all CompensationEntry cannot be annualized.

4418

# See CompensationEntry for explanation on annualization and base

4419

# compensation entry.

4420

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

4421

#

4422

# Compensation range.

4423

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

4424

#

4425

# Decimal number.

4426

"micros": 42, # Micro (10^-6) units.

4427

# The value must be between -999,999 and +999,999 inclusive.

4428

# If `units` is positive, `micros` must be positive or zero.

4429

# If `units` is zero, `micros` can be positive, zero, or negative.

4430

# If `units` is negative, `micros` must be negative or zero.

4431

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4432

"units": "A String", # Whole units.

4433

},

4434

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

4435

#

4436

# Decimal number.

4437

"micros": 42, # Micro (10^-6) units.

4438

# The value must be between -999,999 and +999,999 inclusive.

4439

# If `units` is positive, `micros` must be positive or zero.

4440

# If `units` is zero, `micros` can be positive, zero, or negative.

4441

# If `units` is negative, `micros` must be negative or zero.

4442

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

4443

"units": "A String", # Whole units.

4444

},

4445

},

4446

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

4447

# the job's base compensation entry cannot be annualized.

4448

# See CompensationEntry for explanation on annualization and base

4449

# compensation entry.

4450

},

4451

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

4452

# provided.

4453

#

4454

# The resource name of the company listing the job, such as

4455

# /companies/foo. This field takes precedence over the

4456

# distributor-assigned company identifier, distributor_company_id.

4457

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

4458

# description of the company and related information. Separate fields are

4459

# provided on the job object for responsibilities,

4460

# qualifications, and other job characteristics. Use of

4461

# these separate job fields is recommended.

4462

#

4463

# This field accepts and sanitizes HTML input, and also accepts

4464

# bold, italic, ordered list, and unordered list markup tags.

4465

#

4466

# The maximum number of allowed characters is 100,000.

4467

"applicationEmailList": [ # Optional but at least one of application_urls,

4468

# application_email_list or application_instruction must be

4469

# specified.

4470

#

4471

# Use this field to specify email address(es) to which resumes or

4472

# applications can be sent.

4473

#

4474

# The maximum number of allowed characters is 255.

4475

"A String",

4476

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4477

},

4478

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4479

"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>

4485

<pre>Retrieves the next page of results.

4486

4487

Args:

4488

previous_request: The request for the previous page. (required)

4489

previous_response: The response from the request for the previous page. (required)

4490

4491

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4492

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]

4493

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]

4498

<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4499

<pre>Updates specified job.

4500

4501

Typically, updated contents become visible in search results within 10

4502

seconds, but it may take up to 5 minutes.

4503

4504

Args:

4505

name: string, Required during job update.

4506

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4507

Resource name assigned to a job by the API, for example, "/jobs/foo". Use

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4508

of this field in job queries and API calls is preferred over the use of

4509

requisition_id since this value is unique. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4510

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4511

The object takes the form of:

{ # Input only.

#

# Update job request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4516

"updateJobFields": "A String", # Optional but strongly recommended to be provided for the best service

4517

# experience.

4518

#

4519

# If update_job_fields is provided, only the specified fields in

4520

# job are updated. Otherwise all the fields are updated.

4521

#

4522

# A field mask to restrict the fields that are updated. Valid values are:

#

# * jobTitle

# * employmentTypes

# * description

# * applicationUrls

# * applicationEmailList

4529

# * applicationInstruction

# * responsibilities

# * qualifications

# * educationLevels

# * level

# * department

# * startDate

# * endDate

# * compensationInfo

# * incentives

# * languageCode

# * benefits

# * expireTime

# * customAttributes

# * visibility

# * publishDate

# * promotionValue

# * locations

# * region

# * expiryDate (deprecated)

4549

# * filterableCustomFields (deprecated)

4550

# * unindexedCustomFields (deprecated)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4551

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Required. The Job to be updated.

4552

# or "job requisition"). A job belongs to a Company, which is the hiring

4553

# entity responsible for the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4554

"jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"

4555

#

4556

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4557

"region": "A String", # Optional. The job Region (for example, state, country) throughout which the job

4558

# is available. If this field is set, a

4559

# LocationFilter in a search query within the job region

4560

# finds this job if an exact location match is not specified.

4561

# If this field is set, setting job locations

4562

# to the same location level as this field is strongly recommended.

4563

"referenceUrl": "A String", # Output only. The URL of a web page that displays job details.

4564

"companyTitle": "A String", # Deprecated. Use company_display_name instead.

#

# Output only.

#

# The name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4569

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

4570

# recommended as an alternative to using the more general description

4571

# field.

4572

#

4573

# This field accepts and sanitizes HTML input, and also accepts

4574

# bold, italic, ordered list, and unordered list markup tags.

4575

#

4576

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4577

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4578

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

4579

# all compensation entries' CompensationEntry.compensation times

4580

# CompensationEntry.expected_units_per_year.

4581

#

4582

# See CompensationEntry for explanation on compensation annualization.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4583

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4584

# to a maximal compensation value and the currency code is set to

4585

# match the currency code of

4586

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4587

"units": "A String", # The whole units of the amount.

4588

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4589

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4590

"nanos": 42, # Number of nano (10^-9) units of the amount.

4591

# The value must be between -999,999,999 and +999,999,999 inclusive.

4592

# If `units` is positive, `nanos` must be positive or zero.

4593

# If `units` is zero, `nanos` can be positive, zero, or negative.

4594

# If `units` is negative, `nanos` must be negative or zero.

4595

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4596

},

4597

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4598

# to zero and the currency code is set to match the

4599

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4600

"units": "A String", # The whole units of the amount.

4601

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4602

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4603

"nanos": 42, # Number of nano (10^-9) units of the amount.

4604

# The value must be between -999,999,999 and +999,999,999 inclusive.

4605

# If `units` is positive, `nanos` must be positive or zero.

4606

# If `units` is zero, `nanos` can be positive, zero, or negative.

4607

# If `units` is negative, `nanos` must be negative or zero.

4608

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4609

},

4610

},

4611

"min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# A lower bound on a range for compensation or pay for the job.

4616

# The currency type is specified in compensation_amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4617

"units": "A String", # The whole units of the amount.

4618

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4619

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4620

"nanos": 42, # Number of nano (10^-9) units of the amount.

4621

# The value must be between -999,999,999 and +999,999,999 inclusive.

4622

# If `units` is positive, `nanos` must be positive or zero.

4623

# If `units` is zero, `nanos` can be positive, zero, or negative.

4624

# If `units` is negative, `nanos` must be negative or zero.

4625

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4626

},

4627

"entries": [ # Optional. Job compensation information.

4628

#

4629

# At most one entry can be of type

4630

# CompensationInfo.CompensationType.BASE, which is

4631

# referred as ** base compensation entry ** for the job.

4632

{ # A compensation entry that represents one component of compensation, such

4633

# as base pay, bonus, or other compensation type.

4634

#

4635

# Annualization: One compensation entry can be annualized if

4636

# - it contains valid amount or range.

4637

# - and its expected_units_per_year is set or can be derived.

4638

# Its annualized range is determined as (amount or range) times

4639

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4640

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

4641

# Job.employment_types is FULLTIME, a default value is inferred

4642

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

"description": "A String", # Optional. Compensation description. For example, could

4649

# indicate equity terms or provide additional context to an estimated

4650

# bonus.

4651

"unit": "A String", # Optional. Frequency of the specified amount.

4652

#

4653

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

4654

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4655

"units": "A String", # The whole units of the amount.

4656

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4657

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4658

"nanos": 42, # Number of nano (10^-9) units of the amount.

4659

# The value must be between -999,999,999 and +999,999,999 inclusive.

4660

# If `units` is positive, `nanos` must be positive or zero.

4661

# If `units` is zero, `nanos` can be positive, zero, or negative.

4662

# If `units` is negative, `nanos` must be negative or zero.

4663

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4664

},

4665

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4666

"range": { # Compensation range. # Optional. Compensation range.

4667

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4668

# to a maximal compensation value and the currency code is set to

4669

# match the currency code of

4670

# min_compensation.

4671

"units": "A String", # The whole units of the amount.

4672

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4673

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4674

"nanos": 42, # Number of nano (10^-9) units of the amount.

4675

# The value must be between -999,999,999 and +999,999,999 inclusive.

4676

# If `units` is positive, `nanos` must be positive or zero.

4677

# If `units` is zero, `nanos` can be positive, zero, or negative.

4678

# If `units` is negative, `nanos` must be negative or zero.

4679

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4680

},

4681

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4682

# to zero and the currency code is set to match the

4683

# currency code of max_compensation.

4684

"units": "A String", # The whole units of the amount.

4685

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4686

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4687

"nanos": 42, # Number of nano (10^-9) units of the amount.

4688

# The value must be between -999,999,999 and +999,999,999 inclusive.

4689

# If `units` is positive, `nanos` must be positive or zero.

4690

# If `units` is zero, `nanos` can be positive, zero, or negative.

4691

# If `units` is negative, `nanos` must be negative or zero.

4692

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4693

},

4694

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4695

},

4696

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4697

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

4698

# base compensation entry's CompensationEntry.compensation times

4699

# CompensationEntry.expected_units_per_year.

4700

#

4701

# See CompensationEntry for explanation on compensation annualization.

4702

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

4703

# to a maximal compensation value and the currency code is set to

4704

# match the currency code of

4705

# min_compensation.

4706

"units": "A String", # The whole units of the amount.

4707

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4708

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4709

"nanos": 42, # Number of nano (10^-9) units of the amount.

4710

# The value must be between -999,999,999 and +999,999,999 inclusive.

4711

# If `units` is positive, `nanos` must be positive or zero.

4712

# If `units` is zero, `nanos` can be positive, zero, or negative.

4713

# If `units` is negative, `nanos` must be negative or zero.

4714

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4715

},

4716

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

4717

# to zero and the currency code is set to match the

4718

# currency code of max_compensation.

4719

"units": "A String", # The whole units of the amount.

4720

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4721

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4722

"nanos": 42, # Number of nano (10^-9) units of the amount.

4723

# The value must be between -999,999,999 and +999,999,999 inclusive.

4724

# If `units` is positive, `nanos` must be positive or zero.

4725

# If `units` is zero, `nanos` can be positive, zero, or negative.

4726

# If `units` is negative, `nanos` must be negative or zero.

4727

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4728

},

4729

},

4730

"amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# The amount of compensation or pay for the job.

4735

# As an alternative, compensation_amount_min and

4736

# compensation_amount_max may be used to define a range of

4737

# compensation.

4738

"units": "A String", # The whole units of the amount.

4739

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4740

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4741

"nanos": 42, # Number of nano (10^-9) units of the amount.

4742

# The value must be between -999,999,999 and +999,999,999 inclusive.

4743

# If `units` is positive, `nanos` must be positive or zero.

4744

# If `units` is zero, `nanos` can be positive, zero, or negative.

4745

# If `units` is negative, `nanos` must be negative or zero.

4746

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4747

},

4748

"type": "A String", # Deprecated. Use entries instead.

#

# Optional.

#

# Type of job compensation.

4753

"max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# An upper bound on a range for compensation or pay for the job.

4758

# The currency type is specified in compensation_amount.

4759

"units": "A String", # The whole units of the amount.

4760

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4761

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4762

"nanos": 42, # Number of nano (10^-9) units of the amount.

4763

# The value must be between -999,999,999 and +999,999,999 inclusive.

4764

# If `units` is positive, `nanos` must be positive or zero.

4765

# If `units` is zero, `nanos` can be positive, zero, or negative.

4766

# If `units` is negative, `nanos` must be negative or zero.

4767

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4768

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4769

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4770

"expireTime": "A String", # Optional but strongly recommended for the best service

4771

# experience.

4772

#

4773

# The expiration timestamp of the job. After this timestamp, the

4774

# job is marked as expired, and it no longer appears in search results. The

4775

# expired job can't be deleted or listed by the DeleteJob and

4776

# ListJobs APIs, but it can be retrieved with the GetJob API or

4777

# updated with the UpdateJob API. An expired job can be updated and

4778

# opened again by using a future expiration timestamp. Updating an expired

4779

# job fails if there is another existing open job with same

4780

# requisition_id, company_name and language_code.

4781

#

4782

# The expired jobs are retained in our system for 90 days. However, the

4783

# overall expired job count cannot exceed 3 times the maximum of open jobs

4784

# count over the past week, otherwise jobs with earlier expire time are

4785

# cleaned first. Expired jobs are no longer accessible after they are cleaned

4786

# out.

4787

# The format of this field is RFC 3339 date strings. Example:

4788

# 2000-01-01T00:00:00.999999999Z

4789

# See

4790

# [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).

4791

#

4792

# A valid date range is between 1970-01-01T00:00:00.0Z and

4793

# 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire

4794

# time not provided.

4795

#

4796

# If this value is not provided at the time of job creation or is invalid,

4797

# the job posting expires after 30 days from the job's creation time. For

4798

# example, if the job was created on 2017/01/01 13:00AM UTC with an

4799

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

4800

#

4801

# If this value is not provided but expiry_date is, expiry_date is

4802

# used.

4803

#

4804

# If this value is not provided on job update, it depends on the field masks

4805

# set by UpdateJobRequest.update_job_fields. If the field masks include

4806

# expiry_time, or the masks are empty meaning that every field is

4807

# updated, the job posting expires after 30 days from the job's last

4808

# update time. Otherwise the expiration date isn't updated.

4809

"updateTime": "A String", # Output only. The timestamp when this job was last updated.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4810

"department": "A String", # Optional. The department or functional area within the company with the open

4811

# position.

4812

#

4813

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4814

"jobLocations": [ # Output only. Structured locations of the job, resolved from locations.

4815

{ # Output only.

4816

#

4817

# A resource that represents a location with full geographic

4818

# information.

4819

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

4820

# such as postal delivery and payments addresses. Given a postal address,

4821

# a postal service can deliver items to a premises, P.O. Box, or other

4822

# delivery location.

4823

# Given a postal address, a postal service can deliver items to a premise, P.O.

4824

# Box or similar.

4825

# It is not intended to model geographical locations (roads, towns,

4826

# mountains).

4827

#

4828

# In typical usage an address would be created via user input or from importing

4829

# existing data, depending on the type of process.

4830

#

4831

# Advice on address input / editing:

4832

# - Use an i18n-ready address widget such as

4833

# https://github.com/google/libaddressinput)

4834

# - Users should not be presented with UI elements for input or editing of

4835

# fields outside countries where that field is used.

4836

#

4837

# For more guidance on how to use this schema, please see:

4838

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4839

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

4840

# Examples: US city, IT comune, UK post town.

4841

# In regions of the world where localities are not well defined or do not fit

4842

# into this structure well, leave locality empty and use address_lines.

4843

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

4844

# addresses of a country or region.

4845

# For example, this can be a state, a province, an oblast, or a prefecture.

4846

# Specifically, for Spain this is the province and not the autonomous

4847

# community (e.g. "Barcelona" and not "Catalonia").

4848

# Many countries don't use an administrative area in postal addresses. E.g.

4849

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4850

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4851

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

4852

#

4853

# Because values in address_lines do not have type information and may

4854

# sometimes contain multiple values in a single field (e.g.

4855

# "Austin, TX"), it is important that the line order is clear. The order of

4856

# address lines should be "envelope order" for the country/region of the

4857

# address. In places where this can vary (e.g. Japan), address_language is

4858

# used to make it explicit (e.g. "ja" for large-to-small ordering and

4859

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

4860

# an address can be selected based on the language.

4861

#

4862

# The minimum permitted structural representation of an address consists

4863

# of a region_code with all remaining information placed in the

4864

# address_lines. It would be possible to format such an address very

4865

# approximately without geocoding, but no semantic reasoning could be

4866

# made about any of the address components until it was at least

4867

# partially resolved.

4868

#

4869

# Creating an address only containing a region_code and address_lines, and

4870

# then geocoding is the recommended way to handle completely unstructured

4871

# addresses (as opposed to guessing which parts of the address should be

4872

# localities or administrative areas).

4873

"A String",

4874

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4875

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

4876

# is never inferred and it is up to the user to ensure the value is

4877

# correct. See http://cldr.unicode.org/ and

4878

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

4879

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4880

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

4881

# postal codes to be present, but where they are used, they may trigger

4882

# additional validation with other parts of the address (e.g. state/zip

4883

# validation in the U.S.A.).

4884

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

4885

# in most regions. Where it is used, the value is either a string like

4886

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

4887

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

4888

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

4889

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

4890

# known). This is often the UI language of the input form or is expected

4891

# to match one of the languages used in the address' country/region, or their

4892

# transliterated equivalents.

4893

# This can affect formatting in certain countries, but is not critical

4894

# to the correctness of the data and will never affect any validation or

4895

# other non-formatting related operations.

4896

#

4897

# If this value is not known, it should be omitted (rather than specifying a

4898

# possibly incorrect default).

4899

#

4900

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

4901

"recipients": [ # Optional. The recipient at the address.

4902

# This field may, under certain circumstances, contain multiline information.

4903

# For example, it might contain "care of" information.

4904

"A String",

4905

],

4906

"sublocality": "A String", # Optional. Sublocality of the address.

4907

# For example, this can be neighborhoods, boroughs, districts.

4908

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

4909

# the latest revision.

4910

#

4911

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4912

},

4913

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

4914

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

4915

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

4916

# LocationType#LOCALITY.

4917

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

4918

# location bounding box in which a circle with the specified radius

4919

# centered from LatLng coves the area associated with the job location.

4920

# For example, currently, "Mountain View, CA, USA" has a radius of

4921

# 7885.79 meters.

4922

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

4923

# of doubles representing degrees latitude and degrees longitude. Unless

4924

# specified otherwise, this must conform to the

4925

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

4926

# standard</a>. Values must be within normalized ranges.

4927

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

4928

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

4929

},

4930

},

4931

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4932

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

4937

# filterable_custom_fields. These fields are distinct in that the data

4938

# in these fields are not indexed. Therefore, the client cannot search

4939

# against them, nor can the client use them to list jobs.

4940

#

4941

# The key of the map can be any valid string.

4942

"a_key": { # Resource that represents the custom data not captured by the standard fields.

4943

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

4949

#

4950

# Optional but strongly recommended to be provided for the best service

4951

# experience.

4952

#

4953

# The expiration date of the job in UTC time. After 12 am on this date, the

4954

# job is marked as expired, and it no longer appears in search results.

4955

# The expired job can't be deleted or listed by the DeleteJob and

4956

# ListJobs APIs, but it can be retrieved with the GetJob API or

4957

# updated with the UpdateJob API. An expired job can be updated and

4958

# opened again by using a future expiration date. It can also remain expired.

4959

# Updating an expired job to be open fails if there is another existing open

4960

# job with same requisition_id, company_name and language_code.

4961

#

4962

# The expired jobs are retained in our system for 90 days. However, the

4963

# overall expired job count cannot exceed 3 times the maximum of open jobs

4964

# count over the past week, otherwise jobs with earlier expire time are

4965

# removed first. Expired jobs are no longer accessible after they are cleaned

4966

# out.

4967

#

4968

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

4969

# ignored and treated as expiry date not provided.

4970

#

4971

# If this value is not provided on job creation or is invalid, the job

4972

# posting expires after 30 days from the job's creation time. For example, if

4973

# the job was created on 2017/01/01 13:00AM UTC with an unspecified

4974

# expiration date, the job expires after 2017/01/31 13:00AM UTC.

4975

#

4976

# If this value is not provided on job update, it depends on the field masks

4977

# set by UpdateJobRequest.update_job_fields. If the field masks include

4978

# expiry_date, or the masks are empty meaning that every field is

4979

# updated, the job expires after 30 days from the job's last update time.

4980

# Otherwise the expiration date isn't updated.

4981

# and time zone are either specified elsewhere or are not significant. The date

4982

# is relative to the Proleptic Gregorian Calendar. This can represent:

4983

#

4984

# * A full date, with non-zero year, month and day values

4985

# * A month and day value, with a zero year, e.g. an anniversary

4986

# * A year on its own, with zero month and day values

4987

# * A year and month value, with a zero day, e.g. a credit card expiration date

4988

#

4989

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

4990

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

4991

# if specifying a year by itself or a year and month where the day is not

4992

# significant.

4993

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

4994

# a year.

4995

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

4996

# month and day.

4997

},

4998

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

4999

# is used for contracting engagements.

5000

# Dates prior to 1970/1/1 and invalid date formats are ignored.

5001

# and time zone are either specified elsewhere or are not significant. The date

5002

# is relative to the Proleptic Gregorian Calendar. This can represent:

5003

#

5004

# * A full date, with non-zero year, month and day values

5005

# * A month and day value, with a zero year, e.g. an anniversary

5006

# * A year on its own, with zero month and day values

5007

# * A year and month value, with a zero day, e.g. a credit card expiration date

5008

#

5009

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

5010

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

5011

# if specifying a year by itself or a year and month where the day is not

5012

# significant.

5013

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

5014

# a year.

5015

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

5016

# month and day.

5017

},

5018

"educationLevels": [ # Optional. The desired education level for the job, such as

5019

# "Bachelors", "Masters", "Doctorate".

5020

"A String",

5021

],

5022

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

5023

# attributes that are not covered by the provided structured fields.

5024

#

5025

# This field is a more general combination of the deprecated id-based

5026

# filterable_custom_fields and string-based

5027

# non_filterable_custom_fields.

5028

#

5029

# The keys of the map are strings up to 64 bytes and must match the

5030

# pattern: a-zA-Z*.

5031

#

5032

# At most 100 filterable and at most 100 unfilterable keys are supported.

5033

# For filterable `string_values`, across all keys at most 200 values are

5034

# allowed, with each string no more than 255 characters. For unfilterable

5035

# `string_values`, the maximum total size of `string_values` across all keys

5036

# is 50KB.

5037

"a_key": { # Custom attribute values that are either filterable or non-filterable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5038

"longValue": "A String", # Optional but at least one of string_values or long_value must

5039

# be specified.

5040

#

5041

# This field is used to perform number range search.

5042

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For

5043

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

5044

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

5045

# be specified.

5046

#

5047

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

5048

# `CASE_INSENSITIVE_MATCH`) search.

5049

# For filterable `string_values`, a maximum total number of 200 values

5050

# is allowed, with each `string_value` has a byte size of no more than

5051

# 255B. For unfilterable `string_values`, the maximum total byte size of

5052

# unfilterable `string_values` is 50KB.

5053

#

5054

# Empty strings are not allowed.

5055

"values": [ # Required. String values.

5056

"A String",

5057

],

5058

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5059

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

5060

# If false, values are not searchable.

5061

#

5062

# Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5063

},

5064

},

5065

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

5070

# the standard fields such as job_title, company_name, or

5071

# level. These custom fields store arbitrary

5072

# string values, and can be used for purposes not covered by

5073

# the structured fields. For the best search experience, use of the

5074

# structured rather than custom fields is recommended.

5075

#

5076

# Data stored in these custom fields fields are indexed and

5077

# searched against by keyword searches (see

5078

# SearchJobsRequest.custom_field_filters][]).

5079

#

5080

# The map key must be a number between 1-20. If an invalid key is

5081

# provided on job create or update, an error is returned.

5082

"a_key": { # Resource that represents the custom data not captured by the standard fields.

5083

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

5089

# any requirements for fluency that are associated with the job.

5090

#

5091

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

5092

# For more information, see

5093

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

5094

# class="external" target="_blank" }.

5095

#

5096

# If this field is unspecified and Job.description is present, detected

5097

# language code based on Job.description is assigned, otherwise

5098

# defaults to 'en_US'.

5099

"visibility": "A String", # Optional. The visibility of the job.

5100

# Defaults to JobVisibility.PRIVATE if not specified.

5101

# Currently only JobVisibility.PRIVATE is supported.

5102

"name": "A String", # Required during job update.

5103

#

5104

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

5105

# of this field in job queries and API calls is preferred over the use of

5106

# requisition_id since this value is unique.

5107

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

5108

# provided.

5109

#

5110

# A unique company identifier used by job distributors to identify an

5111

# employer's company entity. company_name takes precedence over

5112

# this field, and is the recommended field to use to identify companies.

5113

#

5114

# The maximum number of allowed characters is 255.

5115

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

5116

# The value determines the sort order of the jobs returned when searching for

5117

# jobs using the featured jobs search call, with higher promotional values

5118

# being returned first and ties being resolved by relevance sort. Only the

5119

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

5120

#

5121

# Default value is 0, and negative values are treated as 0.

5122

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

5123

# value is the time the request arrives at the server.

5124

# and time zone are either specified elsewhere or are not significant. The date

5125

# is relative to the Proleptic Gregorian Calendar. This can represent:

5126

#

5127

# * A full date, with non-zero year, month and day values

5128

# * A month and day value, with a zero year, e.g. an anniversary

5129

# * A year on its own, with zero month and day values

5130

# * A year and month value, with a zero day, e.g. a credit card expiration date

5131

#

5132

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

5133

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

5134

# if specifying a year by itself or a year and month where the day is not

5135

# significant.

5136

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

5137

# a year.

5138

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

5139

# month and day.

5140

},

5141

"applicationUrls": [ # Optional but at least one of application_urls,

5142

# application_email_list or application_instruction must be

5143

# specified.

5144

#

5145

# Use this URL field to direct an applicant to a website, for example to

5146

# link to an online application form.

5147

#

5148

# The maximum number of allowed characters is 2,000.

5149

"A String",

5150

],

5151

"companyDisplayName": "A String", # Output only. The name of the company listing the job.

5152

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

5153

# client to identify a job. This field is intended to be used by clients

5154

# for client identification and tracking of listings. A job is not allowed

5155

# to be created if there is another job with the same requisition_id,

5156

# company_name and language_code.

5157

#

5158

# The maximum number of allowed characters is 255.

5159

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

5160

# job. The use of this field is recommended

5161

# as an alternative to using the more general description field.

5162

#

5163

# This field accepts and sanitizes HTML input, and also accepts

5164

# bold, italic, ordered list, and unordered list markup tags.

5165

#

5166

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5167

"createTime": "A String", # Output only. The timestamp when this job was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5168

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

5169

# is used for contracting engagements.

5170

# Dates prior to 1970/1/1 and invalid date formats are ignored.

5171

# and time zone are either specified elsewhere or are not significant. The date

5172

# is relative to the Proleptic Gregorian Calendar. This can represent:

5173

#

5174

# * A full date, with non-zero year, month and day values

5175

# * A month and day value, with a zero year, e.g. an anniversary

5176

# * A year on its own, with zero month and day values

5177

# * A year and month value, with a zero day, e.g. a credit card expiration date

5178

#

5179

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

5180

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

5181

# if specifying a year by itself or a year and month where the day is not

5182

# significant.

5183

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

5184

# a year.

5185

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

5186

# month and day.

5187

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5188

"level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

5189

"applicationInstruction": "A String", # Optional but at least one of application_urls,

5190

# application_email_list or application_instruction must be

5191

# specified.

5192

#

5193

# Use this field to provide instructions, such as "Mail your application

5194

# to ...", that a candidate can follow to apply for the job.

5195

#

5196

# This field accepts and sanitizes HTML input, and also accepts

5197

# bold, italic, ordered list, and unordered list markup tags.

5198

#

5199

# The maximum number of allowed characters is 3,000.

5200

"benefits": [ # Optional. The benefits included with the job.

5201

"A String",

5202

],

5203

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

5204

# incentives associated with the job not including salary or pay.

5205

#

5206

# The maximum number of allowed characters is 10,000.

5207

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"locations": [ # Optional but strongly recommended for the best service experience.

5213

#

5214

# Location(s) where the emploeyer is looking to hire for this job posting.

5215

#

5216

# Specifying the full street address(es) of the hiring location enables

5217

# better API results, especially job searches by commute time.

5218

#

5219

# At most 50 locations are allowed for best search performance. If a job has

5220

# more locations, it is suggested to split it into multiple jobs with unique

5221

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

5222

# multiple jobs with the same requisition_id, company_name and

5223

# language_code are not allowed. If the original requisition_id must

5224

# be preserved, a custom field should be used for storage. It is also

5225

# suggested to group the locations that close to each other in the same job

5226

# for better search experience.

5227

#

5228

# The maximum number of allowed characters is 500.

5229

"A String",

5230

],

5231

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

5236

#

5237

# This field replaces compensation_info. Only

5238

# CompensationInfo.entries or extended_compensation_info can be set,

5239

# otherwise an exception is thrown.

5240

#

5241

# Describes job compensation.

5242

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

5243

# currency code.

5244

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

5245

#

5246

# Compensation range.

5247

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

5248

#

5249

# Decimal number.

5250

"micros": 42, # Micro (10^-6) units.

5251

# The value must be between -999,999 and +999,999 inclusive.

5252

# If `units` is positive, `micros` must be positive or zero.

5253

# If `units` is zero, `micros` can be positive, zero, or negative.

5254

# If `units` is negative, `micros` must be negative or zero.

5255

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5256

"units": "A String", # Whole units.

5257

},

5258

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

5259

#

5260

# Decimal number.

5261

"micros": 42, # Micro (10^-6) units.

5262

# The value must be between -999,999 and +999,999 inclusive.

5263

# If `units` is positive, `micros` must be positive or zero.

5264

# If `units` is zero, `micros` can be positive, zero, or negative.

5265

# If `units` is negative, `micros` must be negative or zero.

5266

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5267

"units": "A String", # Whole units.

5268

},

5269

},

5270

"entries": [ # Optional. Job compensation information.

5271

#

5272

# At most one entry can be of type

5273

# ExtendedCompensationInfo.CompensationType.BASE, which is

5274

# referred as ** base compensation entry ** for the job.

5275

{ # Deprecated. See CompensationInfo.

5276

#

5277

# A compensation entry that represents one component of compensation, such

5278

# as base pay, bonus, or other compensation type.

5279

#

5280

# Annualization: One compensation entry can be annualized if

5281

# - it contains valid amount or range.

5282

# - and its expected_units_per_year is set or can be derived.

5283

# Its annualized range is determined as (amount or range) times

5284

# expected_units_per_year.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5285

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

5286

#

5287

# Decimal number.

5288

"micros": 42, # Micro (10^-6) units.

5289

# The value must be between -999,999 and +999,999 inclusive.

5290

# If `units` is positive, `micros` must be positive or zero.

5291

# If `units` is zero, `micros` can be positive, zero, or negative.

5292

# If `units` is negative, `micros` must be negative or zero.

5293

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5294

"units": "A String", # Whole units.

5295

},

5296

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5297

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

5298

#

5299

# Compensation range.

5300

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

5301

#

5302

# Decimal number.

5303

"micros": 42, # Micro (10^-6) units.

5304

# The value must be between -999,999 and +999,999 inclusive.

5305

# If `units` is positive, `micros` must be positive or zero.

5306

# If `units` is zero, `micros` can be positive, zero, or negative.

5307

# If `units` is negative, `micros` must be negative or zero.

5308

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5309

"units": "A String", # Whole units.

5310

},

5311

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

5312

#

5313

# Decimal number.

5314

"micros": 42, # Micro (10^-6) units.

5315

# The value must be between -999,999 and +999,999 inclusive.

5316

# If `units` is positive, `micros` must be positive or zero.

5317

# If `units` is zero, `micros` can be positive, zero, or negative.

5318

# If `units` is negative, `micros` must be negative or zero.

5319

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5320

"units": "A String", # Whole units.

5321

},

5322

},

5323

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

5324

# Job.employment_types is FULLTIME, a default value is inferred

5325

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

5334

# The value must be between -999,999 and +999,999 inclusive.

5335

# If `units` is positive, `micros` must be positive or zero.

5336

# If `units` is zero, `micros` can be positive, zero, or negative.

5337

# If `units` is negative, `micros` must be negative or zero.

5338

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5339

"units": "A String", # Whole units.

5340

},

5341

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

5342

"description": "A String", # Optional. Compensation description.

5343

"unit": "A String", # Optional. Frequency of the specified amount.

5344

#

5345

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5346

},

5347

],

5348

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

5349

# the job's all CompensationEntry cannot be annualized.

5350

# See CompensationEntry for explanation on annualization and base

5351

# compensation entry.

5352

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

5353

#

5354

# Compensation range.

5355

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

5356

#

5357

# Decimal number.

5358

"micros": 42, # Micro (10^-6) units.

5359

# The value must be between -999,999 and +999,999 inclusive.

5360

# If `units` is positive, `micros` must be positive or zero.

5361

# If `units` is zero, `micros` can be positive, zero, or negative.

5362

# If `units` is negative, `micros` must be negative or zero.

5363

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5364

"units": "A String", # Whole units.

5365

},

5366

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

5367

#

5368

# Decimal number.

5369

"micros": 42, # Micro (10^-6) units.

5370

# The value must be between -999,999 and +999,999 inclusive.

5371

# If `units` is positive, `micros` must be positive or zero.

5372

# If `units` is zero, `micros` can be positive, zero, or negative.

5373

# If `units` is negative, `micros` must be negative or zero.

5374

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

5375

"units": "A String", # Whole units.

5376

},

5377

},

5378

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

5379

# the job's base compensation entry cannot be annualized.

5380

# See CompensationEntry for explanation on annualization and base

5381

# compensation entry.

5382

},

5383

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

5384

# provided.

5385

#

5386

# The resource name of the company listing the job, such as

5387

# /companies/foo. This field takes precedence over the

5388

# distributor-assigned company identifier, distributor_company_id.

5389

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

5390

# description of the company and related information. Separate fields are

5391

# provided on the job object for responsibilities,

5392

# qualifications, and other job characteristics. Use of

5393

# these separate job fields is recommended.

5394

#

5395

# This field accepts and sanitizes HTML input, and also accepts

5396

# bold, italic, ordered list, and unordered list markup tags.

5397

#

5398

# The maximum number of allowed characters is 100,000.

5399

"applicationEmailList": [ # Optional but at least one of application_urls,

5400

# application_email_list or application_instruction must be

5401

# specified.

5402

#

5403

# Use this field to specify email address(es) to which resumes or

5404

# applications can be sent.

5405

#

5406

# The maximum number of allowed characters is 255.

5407

"A String",

5408

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5409

},

5410

"processingOptions": { # Input only. # Optional. Options for job processing.

5411

#

5412

# UpdateJobRequest.disable_street_address_resolution is ignored if this

5413

# flag is set.

5414

#

5415

# Options for job processing.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5416

"htmlSanitization": "A String", # Optional. Option for job HTML content sanitization. Applied fields are:

5417

#

5418

# * description

5419

# * applicationInstruction

# * incentives

# * qualifications

# * responsibilities

#

# HTML tags in these fields may be stripped if sanitiazation is not disabled.

5425

#

5426

# Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5427

"disableStreetAddressResolution": True or False, # Optional. If set to `true`, the service does not attempt to resolve a

5428

# more precise address for the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5429

},

5430

"disableStreetAddressResolution": True or False, # Deprecated. Please use processing_options. This flag is ignored if

5431

# processing_options is set.

#

# Optional.

#

# If set to `true`, the service does not attempt resolve a more precise

5436

# address for the job.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5437

}

5438

5439

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5446

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5447

{ # A Job resource represents a job posting (also referred to as a "job listing"

5448

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5449

# entity responsible for the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5450

"jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"

5451

#

5452

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5453

"region": "A String", # Optional. The job Region (for example, state, country) throughout which the job

5454

# is available. If this field is set, a

5455

# LocationFilter in a search query within the job region

5456

# finds this job if an exact location match is not specified.

5457

# If this field is set, setting job locations

5458

# to the same location level as this field is strongly recommended.

5459

"referenceUrl": "A String", # Output only. The URL of a web page that displays job details.

5460

"companyTitle": "A String", # Deprecated. Use company_display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5461

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5462

# Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5463

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5464

# The name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5465

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

5466

# recommended as an alternative to using the more general description

5467

# field.

5468

#

5469

# This field accepts and sanitizes HTML input, and also accepts

5470

# bold, italic, ordered list, and unordered list markup tags.

5471

#

5472

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5473

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5474

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

5475

# all compensation entries' CompensationEntry.compensation times

5476

# CompensationEntry.expected_units_per_year.

5477

#

5478

# See CompensationEntry for explanation on compensation annualization.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5479

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5480

# to a maximal compensation value and the currency code is set to

5481

# match the currency code of

5482

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5483

"units": "A String", # The whole units of the amount.

5484

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5485

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5486

"nanos": 42, # Number of nano (10^-9) units of the amount.

5487

# The value must be between -999,999,999 and +999,999,999 inclusive.

5488

# If `units` is positive, `nanos` must be positive or zero.

5489

# If `units` is zero, `nanos` can be positive, zero, or negative.

5490

# If `units` is negative, `nanos` must be negative or zero.

5491

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5492

},

5493

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5494

# to zero and the currency code is set to match the

5495

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5496

"units": "A String", # The whole units of the amount.

5497

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5498

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5499

"nanos": 42, # Number of nano (10^-9) units of the amount.

5500

# The value must be between -999,999,999 and +999,999,999 inclusive.

5501

# If `units` is positive, `nanos` must be positive or zero.

5502

# If `units` is zero, `nanos` can be positive, zero, or negative.

5503

# If `units` is negative, `nanos` must be negative or zero.

5504

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5505

},

5506

},

5507

"min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# A lower bound on a range for compensation or pay for the job.

5512

# The currency type is specified in compensation_amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5513

"units": "A String", # The whole units of the amount.

5514

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5515

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5516

"nanos": 42, # Number of nano (10^-9) units of the amount.

5517

# The value must be between -999,999,999 and +999,999,999 inclusive.

5518

# If `units` is positive, `nanos` must be positive or zero.

5519

# If `units` is zero, `nanos` can be positive, zero, or negative.

5520

# If `units` is negative, `nanos` must be negative or zero.

5521

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5522

},

5523

"entries": [ # Optional. Job compensation information.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5524

#

5525

# At most one entry can be of type

5526

# CompensationInfo.CompensationType.BASE, which is

5527

# referred as ** base compensation entry ** for the job.

5528

{ # A compensation entry that represents one component of compensation, such

5529

# as base pay, bonus, or other compensation type.

5530

#

5531

# Annualization: One compensation entry can be annualized if

5532

# - it contains valid amount or range.

5533

# - and its expected_units_per_year is set or can be derived.

5534

# Its annualized range is determined as (amount or range) times

5535

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5536

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5537

# Job.employment_types is FULLTIME, a default value is inferred

5538

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5544

"description": "A String", # Optional. Compensation description. For example, could

5545

# indicate equity terms or provide additional context to an estimated

5546

# bonus.

5547

"unit": "A String", # Optional. Frequency of the specified amount.

5548

#

5549

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

5550

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5551

"units": "A String", # The whole units of the amount.

5552

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5553

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5554

"nanos": 42, # Number of nano (10^-9) units of the amount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5555

# The value must be between -999,999,999 and +999,999,999 inclusive.

5556

# If `units` is positive, `nanos` must be positive or zero.

5557

# If `units` is zero, `nanos` can be positive, zero, or negative.

5558

# If `units` is negative, `nanos` must be negative or zero.

5559

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5560

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5561

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5562

"range": { # Compensation range. # Optional. Compensation range.

5563

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5564

# to a maximal compensation value and the currency code is set to

5565

# match the currency code of

5566

# min_compensation.

5567

"units": "A String", # The whole units of the amount.

5568

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5569

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5570

"nanos": 42, # Number of nano (10^-9) units of the amount.

5571

# The value must be between -999,999,999 and +999,999,999 inclusive.

5572

# If `units` is positive, `nanos` must be positive or zero.

5573

# If `units` is zero, `nanos` can be positive, zero, or negative.

5574

# If `units` is negative, `nanos` must be negative or zero.

5575

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5576

},

5577

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5578

# to zero and the currency code is set to match the

5579

# currency code of max_compensation.

5580

"units": "A String", # The whole units of the amount.

5581

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5582

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5583

"nanos": 42, # Number of nano (10^-9) units of the amount.

5584

# The value must be between -999,999,999 and +999,999,999 inclusive.

5585

# If `units` is positive, `nanos` must be positive or zero.

5586

# If `units` is zero, `nanos` can be positive, zero, or negative.

5587

# If `units` is negative, `nanos` must be negative or zero.

5588

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5589

},

5590

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5591

},

5592

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5593

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

5594

# base compensation entry's CompensationEntry.compensation times

5595

# CompensationEntry.expected_units_per_year.

5596

#

5597

# See CompensationEntry for explanation on compensation annualization.

5598

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

5599

# to a maximal compensation value and the currency code is set to

5600

# match the currency code of

5601

# min_compensation.

5602

"units": "A String", # The whole units of the amount.

5603

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5604

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5605

"nanos": 42, # Number of nano (10^-9) units of the amount.

5606

# The value must be between -999,999,999 and +999,999,999 inclusive.

5607

# If `units` is positive, `nanos` must be positive or zero.

5608

# If `units` is zero, `nanos` can be positive, zero, or negative.

5609

# If `units` is negative, `nanos` must be negative or zero.

5610

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5611

},

5612

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

5613

# to zero and the currency code is set to match the

5614

# currency code of max_compensation.

5615

"units": "A String", # The whole units of the amount.

5616

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5617

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5618

"nanos": 42, # Number of nano (10^-9) units of the amount.

5619

# The value must be between -999,999,999 and +999,999,999 inclusive.

5620

# If `units` is positive, `nanos` must be positive or zero.

5621

# If `units` is zero, `nanos` can be positive, zero, or negative.

5622

# If `units` is negative, `nanos` must be negative or zero.

5623

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5624

},

5625

},

5626

"amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# The amount of compensation or pay for the job.

5631

# As an alternative, compensation_amount_min and

5632

# compensation_amount_max may be used to define a range of

5633

# compensation.

5634

"units": "A String", # The whole units of the amount.

5635

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5636

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5637

"nanos": 42, # Number of nano (10^-9) units of the amount.

5638

# The value must be between -999,999,999 and +999,999,999 inclusive.

5639

# If `units` is positive, `nanos` must be positive or zero.

5640

# If `units` is zero, `nanos` can be positive, zero, or negative.

5641

# If `units` is negative, `nanos` must be negative or zero.

5642

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5643

},

5644

"type": "A String", # Deprecated. Use entries instead.

#

# Optional.

#

# Type of job compensation.

5649

"max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# An upper bound on a range for compensation or pay for the job.

5654

# The currency type is specified in compensation_amount.

5655

"units": "A String", # The whole units of the amount.

5656

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5657

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5658

"nanos": 42, # Number of nano (10^-9) units of the amount.

5659

# The value must be between -999,999,999 and +999,999,999 inclusive.

5660

# If `units` is positive, `nanos` must be positive or zero.

5661

# If `units` is zero, `nanos` can be positive, zero, or negative.

5662

# If `units` is negative, `nanos` must be negative or zero.

5663

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5664

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5665

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5666

"expireTime": "A String", # Optional but strongly recommended for the best service

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5667

# experience.

5668

#

5669

# The expiration timestamp of the job. After this timestamp, the

5670

# job is marked as expired, and it no longer appears in search results. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5671

# expired job can't be deleted or listed by the DeleteJob and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5672

# ListJobs APIs, but it can be retrieved with the GetJob API or

5673

# updated with the UpdateJob API. An expired job can be updated and

5674

# opened again by using a future expiration timestamp. Updating an expired

5675

# job fails if there is another existing open job with same

5676

# requisition_id, company_name and language_code.

5677

#

5678

# The expired jobs are retained in our system for 90 days. However, the

5679

# overall expired job count cannot exceed 3 times the maximum of open jobs

5680

# count over the past week, otherwise jobs with earlier expire time are

5681

# cleaned first. Expired jobs are no longer accessible after they are cleaned

5682

# out.

5683

# The format of this field is RFC 3339 date strings. Example:

5684

# 2000-01-01T00:00:00.999999999Z

5685

# See

5686

# [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).

5687

#

5688

# A valid date range is between 1970-01-01T00:00:00.0Z and

5689

# 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire

5690

# time not provided.

5691

#

5692

# If this value is not provided at the time of job creation or is invalid,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5693

# the job posting expires after 30 days from the job's creation time. For

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5694

# example, if the job was created on 2017/01/01 13:00AM UTC with an

5695

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

5696

#

5697

# If this value is not provided but expiry_date is, expiry_date is

5698

# used.

5699

#

5700

# If this value is not provided on job update, it depends on the field masks

5701

# set by UpdateJobRequest.update_job_fields. If the field masks include

5702

# expiry_time, or the masks are empty meaning that every field is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5703

# updated, the job posting expires after 30 days from the job's last

5704

# update time. Otherwise the expiration date isn't updated.

5705

"updateTime": "A String", # Output only. The timestamp when this job was last updated.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5706

"department": "A String", # Optional. The department or functional area within the company with the open

5707

# position.

5708

#

5709

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5710

"jobLocations": [ # Output only. Structured locations of the job, resolved from locations.

5711

{ # Output only.

5712

#

5713

# A resource that represents a location with full geographic

5714

# information.

5715

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

5716

# such as postal delivery and payments addresses. Given a postal address,

5717

# a postal service can deliver items to a premises, P.O. Box, or other

5718

# delivery location.

5719

# Given a postal address, a postal service can deliver items to a premise, P.O.

5720

# Box or similar.

5721

# It is not intended to model geographical locations (roads, towns,

5722

# mountains).

5723

#

5724

# In typical usage an address would be created via user input or from importing

5725

# existing data, depending on the type of process.

5726

#

5727

# Advice on address input / editing:

5728

# - Use an i18n-ready address widget such as

5729

# https://github.com/google/libaddressinput)

5730

# - Users should not be presented with UI elements for input or editing of

5731

# fields outside countries where that field is used.

5732

#

5733

# For more guidance on how to use this schema, please see:

5734

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5735

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

5736

# Examples: US city, IT comune, UK post town.

5737

# In regions of the world where localities are not well defined or do not fit

5738

# into this structure well, leave locality empty and use address_lines.

5739

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

5740

# addresses of a country or region.

5741

# For example, this can be a state, a province, an oblast, or a prefecture.

5742

# Specifically, for Spain this is the province and not the autonomous

5743

# community (e.g. "Barcelona" and not "Catalonia").

5744

# Many countries don't use an administrative area in postal addresses. E.g.

5745

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5746

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5747

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

5748

#

5749

# Because values in address_lines do not have type information and may

5750

# sometimes contain multiple values in a single field (e.g.

5751

# "Austin, TX"), it is important that the line order is clear. The order of

5752

# address lines should be "envelope order" for the country/region of the

5753

# address. In places where this can vary (e.g. Japan), address_language is

5754

# used to make it explicit (e.g. "ja" for large-to-small ordering and

5755

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

5756

# an address can be selected based on the language.

5757

#

5758

# The minimum permitted structural representation of an address consists

5759

# of a region_code with all remaining information placed in the

5760

# address_lines. It would be possible to format such an address very

5761

# approximately without geocoding, but no semantic reasoning could be

5762

# made about any of the address components until it was at least

5763

# partially resolved.

5764

#

5765

# Creating an address only containing a region_code and address_lines, and

5766

# then geocoding is the recommended way to handle completely unstructured

5767

# addresses (as opposed to guessing which parts of the address should be

5768

# localities or administrative areas).

5769

"A String",

5770

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5771

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

5772

# is never inferred and it is up to the user to ensure the value is

5773

# correct. See http://cldr.unicode.org/ and

5774

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

5775

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5776

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

5777

# postal codes to be present, but where they are used, they may trigger

5778

# additional validation with other parts of the address (e.g. state/zip

5779

# validation in the U.S.A.).

5780

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

5781

# in most regions. Where it is used, the value is either a string like

5782

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

5783

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

5784

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

5785

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

5786

# known). This is often the UI language of the input form or is expected

5787

# to match one of the languages used in the address' country/region, or their

5788

# transliterated equivalents.

5789

# This can affect formatting in certain countries, but is not critical

5790

# to the correctness of the data and will never affect any validation or

5791

# other non-formatting related operations.

5792

#

5793

# If this value is not known, it should be omitted (rather than specifying a

5794

# possibly incorrect default).

5795

#

5796

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

5797

"recipients": [ # Optional. The recipient at the address.

5798

# This field may, under certain circumstances, contain multiline information.

5799

# For example, it might contain "care of" information.

5800

"A String",

5801

],

5802

"sublocality": "A String", # Optional. Sublocality of the address.

5803

# For example, this can be neighborhoods, boroughs, districts.

5804

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

5805

# the latest revision.

5806

#

5807

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5808

},

5809

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

5810

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

5811

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

5812

# LocationType#LOCALITY.

5813

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

5814

# location bounding box in which a circle with the specified radius

5815

# centered from LatLng coves the area associated with the job location.

5816

# For example, currently, "Mountain View, CA, USA" has a radius of

5817

# 7885.79 meters.

5818

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

5819

# of doubles representing degrees latitude and degrees longitude. Unless

5820

# specified otherwise, this must conform to the

5821

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

5822

# standard</a>. Values must be within normalized ranges.

5823

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

5824

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

5825

},

5826

},

5827

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5828

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

5833

# filterable_custom_fields. These fields are distinct in that the data

5834

# in these fields are not indexed. Therefore, the client cannot search

5835

# against them, nor can the client use them to list jobs.

5836

#

5837

# The key of the map can be any valid string.

5838

"a_key": { # Resource that represents the custom data not captured by the standard fields.

5839

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

5845

#

5846

# Optional but strongly recommended to be provided for the best service

5847

# experience.

5848

#

5849

# The expiration date of the job in UTC time. After 12 am on this date, the

5850

# job is marked as expired, and it no longer appears in search results.

5851

# The expired job can't be deleted or listed by the DeleteJob and

5852

# ListJobs APIs, but it can be retrieved with the GetJob API or

5853

# updated with the UpdateJob API. An expired job can be updated and

5854

# opened again by using a future expiration date. It can also remain expired.

5855

# Updating an expired job to be open fails if there is another existing open

5856

# job with same requisition_id, company_name and language_code.

5857

#

5858

# The expired jobs are retained in our system for 90 days. However, the

5859

# overall expired job count cannot exceed 3 times the maximum of open jobs

5860

# count over the past week, otherwise jobs with earlier expire time are

5861

# removed first. Expired jobs are no longer accessible after they are cleaned

5862

# out.

5863

#

5864

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

5865

# ignored and treated as expiry date not provided.

5866

#

5867

# If this value is not provided on job creation or is invalid, the job

5868

# posting expires after 30 days from the job's creation time. For example, if

5869

# the job was created on 2017/01/01 13:00AM UTC with an unspecified

5870

# expiration date, the job expires after 2017/01/31 13:00AM UTC.

5871

#

5872

# If this value is not provided on job update, it depends on the field masks

5873

# set by UpdateJobRequest.update_job_fields. If the field masks include

5874

# expiry_date, or the masks are empty meaning that every field is

5875

# updated, the job expires after 30 days from the job's last update time.

5876

# Otherwise the expiration date isn't updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5877

# and time zone are either specified elsewhere or are not significant. The date

5878

# is relative to the Proleptic Gregorian Calendar. This can represent:

5879

#

5880

# * A full date, with non-zero year, month and day values

5881

# * A month and day value, with a zero year, e.g. an anniversary

5882

# * A year on its own, with zero month and day values

5883

# * A year and month value, with a zero day, e.g. a credit card expiration date

5884

#

5885

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5886

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5887

# if specifying a year by itself or a year and month where the day is not

5888

# significant.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5889

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5890

# a year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5891

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

5892

# month and day.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5893

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5894

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

5895

# is used for contracting engagements.

5896

# Dates prior to 1970/1/1 and invalid date formats are ignored.

5897

# and time zone are either specified elsewhere or are not significant. The date

5898

# is relative to the Proleptic Gregorian Calendar. This can represent:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5899

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5900

# * A full date, with non-zero year, month and day values

5901

# * A month and day value, with a zero year, e.g. an anniversary

5902

# * A year on its own, with zero month and day values

5903

# * A year and month value, with a zero day, e.g. a credit card expiration date

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5904

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5905

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

5906

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

5907

# if specifying a year by itself or a year and month where the day is not

5908

# significant.

5909

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

5910

# a year.

5911

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

5912

# month and day.

5913

},

5914

"educationLevels": [ # Optional. The desired education level for the job, such as

5915

# "Bachelors", "Masters", "Doctorate".

5916

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5917

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5918

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5919

# attributes that are not covered by the provided structured fields.

5920

#

5921

# This field is a more general combination of the deprecated id-based

5922

# filterable_custom_fields and string-based

5923

# non_filterable_custom_fields.

5924

#

5925

# The keys of the map are strings up to 64 bytes and must match the

5926

# pattern: a-zA-Z*.

5927

#

5928

# At most 100 filterable and at most 100 unfilterable keys are supported.

5929

# For filterable `string_values`, across all keys at most 200 values are

5930

# allowed, with each string no more than 255 characters. For unfilterable

5931

# `string_values`, the maximum total size of `string_values` across all keys

5932

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5933

"a_key": { # Custom attribute values that are either filterable or non-filterable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5934

"longValue": "A String", # Optional but at least one of string_values or long_value must

5935

# be specified.

5936

#

5937

# This field is used to perform number range search.

5938

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For

5939

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

5940

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5941

# be specified.

5942

#

5943

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

5944

# `CASE_INSENSITIVE_MATCH`) search.

5945

# For filterable `string_values`, a maximum total number of 200 values

5946

# is allowed, with each `string_value` has a byte size of no more than

5947

# 255B. For unfilterable `string_values`, the maximum total byte size of

5948

# unfilterable `string_values` is 50KB.

5949

#

5950

# Empty strings are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5951

"values": [ # Required. String values.

5952

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5953

],

5954

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5955

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

5956

# If false, values are not searchable.

5957

#

5958

# Default is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5959

},

5960

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5961

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

5966

# the standard fields such as job_title, company_name, or

5967

# level. These custom fields store arbitrary

5968

# string values, and can be used for purposes not covered by

5969

# the structured fields. For the best search experience, use of the

5970

# structured rather than custom fields is recommended.

5971

#

5972

# Data stored in these custom fields fields are indexed and

5973

# searched against by keyword searches (see

5974

# SearchJobsRequest.custom_field_filters][]).

5975

#

5976

# The map key must be a number between 1-20. If an invalid key is

5977

# provided on job create or update, an error is returned.

5978

"a_key": { # Resource that represents the custom data not captured by the standard fields.

5979

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

5985

# any requirements for fluency that are associated with the job.

5986

#

5987

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

5988

# For more information, see

5989

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

5990

# class="external" target="_blank" }.

5991

#

5992

# If this field is unspecified and Job.description is present, detected

5993

# language code based on Job.description is assigned, otherwise

5994

# defaults to 'en_US'.

5995

"visibility": "A String", # Optional. The visibility of the job.

5996

# Defaults to JobVisibility.PRIVATE if not specified.

5997

# Currently only JobVisibility.PRIVATE is supported.

5998

"name": "A String", # Required during job update.

5999

#

6000

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

6001

# of this field in job queries and API calls is preferred over the use of

6002

# requisition_id since this value is unique.

6003

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6004

# provided.

6005

#

6006

# A unique company identifier used by job distributors to identify an

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6007

# employer's company entity. company_name takes precedence over

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6008

# this field, and is the recommended field to use to identify companies.

6009

#

6010

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6011

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

6012

# The value determines the sort order of the jobs returned when searching for

6013

# jobs using the featured jobs search call, with higher promotional values

6014

# being returned first and ties being resolved by relevance sort. Only the

6015

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

6016

#

6017

# Default value is 0, and negative values are treated as 0.

6018

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

6019

# value is the time the request arrives at the server.

6020

# and time zone are either specified elsewhere or are not significant. The date

6021

# is relative to the Proleptic Gregorian Calendar. This can represent:

6022

#

6023

# * A full date, with non-zero year, month and day values

6024

# * A month and day value, with a zero year, e.g. an anniversary

6025

# * A year on its own, with zero month and day values

6026

# * A year and month value, with a zero day, e.g. a credit card expiration date

6027

#

6028

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

6029

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

6030

# if specifying a year by itself or a year and month where the day is not

6031

# significant.

6032

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

6033

# a year.

6034

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

6035

# month and day.

6036

},

6037

"applicationUrls": [ # Optional but at least one of application_urls,

6038

# application_email_list or application_instruction must be

6039

# specified.

6040

#

6041

# Use this URL field to direct an applicant to a website, for example to

6042

# link to an online application form.

6043

#

6044

# The maximum number of allowed characters is 2,000.

6045

"A String",

6046

],

6047

"companyDisplayName": "A String", # Output only. The name of the company listing the job.

6048

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

6049

# client to identify a job. This field is intended to be used by clients

6050

# for client identification and tracking of listings. A job is not allowed

6051

# to be created if there is another job with the same requisition_id,

6052

# company_name and language_code.

6053

#

6054

# The maximum number of allowed characters is 255.

6055

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

6056

# job. The use of this field is recommended

6057

# as an alternative to using the more general description field.

6058

#

6059

# This field accepts and sanitizes HTML input, and also accepts

6060

# bold, italic, ordered list, and unordered list markup tags.

6061

#

6062

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6063

"createTime": "A String", # Output only. The timestamp when this job was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6064

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

6065

# is used for contracting engagements.

6066

# Dates prior to 1970/1/1 and invalid date formats are ignored.

6067

# and time zone are either specified elsewhere or are not significant. The date

6068

# is relative to the Proleptic Gregorian Calendar. This can represent:

6069

#

6070

# * A full date, with non-zero year, month and day values

6071

# * A month and day value, with a zero year, e.g. an anniversary

6072

# * A year on its own, with zero month and day values

6073

# * A year and month value, with a zero day, e.g. a credit card expiration date

6074

#

6075

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

6076

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

6077

# if specifying a year by itself or a year and month where the day is not

6078

# significant.

6079

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

6080

# a year.

6081

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

6082

# month and day.

6083

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6084

"level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

6085

"applicationInstruction": "A String", # Optional but at least one of application_urls,

6086

# application_email_list or application_instruction must be

6087

# specified.

6088

#

6089

# Use this field to provide instructions, such as "Mail your application

6090

# to ...", that a candidate can follow to apply for the job.

6091

#

6092

# This field accepts and sanitizes HTML input, and also accepts

6093

# bold, italic, ordered list, and unordered list markup tags.

6094

#

6095

# The maximum number of allowed characters is 3,000.

6096

"benefits": [ # Optional. The benefits included with the job.

6097

"A String",

6098

],

6099

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

6100

# incentives associated with the job not including salary or pay.

6101

#

6102

# The maximum number of allowed characters is 10,000.

6103

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"locations": [ # Optional but strongly recommended for the best service experience.

6109

#

6110

# Location(s) where the emploeyer is looking to hire for this job posting.

6111

#

6112

# Specifying the full street address(es) of the hiring location enables

6113

# better API results, especially job searches by commute time.

6114

#

6115

# At most 50 locations are allowed for best search performance. If a job has

6116

# more locations, it is suggested to split it into multiple jobs with unique

6117

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

6118

# multiple jobs with the same requisition_id, company_name and

6119

# language_code are not allowed. If the original requisition_id must

6120

# be preserved, a custom field should be used for storage. It is also

6121

# suggested to group the locations that close to each other in the same job

6122

# for better search experience.

6123

#

6124

# The maximum number of allowed characters is 500.

6125

"A String",

6126

],

6127

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

6132

#

6133

# This field replaces compensation_info. Only

6134

# CompensationInfo.entries or extended_compensation_info can be set,

6135

# otherwise an exception is thrown.

6136

#

6137

# Describes job compensation.

6138

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

6139

# currency code.

6140

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

6141

#

6142

# Compensation range.

6143

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

6144

#

6145

# Decimal number.

6146

"micros": 42, # Micro (10^-6) units.

6147

# The value must be between -999,999 and +999,999 inclusive.

6148

# If `units` is positive, `micros` must be positive or zero.

6149

# If `units` is zero, `micros` can be positive, zero, or negative.

6150

# If `units` is negative, `micros` must be negative or zero.

6151

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6152

"units": "A String", # Whole units.

6153

},

6154

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

6155

#

6156

# Decimal number.

6157

"micros": 42, # Micro (10^-6) units.

6158

# The value must be between -999,999 and +999,999 inclusive.

6159

# If `units` is positive, `micros` must be positive or zero.

6160

# If `units` is zero, `micros` can be positive, zero, or negative.

6161

# If `units` is negative, `micros` must be negative or zero.

6162

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6163

"units": "A String", # Whole units.

6164

},

6165

},

6166

"entries": [ # Optional. Job compensation information.

6167

#

6168

# At most one entry can be of type

6169

# ExtendedCompensationInfo.CompensationType.BASE, which is

6170

# referred as ** base compensation entry ** for the job.

6171

{ # Deprecated. See CompensationInfo.

6172

#

6173

# A compensation entry that represents one component of compensation, such

6174

# as base pay, bonus, or other compensation type.

6175

#

6176

# Annualization: One compensation entry can be annualized if

6177

# - it contains valid amount or range.

6178

# - and its expected_units_per_year is set or can be derived.

6179

# Its annualized range is determined as (amount or range) times

6180

# expected_units_per_year.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6181

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

6182

#

6183

# Decimal number.

6184

"micros": 42, # Micro (10^-6) units.

6185

# The value must be between -999,999 and +999,999 inclusive.

6186

# If `units` is positive, `micros` must be positive or zero.

6187

# If `units` is zero, `micros` can be positive, zero, or negative.

6188

# If `units` is negative, `micros` must be negative or zero.

6189

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6190

"units": "A String", # Whole units.

6191

},

6192

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6193

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

6194

#

6195

# Compensation range.

6196

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

6197

#

6198

# Decimal number.

6199

"micros": 42, # Micro (10^-6) units.

6200

# The value must be between -999,999 and +999,999 inclusive.

6201

# If `units` is positive, `micros` must be positive or zero.

6202

# If `units` is zero, `micros` can be positive, zero, or negative.

6203

# If `units` is negative, `micros` must be negative or zero.

6204

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6205

"units": "A String", # Whole units.

6206

},

6207

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

6208

#

6209

# Decimal number.

6210

"micros": 42, # Micro (10^-6) units.

6211

# The value must be between -999,999 and +999,999 inclusive.

6212

# If `units` is positive, `micros` must be positive or zero.

6213

# If `units` is zero, `micros` can be positive, zero, or negative.

6214

# If `units` is negative, `micros` must be negative or zero.

6215

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6216

"units": "A String", # Whole units.

6217

},

6218

},

6219

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

6220

# Job.employment_types is FULLTIME, a default value is inferred

6221

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

6230

# The value must be between -999,999 and +999,999 inclusive.

6231

# If `units` is positive, `micros` must be positive or zero.

6232

# If `units` is zero, `micros` can be positive, zero, or negative.

6233

# If `units` is negative, `micros` must be negative or zero.

6234

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6235

"units": "A String", # Whole units.

6236

},

6237

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

6238

"description": "A String", # Optional. Compensation description.

6239

"unit": "A String", # Optional. Frequency of the specified amount.

6240

#

6241

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6242

},

6243

],

6244

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

6245

# the job's all CompensationEntry cannot be annualized.

6246

# See CompensationEntry for explanation on annualization and base

6247

# compensation entry.

6248

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

6249

#

6250

# Compensation range.

6251

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

6252

#

6253

# Decimal number.

6254

"micros": 42, # Micro (10^-6) units.

6255

# The value must be between -999,999 and +999,999 inclusive.

6256

# If `units` is positive, `micros` must be positive or zero.

6257

# If `units` is zero, `micros` can be positive, zero, or negative.

6258

# If `units` is negative, `micros` must be negative or zero.

6259

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6260

"units": "A String", # Whole units.

6261

},

6262

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

6263

#

6264

# Decimal number.

6265

"micros": 42, # Micro (10^-6) units.

6266

# The value must be between -999,999 and +999,999 inclusive.

6267

# If `units` is positive, `micros` must be positive or zero.

6268

# If `units` is zero, `micros` can be positive, zero, or negative.

6269

# If `units` is negative, `micros` must be negative or zero.

6270

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6271

"units": "A String", # Whole units.

6272

},

6273

},

6274

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

6275

# the job's base compensation entry cannot be annualized.

6276

# See CompensationEntry for explanation on annualization and base

6277

# compensation entry.

6278

},

6279

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

6280

# provided.

6281

#

6282

# The resource name of the company listing the job, such as

6283

# /companies/foo. This field takes precedence over the

6284

# distributor-assigned company identifier, distributor_company_id.

6285

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

6286

# description of the company and related information. Separate fields are

6287

# provided on the job object for responsibilities,

6288

# qualifications, and other job characteristics. Use of

6289

# these separate job fields is recommended.

6290

#

6291

# This field accepts and sanitizes HTML input, and also accepts

6292

# bold, italic, ordered list, and unordered list markup tags.

6293

#

6294

# The maximum number of allowed characters is 100,000.

6295

"applicationEmailList": [ # Optional but at least one of application_urls,

6296

# application_email_list or application_instruction must be

6297

# specified.

6298

#

6299

# Use this field to specify email address(es) to which resumes or

6300

# applications can be sent.

6301

#

6302

# The maximum number of allowed characters is 255.

6303

"A String",

6304

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6309

<code class="details" id="search">search(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6310

<pre>Searches for jobs using the provided SearchJobsRequest.

6311

6312

This call constrains the visibility of jobs

6313

present in the database, and only returns jobs that the caller has

6314

permission to search against.

6315

6316

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6317

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6318

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6323

"mode": "A String", # Required. Mode of a search.

6324

"offset": 42, # Optional. An integer that specifies the current offset (that is, starting result

6325

# location, amongst the jobs deemed by the API as relevant) in search

6326

# results. This field is only considered if page_token is unset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6327

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6328

# For example, 0 means to return results starting from the first matching

6329

# job, and 10 means to return from the 11th job. This can be used for

6330

# pagination, (for example, pageSize = 10 and offset = 10 means to return

6331

# from the second page).

6332

"pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.

6333

# Increasing this value above the default value of 10 can increase search

6334

# response time. The value can be between 1 and 100.

6335

"query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6336

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6337

# The query required to perform a search query or histogram.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6338

"query": "A String", # Optional. The query string that matches against the job title, description, and

6339

# location fields.

6340

#

6341

# The maximum query size is 255 bytes.

6342

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

6343

# Job.compensation_info. For example, if the filter is specified

6344

# as "Hourly job with per-hour compensation > $15", only jobs meeting

6345

# these criteria are searched. If a filter isn't defined, all open jobs

6346

# are searched.

6347

#

6348

# Filter on job compensation type and amount.

6349

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

6350

"units": [ # Required. Specify desired `base compensation entry's`

6351

# CompensationInfo.CompensationUnit.

6352

"A String",

6353

],

6354

"range": { # Compensation range. # Optional. Compensation range.

6355

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

6356

# to a maximal compensation value and the currency code is set to

6357

# match the currency code of

6358

# min_compensation.

6359

"units": "A String", # The whole units of the amount.

6360

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6361

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6362

"nanos": 42, # Number of nano (10^-9) units of the amount.

6363

# The value must be between -999,999,999 and +999,999,999 inclusive.

6364

# If `units` is positive, `nanos` must be positive or zero.

6365

# If `units` is zero, `nanos` can be positive, zero, or negative.

6366

# If `units` is negative, `nanos` must be negative or zero.

6367

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6368

},

6369

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

6370

# to zero and the currency code is set to match the

6371

# currency code of max_compensation.

6372

"units": "A String", # The whole units of the amount.

6373

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6374

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6375

"nanos": 42, # Number of nano (10^-9) units of the amount.

6376

# The value must be between -999,999,999 and +999,999,999 inclusive.

6377

# If `units` is positive, `nanos` must be positive or zero.

6378

# If `units` is zero, `nanos` can be positive, zero, or negative.

6379

# If `units` is negative, `nanos` must be negative or zero.

6380

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6381

},

6382

},

6383

"type": "A String", # Required. Type of filter.

6384

},

6385

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

6386

# service attempts to correct a misspelled query,

6387

# for example, "enginee" is corrected to "engineer".

6388

#

6389

# Defaults to false: a spell check is performed.

6390

"companyDisplayNames": [ # Optional. This filter specifies the exact company display

6391

# name of the jobs to search against.

6392

#

6393

# If a value isn't specified, jobs within the search results are

6394

# associated with any company.

6395

#

6396

# If multiple values are specified, jobs within the search results may be

6397

# associated with any of the specified companies.

6398

#

6399

# At most 20 company display name filters are allowed.

6400

"A String",

6401

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6402

"companyNames": [ # Optional. This filter specifies the company entities to search against.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6403

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6404

# If a value isn't specified, jobs are searched for against all

6405

# companies.

6406

#

6407

# If multiple values are specified, jobs are searched against the

6408

# companies specified.

6409

#

6410

# At most 20 company filters are allowed.

6411

"A String",

6412

],

6413

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

6414

# search against, such as EmploymentType.FULL_TIME.

6415

#

6416

# If a value is not specified, jobs in the search results include any

6417

# employment type.

6418

#

6419

# If multiple values are specified, jobs in the search results include

6420

# any of the specified employment types.

6421

"A String",

6422

],

6423

"categories": [ # Optional. The category filter specifies the categories of jobs to search against.

6424

# See Category for more information.

6425

#

6426

# If a value is not specified, jobs from any category are searched against.

6427

#

6428

# If multiple values are specified, jobs from any of the specified

6429

# categories are searched against.

6430

"A String",

6431

],

6432

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

6433

# Job.custom_attributes marked as `filterable`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6434

#

6435

# The syntax for this expression is a subset of Google SQL syntax.

6436

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6437

# Supported operators are: =, !=, <, <=, >, >= where the left of the operator

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6438

# is a custom field key and the right of the operator is a number or string

6439

# (surrounded by quotes) value.

6440

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6441

# Supported functions are LOWER(<field_name>) to

6442

# perform case insensitive match and EMPTY(<field_name>) to filter on the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6443

# existence of a key.

6444

#

6445

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6446

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50

6447

# comparisons/functions are allowed in the expression. The expression

6448

# must be < 2000 characters in length.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6449

#

6450

# Sample Query:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6451

# (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100

6452

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

6453

# search against. See LocationFilter for more information.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6454

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6455

# If a location value isn't specified, jobs fitting the other search

6456

# criteria are retrieved regardless of where they're located.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6457

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6458

# If multiple values are specified, jobs are retrieved from any of the

6459

# specified locations. If different values are specified for the

6460

# LocationFilter.distance_in_miles parameter, the maximum provided

6461

# distance is used for all locations.

6462

#

6463

# At most 5 location filters are allowed.

6464

{ # Input only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6465

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6466

# Geographic region of the search.

6467

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used

6468

# to address ambiguity of the user-input location, e.g. "Liverpool"

6469

# against "Liverpool, NY, US" or "Liverpool, UK".

6470

#

6471

# Set this field if all the jobs to search against are from a same region,

6472

# or jobs are world-wide but the job seeker is from a specific region.

6473

#

6474

# See http://cldr.unicode.org/ and

6475

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6476

# for details. Example: "CH" for Switzerland.

6477

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

6478

# identified as a city or smaller. When the location being searched for is a

6479

# state or larger, this field is ignored.

6480

"isTelecommute": True or False, # Optional. Allows the client to return jobs without a

6481

# set location, specifically, telecommuting jobs (telecomuting is considered

6482

# by the service as a special location.

6483

# Job.allow_telecommute indicates if a job permits telecommuting.

6484

# If this field is true, telecommuting jobs are searched, and

6485

# name and lat_lng are

6486

# ignored.

6487

# This filter can be used by itself to search exclusively for telecommuting

6488

# jobs, or it can be combined with another location

6489

# filter to search for a combination of job locations,

6490

# such as "Mountain View" or "telecommuting" jobs. However, when used in

6491

# combination with other location filters, telecommuting jobs can be

6492

# treated as less relevant than other jobs in the search response.

6493

"name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

6494

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

6495

# search. This field is ignored if `location_name` is provided.

6496

# of doubles representing degrees latitude and degrees longitude. Unless

6497

# specified otherwise, this must conform to the

6498

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6499

# standard</a>. Values must be within normalized ranges.

6500

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6501

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6502

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6503

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6504

],

6505

"publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched

6506

# against, for example, DateRange.PAST_MONTH. If a value isn't

6507

# specified, all open jobs are searched against regardless of their

6508

# published date.

6509

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for

6510

# example, driving or public transit). Note: This only works with COMMUTE

6511

# MODE. When specified, [JobQuery.location_filters] is

6512

# ignored.

6513

#

6514

# Currently we don't support sorting by commute time.

6515

#

6516

# Parameters needed for commute search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6517

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

6518

# commute time.

6519

# of doubles representing degrees latitude and degrees longitude. Unless

6520

# specified otherwise, this must conform to the

6521

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6522

# standard</a>. Values must be within normalized ranges.

6523

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6524

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6525

},

6526

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

6527

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

6528

# Must not be present if departure_hour_local is specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6529

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

6530

# integer between 0 and 23, representing the hour in the time zone of the

6531

# start_location. Must not be present if road_traffic is specified.

6532

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

6533

# For city level addresses, the city center is used. For state and coarser

6534

# level addresses, text matching is used.

6535

# If this field is set to `false` or is not specified, only jobs that include

6536

# street level addresses will be returned by commute search.

6537

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

6538

# (one hour). Format is `123s`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6539

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6540

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

6541

# for example, "en-US".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6542

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6543

# If a value isn't specified, the search results can contain jobs in any

6544

# locale.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6545

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6546

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6547

# Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".

6548

# For more information, see

6549

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6550

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6551

# At most 10 language code filters are allowed.

6552

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6553

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6554

},

6555

"disableRelevanceThresholding": True or False, # Optional. Controls whether to disable relevance thresholding. Relevance

6556

# thresholding removes jobs that have low relevance in search results,

6557

# for example, removing "Assistant to the CEO" positions from the search

6558

# results of a search for "CEO".

6559

#

6560

# Disabling relevance thresholding improves the accuracy of subsequent

# search requests.

#

# Defaults to false.

"enablePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise

6565

# count of the first 300 results. Setting this to `true` ensures

6566

# consistency in the number of results per page. Best practice is to set this

6567

# value to true if a client allows users to jump directly to a

6568

# non-sequential search results page.

6569

#

6570

# Enabling this flag may adversely impact performance.

6571

#

6572

# Defaults to false.

6573

"histogramFacets": { # Input only. # Optional. Restrictions on what fields to perform histogram on, such as

6574

# `COMPANY_SIZE` etc.

6575

#

6576

# Histogram facets to be specified in SearchJobsRequest.

6577

"compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.

6578

# Duplicate values of CompensationHistogramRequest.type are not allowed.

6579

{ # Input only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6580

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6581

# Compensation based histogram request.

6582

"bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6583

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6584

# Use this field to specify bucketing option for the histogram search response.

6585

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

6586

# value of the numeric field.

6587

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

6588

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

6589

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

6590

# [buckets_bound is supported.

6591

3.14,

6592

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6593

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6594

"type": "A String", # Required. Type of the request, representing which field the histogramming should be

6595

# performed over. A single request can only specify one histogram of each

6596

# `CompensationHistogramRequestType`.

6597

},

6598

],

6599

"customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.

6600

# Duplicate values of CustomAttributeHistogramRequest.key are not

6601

# allowed.

6602

{ # Custom attributes histogram request. An error will be thrown if neither

6603

# string_value_histogram or long_value_histogram_bucketing_option has

6604

# been defined.

6605

"stringValueHistogram": True or False, # Optional. If set to true, the response will include the histogram value for

6606

# each key as a string.

6607

"longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's

6608

# filterable long custom field values, or min/max value requirements.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6609

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6610

# Use this field to specify bucketing option for the histogram search response.

6611

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

6612

# value of the numeric field.

6613

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

6614

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

6615

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

6616

# [buckets_bound is supported.

6617

3.14,

6618

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6619

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6620

"key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified

6621

# without `long_value_histogram_bucketing_option`, histogram on string values

6622

# of the given `key` is triggered, otherwise histogram is performed on long

6623

# values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6624

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6625

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6626

"simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,

6627

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to

6628

# GetHistogramRequest.

6629

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6630

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6631

},

6632

"orderBy": "A String", # Deprecated. Use sort_by instead.

#

# Optional.

#

# The criteria determining how search results are sorted.

6637

# Defaults to SortBy.RELEVANCE_DESC if no value is specified.

6638

"jobView": "A String", # Optional. The number of job attributes returned for jobs in the

6639

# search response. Defaults to JobView.SMALL if no value is specified.

6640

"pageToken": "A String", # Optional. The token specifying the current offset within

6641

# search results. See SearchJobsResponse.next_page_token for

6642

# an explanation of how to obtain the next set of query results.

6643

"filters": { # Input only. # Deprecated. Use query instead.

#

# Optional.

#

# Restrictions on the scope of the search request, such as filtering

6648

# by location.

6649

#

6650

# Deprecated. Use JobQuery instead.

6651

#

6652

# The filters required to perform a search query or histogram.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6653

"categories": [ # Optional. The category filter specifies the categories of jobs to search against.

6654

# See Category for more information.

6655

#

6656

# If a value is not specified, jobs from any category are searched against.

6657

#

6658

# If multiple values are specified, jobs from any of the specified

6659

# categories are searched against.

6660

"A String",

6661

],

6662

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

6663

# Job.custom_attributes that are marked as `filterable`.

6664

#

6665

# The syntax for this expression is a subset of Google SQL syntax.

6666

#

6667

# Supported operators are: =, !=, <, <=, >, >= where the left of the operator

6668

# is a custom field key and the right of the operator is a number or string

6669

# (surrounded by quotes) value.

6670

#

6671

# Supported functions are LOWER(<field_name>) to

6672

# perform case insensitive match and EMPTY(<field_name>) to filter on the

6673

# existence of a key.

6674

#

6675

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

6676

# nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can

6677

# be a maximum of 100 comparisons/functions in the expression. The expression

6678

# must be < 3000 bytes in length.

6679

#

6680

# Sample Query:

6681

# (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6682

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6683

# search against. See LocationFilter for more information.

6684

#

6685

# If a location value is not specified, jobs are retrieved

6686

# from all locations.

6687

#

6688

# If multiple values are specified, jobs are retrieved from any of the

6689

# specified locations. If different values are specified for the

6690

# LocationFilter.distance_in_miles parameter, the maximum provided

6691

# distance is used for all locations.

6692

#

6693

# At most 5 location filters are allowed.

6694

{ # Input only.

6695

#

6696

# Geographic region of the search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6697

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used

6698

# to address ambiguity of the user-input location, e.g. "Liverpool"

6699

# against "Liverpool, NY, US" or "Liverpool, UK".

6700

#

6701

# Set this field if all the jobs to search against are from a same region,

6702

# or jobs are world-wide but the job seeker is from a specific region.

6703

#

6704

# See http://cldr.unicode.org/ and

6705

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

6706

# for details. Example: "CH" for Switzerland.

6707

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

6708

# identified as a city or smaller. When the location being searched for is a

6709

# state or larger, this field is ignored.

6710

"isTelecommute": True or False, # Optional. Allows the client to return jobs without a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6711

# set location, specifically, telecommuting jobs (telecomuting is considered

6712

# by the service as a special location.

6713

# Job.allow_telecommute indicates if a job permits telecommuting.

6714

# If this field is true, telecommuting jobs are searched, and

6715

# name and lat_lng are

6716

# ignored.

6717

# This filter can be used by itself to search exclusively for telecommuting

6718

# jobs, or it can be combined with another location

6719

# filter to search for a combination of job locations,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6720

# such as "Mountain View" or "telecommuting" jobs. However, when used in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6721

# combination with other location filters, telecommuting jobs can be

6722

# treated as less relevant than other jobs in the search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6723

"name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

6724

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6725

# search. This field is ignored if `location_name` is provided.

6726

# of doubles representing degrees latitude and degrees longitude. Unless

6727

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6728

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6729

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6730

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6731

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6732

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6733

},

6734

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6735

"publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched

6736

# against, for example, DateRange.PAST_MONTH. If a value is not

6737

# specified, all open jobs are searched against regardless of the

6738

# date they were published.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6739

"companyTitles": [ # Optional. This filter specifies the exact company titles

6740

# of jobs to search against.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6741

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6742

# If a value is not specified, jobs within the search results can be

6743

# associated with any company.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6744

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6745

# If multiple values are specified, jobs within the search results may be

6746

# associated with any of the specified companies.

6747

#

6748

# At most 20 company title filters are allowed.

6749

"A String",

6750

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6751

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

6752

# for example, "en-US".

6753

#

6754

# If a value is not specified, the search results may contain jobs in any

# locale.

#

#

# Language codes should be in BCP-47 format, for example, "en-US" or

6759

# "sr-Latn". For more information, see [Tags for Identifying

6760

# Languages](https://tools.ietf.org/html/bcp47).

6761

#

6762

# At most 10 language code filters are allowed.

6763

"A String",

6764

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6765

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g.

6766

# driving or public transit). Note: this only works with COMMUTE

6767

# MODE. When specified, [JobFilters.location_filters] will be

6768

# ignored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6769

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6770

# Currently we do not support sorting by commute time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6771

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6772

# Parameters needed for commute search.

6773

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

6774

# commute time.

6775

# of doubles representing degrees latitude and degrees longitude. Unless

6776

# specified otherwise, this must conform to the

6777

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

6778

# standard</a>. Values must be within normalized ranges.

6779

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

6780

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

6781

},

6782

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

6783

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

6784

# Must not be present if departure_hour_local is specified.

6785

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

6786

# integer between 0 and 23, representing the hour in the time zone of the

6787

# start_location. Must not be present if road_traffic is specified.

6788

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

6789

# For city level addresses, the city center is used. For state and coarser

6790

# level addresses, text matching is used.

6791

# If this field is set to `false` or is not specified, only jobs that include

6792

# street level addresses will be returned by commute search.

6793

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

6794

# (one hour). Format is `123s`.

6795

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6796

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6797

# Job.compensation_info. For example, if the filter is specified

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6798

# as "Hourly job with per-hour compensation > $15", only jobs that meet

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6799

# this criteria are searched. If a filter is not defined, all open jobs

6800

# are searched.

6801

#

6802

# Filter on job compensation type and amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6803

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

6804

"units": [ # Required. Specify desired `base compensation entry's`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6805

# CompensationInfo.CompensationUnit.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6806

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6807

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6808

"range": { # Compensation range. # Optional. Compensation range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6809

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6810

# to a maximal compensation value and the currency code is set to

6811

# match the currency code of

6812

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6813

"units": "A String", # The whole units of the amount.

6814

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6815

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6816

"nanos": 42, # Number of nano (10^-9) units of the amount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6817

# The value must be between -999,999,999 and +999,999,999 inclusive.

6818

# If `units` is positive, `nanos` must be positive or zero.

6819

# If `units` is zero, `nanos` can be positive, zero, or negative.

6820

# If `units` is negative, `nanos` must be negative or zero.

6821

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6822

},

6823

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

6824

# to zero and the currency code is set to match the

6825

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6826

"units": "A String", # The whole units of the amount.

6827

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6828

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6829

"nanos": 42, # Number of nano (10^-9) units of the amount.

6830

# The value must be between -999,999,999 and +999,999,999 inclusive.

6831

# If `units` is positive, `nanos` must be positive or zero.

6832

# If `units` is zero, `nanos` can be positive, zero, or negative.

6833

# If `units` is negative, `nanos` must be negative or zero.

6834

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6835

},

6836

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6837

"type": "A String", # Required. Type of filter.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6838

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6839

"query": "A String", # Optional. The query filter contains the keywords that match against the job

6840

# title, description, and location fields.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6841

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6842

# The maximum query size is 255 bytes/characters.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6843

"customFieldFilters": { # Deprecated. Use custom_attribute_filter instead.

#

# Optional.

#

# This filter specifies searching against

6848

# custom field values. See Job.filterable_custom_fields for information.

6849

# The key value specifies a number between 1-20 (the service

6850

# supports 20 custom fields) corresponding to the desired custom field map

6851

# value. If an invalid key is provided or specified together with

6852

# custom_attribute_filter, an error is thrown.

6853

"a_key": { # Input only.

6854

#

6855

# Custom field filter of the search.

6856

"type": "A String", # Optional. The type of filter.

6857

# Defaults to FilterType.OR.

6858

"queries": [ # Required. The query strings for the filter.

"A String",

],

},

},

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

6864

# service attempts to correct a misspelled query,

6865

# for example, "enginee" is corrected to "engineer".

6866

#

6867

# Defaults to false: a spell check is performed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6868

"extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter.

#

# Optional.

#

# This search filter is applied only to

6873

# Job.extended_compensation_info. For example, if the filter is specified

6874

# as "Hourly job with per-hour compensation > $15", only jobs that meet

6875

# these criteria are searched. If a filter is not defined, all open jobs

# are searched.

#

# Input only.

#

# Filter on job compensation type and amount.

6881

"includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

6882

"compensationUnits": [ # Required. Specify desired `base compensation entry's`

6883

# ExtendedCompensationInfo.CompensationUnit.

6884

"A String",

6885

],

6886

"type": "A String", # Required. Type of filter.

6887

"currency": "A String", # Optional. Specify currency in 3-letter

6888

# [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If

6889

# unspecified, jobs are returned regardless of currency.

6890

"compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

6891

#

6892

# Compensation range.

6893

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

6894

#

6895

# Decimal number.

6896

"micros": 42, # Micro (10^-6) units.

6897

# The value must be between -999,999 and +999,999 inclusive.

6898

# If `units` is positive, `micros` must be positive or zero.

6899

# If `units` is zero, `micros` can be positive, zero, or negative.

6900

# If `units` is negative, `micros` must be negative or zero.

6901

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6902

"units": "A String", # Whole units.

6903

},

6904

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

6905

#

6906

# Decimal number.

6907

"micros": 42, # Micro (10^-6) units.

6908

# The value must be between -999,999 and +999,999 inclusive.

6909

# If `units` is positive, `micros` must be positive or zero.

6910

# If `units` is zero, `micros` can be positive, zero, or negative.

6911

# If `units` is negative, `micros` must be negative or zero.

6912

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

6913

"units": "A String", # Whole units.

6914

},

6915

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6916

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6917

"companyNames": [ # Optional. The company names filter specifies the company entities to search

6918

# against.

6919

#

6920

# If a value is not specified, jobs are searched for against all companies.

6921

#

6922

# If multiple values are specified, jobs are searched against the

6923

# specified companies.

6924

#

6925

# At most 20 company filters are allowed.

6926

"A String",

6927

],

6928

"tenantJobOnly": True or False, # Deprecated. Do not use this field.

6929

#

6930

# This flag controls whether the job search should be restricted to jobs

6931

# owned by the current user.

6932

#

6933

# Defaults to false where all jobs accessible to the

6934

# user are searched against.

6935

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

6936

# search against, such as EmploymentType.FULL_TIME.

6937

#

6938

# If a value is not specified, jobs in the search results include any

6939

# employment type.

6940

#

6941

# If multiple values are specified, jobs in the search results include any

6942

# of the specified employment types.

6943

"A String",

6944

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6945

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6946

"requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the

6947

# search quality of the service. The identifiers, (such as `user_id`) are

6948

# provided by users, and must be unique and consistent.

6949

#

6950

# Meta information related to the job searcher or entity

6951

# conducting the job search. This information is used to improve the

6952

# performance of the service.

6953

"sessionId": "A String", # Required. A unique session identification string. A session is defined as the

6954

# duration of an end user's interaction with the service over a period.

6955

# Obfuscate this field for privacy concerns before

6956

# providing it to the API.

6957

#

6958

# If this field is not available for some reason, please send "UNKNOWN". Note

6959

# that any improvements to the service model for a particular tenant site,

6960

# rely on this field being set correctly to some unique session_id.

6961

"domain": "A String", # Required. The client-defined scope or source of the service call, which typically

6962

# is the domain on

6963

# which the service has been implemented and is currently being run.

6964

#

6965

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

6966

# job board www.foo.com and career site www.bar.com, then this field is

6967

# set to "foo.com" for use on the job board, and "bar.com" for use on the

6968

# career site.

6969

#

6970

# If this field is not available for some reason, send "UNKNOWN". Note that

6971

# any improvements to the service model for a particular tenant site rely on

6972

# this field being set correctly to some domain.

6973

"userId": "A String", # Required. A unique user identification string, as determined by the client. The

6974

# client is responsible for ensuring client-level uniqueness of this value

6975

# in order to have the strongest positive impact on search quality.

6976

# Obfuscate this field for privacy concerns before

6977

# providing it to the service.

6978

#

6979

# If this field is not available for some reason, please send "UNKNOWN". Note

6980

# that any improvements to the service model for a particular tenant site,

6981

# rely on this field being set correctly to some unique user_id.

6982

"deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the

6983

# service.

6984

#

6985

# Device information collected from the job seeker, candidate, or

6986

# other entity conducting the job search. Providing this information improves

6987

# the quality of the search results across devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6988

"id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes

6989

# the device from other devices.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6990

"deviceType": "A String", # Optional. Type of the device.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6991

},

6992

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

6993

"sortBy": "A String", # Optional. The criteria determining how search results are sorted.

6994

# Defaults to SortBy.RELEVANCE_DESC if no value is specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6995

"enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.

6996

# Broadened queries append results to the end of the matching results

6997

# list.

6998

#

6999

# Defaults to false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7000

}

7001

7002

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# Response for SearchJob method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7013

"metadata": { # Output only. # Additional information for the API invocation, such as the request

7014

# tracking id.

7015

#

7016

# Additional information returned to client, such as debugging

7017

# information.

7018

"requestId": "A String", # A unique id associated with this call.

7019

# This id is logged for tracking purposes.

7020

"mode": "A String", # For search response only. Indicates the mode of a performed search.

7021

"experimentIdList": [ # Identifiers for the versions of the search algorithm used during

7022

# this API invocation if multiple algorithms are used.

7023

# The default value is empty.

7024

# For search response only.

7025

42,

7026

],

7027

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7028

"histogramResults": { # Output only. # The histogram results that match specified

7029

# SearchJobsRequest.HistogramFacets.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7030

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7031

# Histogram results that matches HistogramFacets specified in

7032

# SearchJobsRequest.

7033

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that matches

7034

# HistogramFacets.compensation_histogram_requests.

7035

{ # Output only.

7036

#

7037

# Compensation based histogram result.

7038

"result": { # Output only. # Histogram result.

7039

#

7040

# Custom numeric bucketing result.

7041

"counts": [ # Count within each bucket. Its size is the length of

7042

# NumericBucketingOption.bucket_bounds plus 1.

7043

{ # Represents count of jobs within one bucket.

7044

"count": 42, # Number of jobs whose numeric field value fall into `range`.

7045

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

7046

# that is, the count represents number of jobs in this range.

7047

"to": 3.14, # Ending value of the bucket range.

7048

"from": 3.14, # Starting value of the bucket range.

},

},

],

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

7053

# [NumericBucketingOption.requires_min_max] is set to true.

7054

"maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if

7055

# [NumericBucketingOption.requires_min_max] is set to true.

7056

},

7057

"type": "A String", # Type of the request, corresponding to

7058

# CompensationHistogramRequest.type.

7059

},

7060

],

7061

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that

7062

# matches HistogramFacets.custom_attribute_histogram_facets.

7063

{ # Output only.

7064

#

7065

# Custom attribute histogram result.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7066

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

7067

# custom attribute long values associated with `key`.

7068

#

7069

# Custom numeric bucketing result.

7070

"counts": [ # Count within each bucket. Its size is the length of

7071

# NumericBucketingOption.bucket_bounds plus 1.

7072

{ # Represents count of jobs within one bucket.

7073

"count": 42, # Number of jobs whose numeric field value fall into `range`.

7074

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

7075

# that is, the count represents number of jobs in this range.

7076

"to": 3.14, # Ending value of the bucket range.

7077

"from": 3.14, # Starting value of the bucket range.

},

},

],

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

7082

# [NumericBucketingOption.requires_min_max] is set to true.

7083

"maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if

7084

# [NumericBucketingOption.requires_min_max] is set to true.

7085

},

7086

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

7087

# with `key` to the number of jobs with that value in this histogram result.

7088

"a_key": 42,

7089

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7090

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7091

},

7092

],

7093

"simpleHistogramResults": [ # Specifies histogram results that matches

7094

# HistogramFacets.simple_histogram_facets.

7095

{ # Output only.

7096

#

7097

# Result of a histogram call. The response contains the histogram map for the

7098

# search type specified by HistogramResult.field.

7099

# The response is a map of each filter value to the corresponding count of

7100

# jobs for that filter.

7101

"values": { # A map from the values of field to the number of jobs with that value

7102

# in this search result.

7103

#

7104

# Key: search type (filter names, such as the companyName).

7105

#

7106

# Values: the count of jobs that match the filter for this search.

7107

"a_key": 42,

7108

},

7109

"searchType": "A String", # The Histogram search filters.

},

],

},

"spellResult": { # Output only. # The spell checking result, and correction.

7114

#

7115

# Spell check result.

7116

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

7117

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

7118

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7119

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7120

{ # Output only.

7121

#

7122

# Job entry with metadata inside SearchJobsResponse.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7123

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

7124

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7125

# entity responsible for the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7126

"jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"

7127

#

7128

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7129

"region": "A String", # Optional. The job Region (for example, state, country) throughout which the job

7130

# is available. If this field is set, a

7131

# LocationFilter in a search query within the job region

7132

# finds this job if an exact location match is not specified.

7133

# If this field is set, setting job locations

7134

# to the same location level as this field is strongly recommended.

7135

"referenceUrl": "A String", # Output only. The URL of a web page that displays job details.

7136

"companyTitle": "A String", # Deprecated. Use company_display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7137

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7138

# Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7139

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7140

# The name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7141

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

7142

# recommended as an alternative to using the more general description

7143

# field.

7144

#

7145

# This field accepts and sanitizes HTML input, and also accepts

7146

# bold, italic, ordered list, and unordered list markup tags.

7147

#

7148

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7149

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7150

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

7151

# all compensation entries' CompensationEntry.compensation times

7152

# CompensationEntry.expected_units_per_year.

7153

#

7154

# See CompensationEntry for explanation on compensation annualization.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7155

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

7156

# to a maximal compensation value and the currency code is set to

7157

# match the currency code of

7158

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7159

"units": "A String", # The whole units of the amount.

7160

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7161

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7162

"nanos": 42, # Number of nano (10^-9) units of the amount.

7163

# The value must be between -999,999,999 and +999,999,999 inclusive.

7164

# If `units` is positive, `nanos` must be positive or zero.

7165

# If `units` is zero, `nanos` can be positive, zero, or negative.

7166

# If `units` is negative, `nanos` must be negative or zero.

7167

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7168

},

7169

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

7170

# to zero and the currency code is set to match the

7171

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7172

"units": "A String", # The whole units of the amount.

7173

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7174

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7175

"nanos": 42, # Number of nano (10^-9) units of the amount.

7176

# The value must be between -999,999,999 and +999,999,999 inclusive.

7177

# If `units` is positive, `nanos` must be positive or zero.

7178

# If `units` is zero, `nanos` can be positive, zero, or negative.

7179

# If `units` is negative, `nanos` must be negative or zero.

7180

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7181

},

7182

},

7183

"min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# A lower bound on a range for compensation or pay for the job.

7188

# The currency type is specified in compensation_amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7189

"units": "A String", # The whole units of the amount.

7190

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7191

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7192

"nanos": 42, # Number of nano (10^-9) units of the amount.

7193

# The value must be between -999,999,999 and +999,999,999 inclusive.

7194

# If `units` is positive, `nanos` must be positive or zero.

7195

# If `units` is zero, `nanos` can be positive, zero, or negative.

7196

# If `units` is negative, `nanos` must be negative or zero.

7197

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7198

},

7199

"entries": [ # Optional. Job compensation information.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7200

#

7201

# At most one entry can be of type

7202

# CompensationInfo.CompensationType.BASE, which is

7203

# referred as ** base compensation entry ** for the job.

7204

{ # A compensation entry that represents one component of compensation, such

7205

# as base pay, bonus, or other compensation type.

7206

#

7207

# Annualization: One compensation entry can be annualized if

7208

# - it contains valid amount or range.

7209

# - and its expected_units_per_year is set or can be derived.

7210

# Its annualized range is determined as (amount or range) times

7211

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7212

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7213

# Job.employment_types is FULLTIME, a default value is inferred

7214

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7220

"description": "A String", # Optional. Compensation description. For example, could

7221

# indicate equity terms or provide additional context to an estimated

7222

# bonus.

7223

"unit": "A String", # Optional. Frequency of the specified amount.

7224

#

7225

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

7226

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7227

"units": "A String", # The whole units of the amount.

7228

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7229

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7230

"nanos": 42, # Number of nano (10^-9) units of the amount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7231

# The value must be between -999,999,999 and +999,999,999 inclusive.

7232

# If `units` is positive, `nanos` must be positive or zero.

7233

# If `units` is zero, `nanos` can be positive, zero, or negative.

7234

# If `units` is negative, `nanos` must be negative or zero.

7235

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7236

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7237

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7238

"range": { # Compensation range. # Optional. Compensation range.

7239

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

7240

# to a maximal compensation value and the currency code is set to

7241

# match the currency code of

7242

# min_compensation.

7243

"units": "A String", # The whole units of the amount.

7244

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7245

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

7246

"nanos": 42, # Number of nano (10^-9) units of the amount.

7247

# The value must be between -999,999,999 and +999,999,999 inclusive.

7248

# If `units` is positive, `nanos` must be positive or zero.

7249

# If `units` is zero, `nanos` can be positive, zero, or negative.

7250

# If `units` is negative, `nanos` must be negative or zero.

7251

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7252

},

7253

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

7254

# to zero and the currency code is set to match the

7255

# currency code of max_compensation.

7256

"units": "A String", # The whole units of the amount.

7257

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7258

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

7259

"nanos": 42, # Number of nano (10^-9) units of the amount.

7260

# The value must be between -999,999,999 and +999,999,999 inclusive.

7261

# If `units` is positive, `nanos` must be positive or zero.

7262

# If `units` is zero, `nanos` can be positive, zero, or negative.

7263

# If `units` is negative, `nanos` must be negative or zero.

7264

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7265

},

7266

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7267

},

7268

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7269

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

7270

# base compensation entry's CompensationEntry.compensation times

7271

# CompensationEntry.expected_units_per_year.

7272

#

7273

# See CompensationEntry for explanation on compensation annualization.

7274

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

7275

# to a maximal compensation value and the currency code is set to

7276

# match the currency code of

7277

# min_compensation.

7278

"units": "A String", # The whole units of the amount.

7279

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7280

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

7281

"nanos": 42, # Number of nano (10^-9) units of the amount.

7282

# The value must be between -999,999,999 and +999,999,999 inclusive.

7283

# If `units` is positive, `nanos` must be positive or zero.

7284

# If `units` is zero, `nanos` can be positive, zero, or negative.

7285

# If `units` is negative, `nanos` must be negative or zero.

7286

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7287

},

7288

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

7289

# to zero and the currency code is set to match the

7290

# currency code of max_compensation.

7291

"units": "A String", # The whole units of the amount.

7292

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7293

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

7294

"nanos": 42, # Number of nano (10^-9) units of the amount.

7295

# The value must be between -999,999,999 and +999,999,999 inclusive.

7296

# If `units` is positive, `nanos` must be positive or zero.

7297

# If `units` is zero, `nanos` can be positive, zero, or negative.

7298

# If `units` is negative, `nanos` must be negative or zero.

7299

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7300

},

7301

},

7302

"amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# The amount of compensation or pay for the job.

7307

# As an alternative, compensation_amount_min and

7308

# compensation_amount_max may be used to define a range of

7309

# compensation.

7310

"units": "A String", # The whole units of the amount.

7311

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7312

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

7313

"nanos": 42, # Number of nano (10^-9) units of the amount.

7314

# The value must be between -999,999,999 and +999,999,999 inclusive.

7315

# If `units` is positive, `nanos` must be positive or zero.

7316

# If `units` is zero, `nanos` can be positive, zero, or negative.

7317

# If `units` is negative, `nanos` must be negative or zero.

7318

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7319

},

7320

"type": "A String", # Deprecated. Use entries instead.

#

# Optional.

#

# Type of job compensation.

7325

"max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# An upper bound on a range for compensation or pay for the job.

7330

# The currency type is specified in compensation_amount.

7331

"units": "A String", # The whole units of the amount.

7332

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7333

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

7334

"nanos": 42, # Number of nano (10^-9) units of the amount.

7335

# The value must be between -999,999,999 and +999,999,999 inclusive.

7336

# If `units` is positive, `nanos` must be positive or zero.

7337

# If `units` is zero, `nanos` can be positive, zero, or negative.

7338

# If `units` is negative, `nanos` must be negative or zero.

7339

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7340

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7341

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7342

"expireTime": "A String", # Optional but strongly recommended for the best service

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7343

# experience.

7344

#

7345

# The expiration timestamp of the job. After this timestamp, the

7346

# job is marked as expired, and it no longer appears in search results. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7347

# expired job can't be deleted or listed by the DeleteJob and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7348

# ListJobs APIs, but it can be retrieved with the GetJob API or

7349

# updated with the UpdateJob API. An expired job can be updated and

7350

# opened again by using a future expiration timestamp. Updating an expired

7351

# job fails if there is another existing open job with same

7352

# requisition_id, company_name and language_code.

7353

#

7354

# The expired jobs are retained in our system for 90 days. However, the

7355

# overall expired job count cannot exceed 3 times the maximum of open jobs

7356

# count over the past week, otherwise jobs with earlier expire time are

7357

# cleaned first. Expired jobs are no longer accessible after they are cleaned

7358

# out.

7359

# The format of this field is RFC 3339 date strings. Example:

7360

# 2000-01-01T00:00:00.999999999Z

7361

# See

7362

# [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).

7363

#

7364

# A valid date range is between 1970-01-01T00:00:00.0Z and

7365

# 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire

7366

# time not provided.

7367

#

7368

# If this value is not provided at the time of job creation or is invalid,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7369

# the job posting expires after 30 days from the job's creation time. For

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7370

# example, if the job was created on 2017/01/01 13:00AM UTC with an

7371

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

7372

#

7373

# If this value is not provided but expiry_date is, expiry_date is

7374

# used.

7375

#

7376

# If this value is not provided on job update, it depends on the field masks

7377

# set by UpdateJobRequest.update_job_fields. If the field masks include

7378

# expiry_time, or the masks are empty meaning that every field is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7379

# updated, the job posting expires after 30 days from the job's last

7380

# update time. Otherwise the expiration date isn't updated.

7381

"updateTime": "A String", # Output only. The timestamp when this job was last updated.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7382

"department": "A String", # Optional. The department or functional area within the company with the open

7383

# position.

7384

#

7385

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7386

"jobLocations": [ # Output only. Structured locations of the job, resolved from locations.

7387

{ # Output only.

7388

#

7389

# A resource that represents a location with full geographic

7390

# information.

7391

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

7392

# such as postal delivery and payments addresses. Given a postal address,

7393

# a postal service can deliver items to a premises, P.O. Box, or other

7394

# delivery location.

7395

# Given a postal address, a postal service can deliver items to a premise, P.O.

7396

# Box or similar.

7397

# It is not intended to model geographical locations (roads, towns,

7398

# mountains).

7399

#

7400

# In typical usage an address would be created via user input or from importing

7401

# existing data, depending on the type of process.

7402

#

7403

# Advice on address input / editing:

7404

# - Use an i18n-ready address widget such as

7405

# https://github.com/google/libaddressinput)

7406

# - Users should not be presented with UI elements for input or editing of

7407

# fields outside countries where that field is used.

7408

#

7409

# For more guidance on how to use this schema, please see:

7410

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7411

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

7412

# Examples: US city, IT comune, UK post town.

7413

# In regions of the world where localities are not well defined or do not fit

7414

# into this structure well, leave locality empty and use address_lines.

7415

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

7416

# addresses of a country or region.

7417

# For example, this can be a state, a province, an oblast, or a prefecture.

7418

# Specifically, for Spain this is the province and not the autonomous

7419

# community (e.g. "Barcelona" and not "Catalonia").

7420

# Many countries don't use an administrative area in postal addresses. E.g.

7421

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7422

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7423

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

7424

#

7425

# Because values in address_lines do not have type information and may

7426

# sometimes contain multiple values in a single field (e.g.

7427

# "Austin, TX"), it is important that the line order is clear. The order of

7428

# address lines should be "envelope order" for the country/region of the

7429

# address. In places where this can vary (e.g. Japan), address_language is

7430

# used to make it explicit (e.g. "ja" for large-to-small ordering and

7431

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

7432

# an address can be selected based on the language.

7433

#

7434

# The minimum permitted structural representation of an address consists

7435

# of a region_code with all remaining information placed in the

7436

# address_lines. It would be possible to format such an address very

7437

# approximately without geocoding, but no semantic reasoning could be

7438

# made about any of the address components until it was at least

7439

# partially resolved.

7440

#

7441

# Creating an address only containing a region_code and address_lines, and

7442

# then geocoding is the recommended way to handle completely unstructured

7443

# addresses (as opposed to guessing which parts of the address should be

7444

# localities or administrative areas).

7445

"A String",

7446

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7447

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

7448

# is never inferred and it is up to the user to ensure the value is

7449

# correct. See http://cldr.unicode.org/ and

7450

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

7451

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7452

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

7453

# postal codes to be present, but where they are used, they may trigger

7454

# additional validation with other parts of the address (e.g. state/zip

7455

# validation in the U.S.A.).

7456

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

7457

# in most regions. Where it is used, the value is either a string like

7458

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

7459

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

7460

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

7461

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

7462

# known). This is often the UI language of the input form or is expected

7463

# to match one of the languages used in the address' country/region, or their

7464

# transliterated equivalents.

7465

# This can affect formatting in certain countries, but is not critical

7466

# to the correctness of the data and will never affect any validation or

7467

# other non-formatting related operations.

7468

#

7469

# If this value is not known, it should be omitted (rather than specifying a

7470

# possibly incorrect default).

7471

#

7472

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

7473

"recipients": [ # Optional. The recipient at the address.

7474

# This field may, under certain circumstances, contain multiline information.

7475

# For example, it might contain "care of" information.

7476

"A String",

7477

],

7478

"sublocality": "A String", # Optional. Sublocality of the address.

7479

# For example, this can be neighborhoods, boroughs, districts.

7480

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

7481

# the latest revision.

7482

#

7483

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7484

},

7485

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

7486

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

7487

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

7488

# LocationType#LOCALITY.

7489

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

7490

# location bounding box in which a circle with the specified radius

7491

# centered from LatLng coves the area associated with the job location.

7492

# For example, currently, "Mountain View, CA, USA" has a radius of

7493

# 7885.79 meters.

7494

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

7495

# of doubles representing degrees latitude and degrees longitude. Unless

7496

# specified otherwise, this must conform to the

7497

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

7498

# standard</a>. Values must be within normalized ranges.

7499

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

7500

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

7501

},

7502

},

7503

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7504

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

7509

# filterable_custom_fields. These fields are distinct in that the data

7510

# in these fields are not indexed. Therefore, the client cannot search

7511

# against them, nor can the client use them to list jobs.

7512

#

7513

# The key of the map can be any valid string.

7514

"a_key": { # Resource that represents the custom data not captured by the standard fields.

7515

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

7521

#

7522

# Optional but strongly recommended to be provided for the best service

7523

# experience.

7524

#

7525

# The expiration date of the job in UTC time. After 12 am on this date, the

7526

# job is marked as expired, and it no longer appears in search results.

7527

# The expired job can't be deleted or listed by the DeleteJob and

7528

# ListJobs APIs, but it can be retrieved with the GetJob API or

7529

# updated with the UpdateJob API. An expired job can be updated and

7530

# opened again by using a future expiration date. It can also remain expired.

7531

# Updating an expired job to be open fails if there is another existing open

7532

# job with same requisition_id, company_name and language_code.

7533

#

7534

# The expired jobs are retained in our system for 90 days. However, the

7535

# overall expired job count cannot exceed 3 times the maximum of open jobs

7536

# count over the past week, otherwise jobs with earlier expire time are

7537

# removed first. Expired jobs are no longer accessible after they are cleaned

7538

# out.

7539

#

7540

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

7541

# ignored and treated as expiry date not provided.

7542

#

7543

# If this value is not provided on job creation or is invalid, the job

7544

# posting expires after 30 days from the job's creation time. For example, if

7545

# the job was created on 2017/01/01 13:00AM UTC with an unspecified

7546

# expiration date, the job expires after 2017/01/31 13:00AM UTC.

7547

#

7548

# If this value is not provided on job update, it depends on the field masks

7549

# set by UpdateJobRequest.update_job_fields. If the field masks include

7550

# expiry_date, or the masks are empty meaning that every field is

7551

# updated, the job expires after 30 days from the job's last update time.

7552

# Otherwise the expiration date isn't updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7553

# and time zone are either specified elsewhere or are not significant. The date

7554

# is relative to the Proleptic Gregorian Calendar. This can represent:

7555

#

7556

# * A full date, with non-zero year, month and day values

7557

# * A month and day value, with a zero year, e.g. an anniversary

7558

# * A year on its own, with zero month and day values

7559

# * A year and month value, with a zero day, e.g. a credit card expiration date

7560

#

7561

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7562

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7563

# if specifying a year by itself or a year and month where the day is not

7564

# significant.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7565

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7566

# a year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7567

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

7568

# month and day.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7569

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7570

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

7571

# is used for contracting engagements.

7572

# Dates prior to 1970/1/1 and invalid date formats are ignored.

7573

# and time zone are either specified elsewhere or are not significant. The date

7574

# is relative to the Proleptic Gregorian Calendar. This can represent:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7575

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7576

# * A full date, with non-zero year, month and day values

7577

# * A month and day value, with a zero year, e.g. an anniversary

7578

# * A year on its own, with zero month and day values

7579

# * A year and month value, with a zero day, e.g. a credit card expiration date

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7580

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7581

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

7582

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

7583

# if specifying a year by itself or a year and month where the day is not

7584

# significant.

7585

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

7586

# a year.

7587

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

7588

# month and day.

7589

},

7590

"educationLevels": [ # Optional. The desired education level for the job, such as

7591

# "Bachelors", "Masters", "Doctorate".

7592

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7593

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7594

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7595

# attributes that are not covered by the provided structured fields.

7596

#

7597

# This field is a more general combination of the deprecated id-based

7598

# filterable_custom_fields and string-based

7599

# non_filterable_custom_fields.

7600

#

7601

# The keys of the map are strings up to 64 bytes and must match the

7602

# pattern: a-zA-Z*.

7603

#

7604

# At most 100 filterable and at most 100 unfilterable keys are supported.

7605

# For filterable `string_values`, across all keys at most 200 values are

7606

# allowed, with each string no more than 255 characters. For unfilterable

7607

# `string_values`, the maximum total size of `string_values` across all keys

7608

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7609

"a_key": { # Custom attribute values that are either filterable or non-filterable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7610

"longValue": "A String", # Optional but at least one of string_values or long_value must

7611

# be specified.

7612

#

7613

# This field is used to perform number range search.

7614

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For

7615

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

7616

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7617

# be specified.

7618

#

7619

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

7620

# `CASE_INSENSITIVE_MATCH`) search.

7621

# For filterable `string_values`, a maximum total number of 200 values

7622

# is allowed, with each `string_value` has a byte size of no more than

7623

# 255B. For unfilterable `string_values`, the maximum total byte size of

7624

# unfilterable `string_values` is 50KB.

7625

#

7626

# Empty strings are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7627

"values": [ # Required. String values.

7628

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7629

],

7630

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7631

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

7632

# If false, values are not searchable.

7633

#

7634

# Default is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7635

},

7636

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7637

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

7642

# the standard fields such as job_title, company_name, or

7643

# level. These custom fields store arbitrary

7644

# string values, and can be used for purposes not covered by

7645

# the structured fields. For the best search experience, use of the

7646

# structured rather than custom fields is recommended.

7647

#

7648

# Data stored in these custom fields fields are indexed and

7649

# searched against by keyword searches (see

7650

# SearchJobsRequest.custom_field_filters][]).

7651

#

7652

# The map key must be a number between 1-20. If an invalid key is

7653

# provided on job create or update, an error is returned.

7654

"a_key": { # Resource that represents the custom data not captured by the standard fields.

7655

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

7661

# any requirements for fluency that are associated with the job.

7662

#

7663

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

7664

# For more information, see

7665

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

7666

# class="external" target="_blank" }.

7667

#

7668

# If this field is unspecified and Job.description is present, detected

7669

# language code based on Job.description is assigned, otherwise

7670

# defaults to 'en_US'.

7671

"visibility": "A String", # Optional. The visibility of the job.

7672

# Defaults to JobVisibility.PRIVATE if not specified.

7673

# Currently only JobVisibility.PRIVATE is supported.

7674

"name": "A String", # Required during job update.

7675

#

7676

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

7677

# of this field in job queries and API calls is preferred over the use of

7678

# requisition_id since this value is unique.

7679

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7680

# provided.

7681

#

7682

# A unique company identifier used by job distributors to identify an

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7683

# employer's company entity. company_name takes precedence over

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7684

# this field, and is the recommended field to use to identify companies.

7685

#

7686

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7687

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

7688

# The value determines the sort order of the jobs returned when searching for

7689

# jobs using the featured jobs search call, with higher promotional values

7690

# being returned first and ties being resolved by relevance sort. Only the

7691

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

7692

#

7693

# Default value is 0, and negative values are treated as 0.

7694

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

7695

# value is the time the request arrives at the server.

7696

# and time zone are either specified elsewhere or are not significant. The date

7697

# is relative to the Proleptic Gregorian Calendar. This can represent:

7698

#

7699

# * A full date, with non-zero year, month and day values

7700

# * A month and day value, with a zero year, e.g. an anniversary

7701

# * A year on its own, with zero month and day values

7702

# * A year and month value, with a zero day, e.g. a credit card expiration date

7703

#

7704

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

7705

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

7706

# if specifying a year by itself or a year and month where the day is not

7707

# significant.

7708

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

7709

# a year.

7710

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

7711

# month and day.

7712

},

7713

"applicationUrls": [ # Optional but at least one of application_urls,

7714

# application_email_list or application_instruction must be

7715

# specified.

7716

#

7717

# Use this URL field to direct an applicant to a website, for example to

7718

# link to an online application form.

7719

#

7720

# The maximum number of allowed characters is 2,000.

7721

"A String",

7722

],

7723

"companyDisplayName": "A String", # Output only. The name of the company listing the job.

7724

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

7725

# client to identify a job. This field is intended to be used by clients

7726

# for client identification and tracking of listings. A job is not allowed

7727

# to be created if there is another job with the same requisition_id,

7728

# company_name and language_code.

7729

#

7730

# The maximum number of allowed characters is 255.

7731

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

7732

# job. The use of this field is recommended

7733

# as an alternative to using the more general description field.

7734

#

7735

# This field accepts and sanitizes HTML input, and also accepts

7736

# bold, italic, ordered list, and unordered list markup tags.

7737

#

7738

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7739

"createTime": "A String", # Output only. The timestamp when this job was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7740

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

7741

# is used for contracting engagements.

7742

# Dates prior to 1970/1/1 and invalid date formats are ignored.

7743

# and time zone are either specified elsewhere or are not significant. The date

7744

# is relative to the Proleptic Gregorian Calendar. This can represent:

7745

#

7746

# * A full date, with non-zero year, month and day values

7747

# * A month and day value, with a zero year, e.g. an anniversary

7748

# * A year on its own, with zero month and day values

7749

# * A year and month value, with a zero day, e.g. a credit card expiration date

7750

#

7751

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

7752

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

7753

# if specifying a year by itself or a year and month where the day is not

7754

# significant.

7755

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

7756

# a year.

7757

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

7758

# month and day.

7759

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7760

"level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

7761

"applicationInstruction": "A String", # Optional but at least one of application_urls,

7762

# application_email_list or application_instruction must be

7763

# specified.

7764

#

7765

# Use this field to provide instructions, such as "Mail your application

7766

# to ...", that a candidate can follow to apply for the job.

7767

#

7768

# This field accepts and sanitizes HTML input, and also accepts

7769

# bold, italic, ordered list, and unordered list markup tags.

7770

#

7771

# The maximum number of allowed characters is 3,000.

7772

"benefits": [ # Optional. The benefits included with the job.

7773

"A String",

7774

],

7775

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

7776

# incentives associated with the job not including salary or pay.

7777

#

7778

# The maximum number of allowed characters is 10,000.

7779

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"locations": [ # Optional but strongly recommended for the best service experience.

7785

#

7786

# Location(s) where the emploeyer is looking to hire for this job posting.

7787

#

7788

# Specifying the full street address(es) of the hiring location enables

7789

# better API results, especially job searches by commute time.

7790

#

7791

# At most 50 locations are allowed for best search performance. If a job has

7792

# more locations, it is suggested to split it into multiple jobs with unique

7793

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

7794

# multiple jobs with the same requisition_id, company_name and

7795

# language_code are not allowed. If the original requisition_id must

7796

# be preserved, a custom field should be used for storage. It is also

7797

# suggested to group the locations that close to each other in the same job

7798

# for better search experience.

7799

#

7800

# The maximum number of allowed characters is 500.

7801

"A String",

7802

],

7803

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

7808

#

7809

# This field replaces compensation_info. Only

7810

# CompensationInfo.entries or extended_compensation_info can be set,

7811

# otherwise an exception is thrown.

7812

#

7813

# Describes job compensation.

7814

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

7815

# currency code.

7816

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

7817

#

7818

# Compensation range.

7819

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

7820

#

7821

# Decimal number.

7822

"micros": 42, # Micro (10^-6) units.

7823

# The value must be between -999,999 and +999,999 inclusive.

7824

# If `units` is positive, `micros` must be positive or zero.

7825

# If `units` is zero, `micros` can be positive, zero, or negative.

7826

# If `units` is negative, `micros` must be negative or zero.

7827

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7828

"units": "A String", # Whole units.

7829

},

7830

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

7831

#

7832

# Decimal number.

7833

"micros": 42, # Micro (10^-6) units.

7834

# The value must be between -999,999 and +999,999 inclusive.

7835

# If `units` is positive, `micros` must be positive or zero.

7836

# If `units` is zero, `micros` can be positive, zero, or negative.

7837

# If `units` is negative, `micros` must be negative or zero.

7838

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7839

"units": "A String", # Whole units.

7840

},

7841

},

7842

"entries": [ # Optional. Job compensation information.

7843

#

7844

# At most one entry can be of type

7845

# ExtendedCompensationInfo.CompensationType.BASE, which is

7846

# referred as ** base compensation entry ** for the job.

7847

{ # Deprecated. See CompensationInfo.

7848

#

7849

# A compensation entry that represents one component of compensation, such

7850

# as base pay, bonus, or other compensation type.

7851

#

7852

# Annualization: One compensation entry can be annualized if

7853

# - it contains valid amount or range.

7854

# - and its expected_units_per_year is set or can be derived.

7855

# Its annualized range is determined as (amount or range) times

7856

# expected_units_per_year.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

7857

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

7858

#

7859

# Decimal number.

7860

"micros": 42, # Micro (10^-6) units.

7861

# The value must be between -999,999 and +999,999 inclusive.

7862

# If `units` is positive, `micros` must be positive or zero.

7863

# If `units` is zero, `micros` can be positive, zero, or negative.

7864

# If `units` is negative, `micros` must be negative or zero.

7865

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7866

"units": "A String", # Whole units.

7867

},

7868

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7869

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

7870

#

7871

# Compensation range.

7872

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

7873

#

7874

# Decimal number.

7875

"micros": 42, # Micro (10^-6) units.

7876

# The value must be between -999,999 and +999,999 inclusive.

7877

# If `units` is positive, `micros` must be positive or zero.

7878

# If `units` is zero, `micros` can be positive, zero, or negative.

7879

# If `units` is negative, `micros` must be negative or zero.

7880

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7881

"units": "A String", # Whole units.

7882

},

7883

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

7884

#

7885

# Decimal number.

7886

"micros": 42, # Micro (10^-6) units.

7887

# The value must be between -999,999 and +999,999 inclusive.

7888

# If `units` is positive, `micros` must be positive or zero.

7889

# If `units` is zero, `micros` can be positive, zero, or negative.

7890

# If `units` is negative, `micros` must be negative or zero.

7891

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7892

"units": "A String", # Whole units.

7893

},

7894

},

7895

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

7896

# Job.employment_types is FULLTIME, a default value is inferred

7897

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

7906

# The value must be between -999,999 and +999,999 inclusive.

7907

# If `units` is positive, `micros` must be positive or zero.

7908

# If `units` is zero, `micros` can be positive, zero, or negative.

7909

# If `units` is negative, `micros` must be negative or zero.

7910

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7911

"units": "A String", # Whole units.

7912

},

7913

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

7914

"description": "A String", # Optional. Compensation description.

7915

"unit": "A String", # Optional. Frequency of the specified amount.

7916

#

7917

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7918

},

7919

],

7920

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

7921

# the job's all CompensationEntry cannot be annualized.

7922

# See CompensationEntry for explanation on annualization and base

7923

# compensation entry.

7924

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

7925

#

7926

# Compensation range.

7927

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

7928

#

7929

# Decimal number.

7930

"micros": 42, # Micro (10^-6) units.

7931

# The value must be between -999,999 and +999,999 inclusive.

7932

# If `units` is positive, `micros` must be positive or zero.

7933

# If `units` is zero, `micros` can be positive, zero, or negative.

7934

# If `units` is negative, `micros` must be negative or zero.

7935

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7936

"units": "A String", # Whole units.

7937

},

7938

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

7939

#

7940

# Decimal number.

7941

"micros": 42, # Micro (10^-6) units.

7942

# The value must be between -999,999 and +999,999 inclusive.

7943

# If `units` is positive, `micros` must be positive or zero.

7944

# If `units` is zero, `micros` can be positive, zero, or negative.

7945

# If `units` is negative, `micros` must be negative or zero.

7946

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

7947

"units": "A String", # Whole units.

7948

},

7949

},

7950

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

7951

# the job's base compensation entry cannot be annualized.

7952

# See CompensationEntry for explanation on annualization and base

7953

# compensation entry.

7954

},

7955

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

7956

# provided.

7957

#

7958

# The resource name of the company listing the job, such as

7959

# /companies/foo. This field takes precedence over the

7960

# distributor-assigned company identifier, distributor_company_id.

7961

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

7962

# description of the company and related information. Separate fields are

7963

# provided on the job object for responsibilities,

7964

# qualifications, and other job characteristics. Use of

7965

# these separate job fields is recommended.

7966

#

7967

# This field accepts and sanitizes HTML input, and also accepts

7968

# bold, italic, ordered list, and unordered list markup tags.

7969

#

7970

# The maximum number of allowed characters is 100,000.

7971

"applicationEmailList": [ # Optional but at least one of application_urls,

7972

# application_email_list or application_instruction must be

7973

# specified.

7974

#

7975

# Use this field to specify email address(es) to which resumes or

7976

# applications can be sent.

7977

#

7978

# The maximum number of allowed characters is 255.

7979

"A String",

7980

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7981

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7982

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

7983

# fields that most closely match a search query's keywords, if available.

7984

# All HTML tags in the original fields are stripped when returned in this

7985

# field, and matching query keywords are enclosed in HTML bold tags.

7986

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

7987

# closely matching a search query's keywords, if available. The matching

7988

# query keywords are enclosed in HTML bold tags.

7989

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

7990

# results listing page.

7991

"commuteInfo": { # Output only. # Commute information which is generated based on specified

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7992

# CommutePreference.

7993

#

7994

# Commute details related to this job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7995

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7996

# location. A duration of 0 seconds indicates that the job is not

7997

# reachable within the requested duration, but was returned as part of an

7998

# expanded query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7999

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8000

#

8001

# A resource that represents a location with full geographic

8002

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8003

"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]

8004

# such as postal delivery and payments addresses. Given a postal address,

8005

# a postal service can deliver items to a premises, P.O. Box, or other

8006

# delivery location.

8007

# Given a postal address, a postal service can deliver items to a premise, P.O.

8008

# Box or similar.

8009

# It is not intended to model geographical locations (roads, towns,

8010

# mountains).

8011

#

8012

# In typical usage an address would be created via user input or from importing

8013

# existing data, depending on the type of process.

8014

#

8015

# Advice on address input / editing:

8016

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8017

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8018

# - Users should not be presented with UI elements for input or editing of

8019

# fields outside countries where that field is used.

8020

#

8021

# For more guidance on how to use this schema, please see:

8022

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8023

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

8024

# Examples: US city, IT comune, UK post town.

8025

# In regions of the world where localities are not well defined or do not fit

8026

# into this structure well, leave locality empty and use address_lines.

8027

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

8028

# addresses of a country or region.

8029

# For example, this can be a state, a province, an oblast, or a prefecture.

8030

# Specifically, for Spain this is the province and not the autonomous

8031

# community (e.g. "Barcelona" and not "Catalonia").

8032

# Many countries don't use an administrative area in postal addresses. E.g.

8033

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8034

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8035

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8036

#

8037

# Because values in address_lines do not have type information and may

8038

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8039

# "Austin, TX"), it is important that the line order is clear. The order of

8040

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8041

# 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]

8042

# used to make it explicit (e.g. "ja" for large-to-small ordering and

8043

# "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]

8044

# an address can be selected based on the language.

8045

#

8046

# The minimum permitted structural representation of an address consists

8047

# of a region_code with all remaining information placed in the

8048

# address_lines. It would be possible to format such an address very

8049

# approximately without geocoding, but no semantic reasoning could be

8050

# made about any of the address components until it was at least

8051

# partially resolved.

8052

#

8053

# Creating an address only containing a region_code and address_lines, and

8054

# then geocoding is the recommended way to handle completely unstructured

8055

# addresses (as opposed to guessing which parts of the address should be

8056

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8057

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8058

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8059

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

8060

# is never inferred and it is up to the user to ensure the value is

8061

# correct. See http://cldr.unicode.org/ and

8062

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

8063

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8064

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8065

# postal codes to be present, but where they are used, they may trigger

8066

# additional validation with other parts of the address (e.g. state/zip

8067

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8068

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

8069

# in most regions. Where it is used, the value is either a string like

8070

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

8071

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

8072

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

8073

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

8074

# known). This is often the UI language of the input form or is expected

8075

# to match one of the languages used in the address' country/region, or their

8076

# transliterated equivalents.

8077

# This can affect formatting in certain countries, but is not critical

8078

# to the correctness of the data and will never affect any validation or

8079

# other non-formatting related operations.

8080

#

8081

# If this value is not known, it should be omitted (rather than specifying a

8082

# possibly incorrect default).

8083

#

8084

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

8085

"recipients": [ # Optional. The recipient at the address.

8086

# This field may, under certain circumstances, contain multiline information.

8087

# For example, it might contain "care of" information.

8088

"A String",

8089

],

8090

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8091

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8092

"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]

8093

# the latest revision.

8094

#

8095

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8096

},

8097

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

8098

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

8099

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

8100

# LocationType#LOCALITY.

8101

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

8102

# location bounding box in which a circle with the specified radius

8103

# centered from LatLng coves the area associated with the job location.

8104

# For example, currently, "Mountain View, CA, USA" has a radius of

8105

# 7885.79 meters.

8106

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

8107

# of doubles representing degrees latitude and degrees longitude. Unless

8108

# specified otherwise, this must conform to the

8109

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

8110

# standard</a>. Values must be within normalized ranges.

8111

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

8112

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8113

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8114

},

8115

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8116

},

8117

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8118

"numJobsFromBroadenedQuery": 42, # If query broadening is enabled, we may append additional results from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8119

# broadened query. This number indicates how many of the jobs returned in the

8120

# jobs field are from the broadened query. These results are always at the

8121

# end of the jobs list. In particular, a value of 0 means all the jobs in the

8122

# jobs list are from the original (without broadening) query. If this

8123

# field is non-zero, subsequent requests with offset after this result set

8124

# should contain all broadened results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8125

"appliedCommuteFilter": { # Input only. # The commute filter the service applied to the specified query. This

8126

# information is only available when query has a valid CommutePreference.

8127

#

8128

# Parameters needed for commute search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8129

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

8130

# commute time.

8131

# of doubles representing degrees latitude and degrees longitude. Unless

8132

# specified otherwise, this must conform to the

8133

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

8134

# standard</a>. Values must be within normalized ranges.

8135

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

8136

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

8137

},

8138

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

8139

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

8140

# Must not be present if departure_hour_local is specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8141

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

8142

# integer between 0 and 23, representing the hour in the time zone of the

8143

# start_location. Must not be present if road_traffic is specified.

8144

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

8145

# For city level addresses, the city center is used. For state and coarser

8146

# level addresses, text matching is used.

8147

# If this field is set to `false` or is not specified, only jobs that include

8148

# street level addresses will be returned by commute search.

8149

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

8150

# (one hour). Format is `123s`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8151

},

8152

"jobView": "A String", # Corresponds to SearchJobsRequest.job_view.

8153

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

8154

# This field is empty if there are no more results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8155

"appliedJobLocationFilters": [ # The location filters that the service applied to the specified query. If

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8156

# any filters are lat-lng based, the JobLocation.location_type is

8157

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

8158

{ # Output only.

8159

#

8160

# A resource that represents a location with full geographic

8161

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8162

"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]

8163

# such as postal delivery and payments addresses. Given a postal address,

8164

# a postal service can deliver items to a premises, P.O. Box, or other

8165

# delivery location.

8166

# Given a postal address, a postal service can deliver items to a premise, P.O.

8167

# Box or similar.

8168

# It is not intended to model geographical locations (roads, towns,

8169

# mountains).

8170

#

8171

# In typical usage an address would be created via user input or from importing

8172

# existing data, depending on the type of process.

8173

#

8174

# Advice on address input / editing:

8175

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8176

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8177

# - Users should not be presented with UI elements for input or editing of

8178

# fields outside countries where that field is used.

8179

#

8180

# For more guidance on how to use this schema, please see:

8181

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8182

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

8183

# Examples: US city, IT comune, UK post town.

8184

# In regions of the world where localities are not well defined or do not fit

8185

# into this structure well, leave locality empty and use address_lines.

8186

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

8187

# addresses of a country or region.

8188

# For example, this can be a state, a province, an oblast, or a prefecture.

8189

# Specifically, for Spain this is the province and not the autonomous

8190

# community (e.g. "Barcelona" and not "Catalonia").

8191

# Many countries don't use an administrative area in postal addresses. E.g.

8192

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8193

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8194

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8195

#

8196

# Because values in address_lines do not have type information and may

8197

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8198

# "Austin, TX"), it is important that the line order is clear. The order of

8199

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8200

# 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]

8201

# used to make it explicit (e.g. "ja" for large-to-small ordering and

8202

# "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]

8203

# an address can be selected based on the language.

8204

#

8205

# The minimum permitted structural representation of an address consists

8206

# of a region_code with all remaining information placed in the

8207

# address_lines. It would be possible to format such an address very

8208

# approximately without geocoding, but no semantic reasoning could be

8209

# made about any of the address components until it was at least

8210

# partially resolved.

8211

#

8212

# Creating an address only containing a region_code and address_lines, and

8213

# then geocoding is the recommended way to handle completely unstructured

8214

# addresses (as opposed to guessing which parts of the address should be

8215

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8216

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8217

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8218

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

8219

# is never inferred and it is up to the user to ensure the value is

8220

# correct. See http://cldr.unicode.org/ and

8221

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

8222

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8223

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8224

# postal codes to be present, but where they are used, they may trigger

8225

# additional validation with other parts of the address (e.g. state/zip

8226

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8227

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

8228

# in most regions. Where it is used, the value is either a string like

8229

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

8230

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

8231

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

8232

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

8233

# known). This is often the UI language of the input form or is expected

8234

# to match one of the languages used in the address' country/region, or their

8235

# transliterated equivalents.

8236

# This can affect formatting in certain countries, but is not critical

8237

# to the correctness of the data and will never affect any validation or

8238

# other non-formatting related operations.

8239

#

8240

# If this value is not known, it should be omitted (rather than specifying a

8241

# possibly incorrect default).

8242

#

8243

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

8244

"recipients": [ # Optional. The recipient at the address.

8245

# This field may, under certain circumstances, contain multiline information.

8246

# For example, it might contain "care of" information.

8247

"A String",

8248

],

8249

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8250

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8251

"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]

8252

# the latest revision.

8253

#

8254

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8255

},

8256

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

8257

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

8258

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

8259

# LocationType#LOCALITY.

8260

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

8261

# location bounding box in which a circle with the specified radius

8262

# centered from LatLng coves the area associated with the job location.

8263

# For example, currently, "Mountain View, CA, USA" has a radius of

8264

# 7885.79 meters.

8265

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

8266

# of doubles representing degrees latitude and degrees longitude. Unless

8267

# specified otherwise, this must conform to the

8268

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

8269

# standard</a>. Values must be within normalized ranges.

8270

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

8271

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8272

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8273

},

8274

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8275

"estimatedTotalSize": "A String", # An estimation of the number of jobs that match the specified query.

8276

#

8277

# This number is not guaranteed to be accurate. For accurate results,

8278

# seenenable_precise_result_size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8279

"totalSize": "A String", # The precise result count, which is available only if the client set

8280

# enable_precise_result_size to `true` or if the response

8281

# is the last page of results. Otherwise, the value will be `-1`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8286

<code class="details" id="searchForAlert">searchForAlert(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8287

<pre>Searches for jobs using the provided SearchJobsRequest.

8288

8289

This API call is intended for the use case of targeting passive job

8290

seekers (for example, job seekers who have signed up to receive email

8291

alerts about potential job opportunities), and has different algorithmic

8292

adjustments that are targeted to passive job seekers.

8293

8294

This call constrains the visibility of jobs

8295

present in the database, and only returns jobs the caller has

8296

permission to search against.

8297

8298

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8299

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8300

The object takes the form of:

{ # Input only.

#

# The Request body of the `SearchJobs` call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8305

"mode": "A String", # Required. Mode of a search.

8306

"offset": 42, # Optional. An integer that specifies the current offset (that is, starting result

8307

# location, amongst the jobs deemed by the API as relevant) in search

8308

# results. This field is only considered if page_token is unset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8309

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8310

# For example, 0 means to return results starting from the first matching

8311

# job, and 10 means to return from the 11th job. This can be used for

8312

# pagination, (for example, pageSize = 10 and offset = 10 means to return

8313

# from the second page).

8314

"pageSize": 42, # Optional. A limit on the number of jobs returned in the search results.

8315

# Increasing this value above the default value of 10 can increase search

8316

# response time. The value can be between 1 and 100.

8317

"query": { # Input only. # Optional. Query used to search against jobs, such as keyword, location filters, etc.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8318

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8319

# The query required to perform a search query or histogram.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8320

"query": "A String", # Optional. The query string that matches against the job title, description, and

8321

# location fields.

8322

#

8323

# The maximum query size is 255 bytes.

8324

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

8325

# Job.compensation_info. For example, if the filter is specified

8326

# as "Hourly job with per-hour compensation > $15", only jobs meeting

8327

# these criteria are searched. If a filter isn't defined, all open jobs

8328

# are searched.

8329

#

8330

# Filter on job compensation type and amount.

8331

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

8332

"units": [ # Required. Specify desired `base compensation entry's`

8333

# CompensationInfo.CompensationUnit.

8334

"A String",

8335

],

8336

"range": { # Compensation range. # Optional. Compensation range.

8337

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

8338

# to a maximal compensation value and the currency code is set to

8339

# match the currency code of

8340

# min_compensation.

8341

"units": "A String", # The whole units of the amount.

8342

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

8343

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

8344

"nanos": 42, # Number of nano (10^-9) units of the amount.

8345

# The value must be between -999,999,999 and +999,999,999 inclusive.

8346

# If `units` is positive, `nanos` must be positive or zero.

8347

# If `units` is zero, `nanos` can be positive, zero, or negative.

8348

# If `units` is negative, `nanos` must be negative or zero.

8349

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

8350

},

8351

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

8352

# to zero and the currency code is set to match the

8353

# currency code of max_compensation.

8354

"units": "A String", # The whole units of the amount.

8355

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

8356

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

8357

"nanos": 42, # Number of nano (10^-9) units of the amount.

8358

# The value must be between -999,999,999 and +999,999,999 inclusive.

8359

# If `units` is positive, `nanos` must be positive or zero.

8360

# If `units` is zero, `nanos` can be positive, zero, or negative.

8361

# If `units` is negative, `nanos` must be negative or zero.

8362

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

8363

},

8364

},

8365

"type": "A String", # Required. Type of filter.

8366

},

8367

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

8368

# service attempts to correct a misspelled query,

8369

# for example, "enginee" is corrected to "engineer".

8370

#

8371

# Defaults to false: a spell check is performed.

8372

"companyDisplayNames": [ # Optional. This filter specifies the exact company display

8373

# name of the jobs to search against.

8374

#

8375

# If a value isn't specified, jobs within the search results are

8376

# associated with any company.

8377

#

8378

# If multiple values are specified, jobs within the search results may be

8379

# associated with any of the specified companies.

8380

#

8381

# At most 20 company display name filters are allowed.

8382

"A String",

8383

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8384

"companyNames": [ # Optional. This filter specifies the company entities to search against.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8385

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8386

# If a value isn't specified, jobs are searched for against all

8387

# companies.

8388

#

8389

# If multiple values are specified, jobs are searched against the

8390

# companies specified.

8391

#

8392

# At most 20 company filters are allowed.

8393

"A String",

8394

],

8395

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

8396

# search against, such as EmploymentType.FULL_TIME.

8397

#

8398

# If a value is not specified, jobs in the search results include any

8399

# employment type.

8400

#

8401

# If multiple values are specified, jobs in the search results include

8402

# any of the specified employment types.

8403

"A String",

8404

],

8405

"categories": [ # Optional. The category filter specifies the categories of jobs to search against.

8406

# See Category for more information.

8407

#

8408

# If a value is not specified, jobs from any category are searched against.

8409

#

8410

# If multiple values are specified, jobs from any of the specified

8411

# categories are searched against.

8412

"A String",

8413

],

8414

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

8415

# Job.custom_attributes marked as `filterable`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8416

#

8417

# The syntax for this expression is a subset of Google SQL syntax.

8418

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8419

# Supported operators are: =, !=, <, <=, >, >= where the left of the operator

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8420

# is a custom field key and the right of the operator is a number or string

8421

# (surrounded by quotes) value.

8422

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8423

# Supported functions are LOWER(<field_name>) to

8424

# perform case insensitive match and EMPTY(<field_name>) to filter on the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8425

# existence of a key.

8426

#

8427

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8428

# nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50

8429

# comparisons/functions are allowed in the expression. The expression

8430

# must be < 2000 characters in length.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8431

#

8432

# Sample Query:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8433

# (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100

8434

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

8435

# search against. See LocationFilter for more information.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8436

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8437

# If a location value isn't specified, jobs fitting the other search

8438

# criteria are retrieved regardless of where they're located.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8439

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8440

# If multiple values are specified, jobs are retrieved from any of the

8441

# specified locations. If different values are specified for the

8442

# LocationFilter.distance_in_miles parameter, the maximum provided

8443

# distance is used for all locations.

8444

#

8445

# At most 5 location filters are allowed.

8446

{ # Input only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8447

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8448

# Geographic region of the search.

8449

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used

8450

# to address ambiguity of the user-input location, e.g. "Liverpool"

8451

# against "Liverpool, NY, US" or "Liverpool, UK".

8452

#

8453

# Set this field if all the jobs to search against are from a same region,

8454

# or jobs are world-wide but the job seeker is from a specific region.

8455

#

8456

# See http://cldr.unicode.org/ and

8457

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

8458

# for details. Example: "CH" for Switzerland.

8459

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

8460

# identified as a city or smaller. When the location being searched for is a

8461

# state or larger, this field is ignored.

8462

"isTelecommute": True or False, # Optional. Allows the client to return jobs without a

8463

# set location, specifically, telecommuting jobs (telecomuting is considered

8464

# by the service as a special location.

8465

# Job.allow_telecommute indicates if a job permits telecommuting.

8466

# If this field is true, telecommuting jobs are searched, and

8467

# name and lat_lng are

8468

# ignored.

8469

# This filter can be used by itself to search exclusively for telecommuting

8470

# jobs, or it can be combined with another location

8471

# filter to search for a combination of job locations,

8472

# such as "Mountain View" or "telecommuting" jobs. However, when used in

8473

# combination with other location filters, telecommuting jobs can be

8474

# treated as less relevant than other jobs in the search response.

8475

"name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

8476

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

8477

# search. This field is ignored if `location_name` is provided.

8478

# of doubles representing degrees latitude and degrees longitude. Unless

8479

# specified otherwise, this must conform to the

8480

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

8481

# standard</a>. Values must be within normalized ranges.

8482

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

8483

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

8484

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8485

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8486

],

8487

"publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched

8488

# against, for example, DateRange.PAST_MONTH. If a value isn't

8489

# specified, all open jobs are searched against regardless of their

8490

# published date.

8491

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (for

8492

# example, driving or public transit). Note: This only works with COMMUTE

8493

# MODE. When specified, [JobQuery.location_filters] is

8494

# ignored.

8495

#

8496

# Currently we don't support sorting by commute time.

8497

#

8498

# Parameters needed for commute search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8499

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

8500

# commute time.

8501

# of doubles representing degrees latitude and degrees longitude. Unless

8502

# specified otherwise, this must conform to the

8503

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

8504

# standard</a>. Values must be within normalized ranges.

8505

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

8506

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

8507

},

8508

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

8509

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

8510

# Must not be present if departure_hour_local is specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8511

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

8512

# integer between 0 and 23, representing the hour in the time zone of the

8513

# start_location. Must not be present if road_traffic is specified.

8514

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

8515

# For city level addresses, the city center is used. For state and coarser

8516

# level addresses, text matching is used.

8517

# If this field is set to `false` or is not specified, only jobs that include

8518

# street level addresses will be returned by commute search.

8519

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

8520

# (one hour). Format is `123s`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8521

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8522

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

8523

# for example, "en-US".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8524

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8525

# If a value isn't specified, the search results can contain jobs in any

8526

# locale.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8527

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8528

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8529

# Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn".

8530

# For more information, see

8531

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8532

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8533

# At most 10 language code filters are allowed.

8534

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8535

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8536

},

8537

"disableRelevanceThresholding": True or False, # Optional. Controls whether to disable relevance thresholding. Relevance

8538

# thresholding removes jobs that have low relevance in search results,

8539

# for example, removing "Assistant to the CEO" positions from the search

8540

# results of a search for "CEO".

8541

#

8542

# Disabling relevance thresholding improves the accuracy of subsequent

# search requests.

#

# Defaults to false.

"enablePreciseResultSize": True or False, # Optional. Controls if the search job request requires the return of a precise

8547

# count of the first 300 results. Setting this to `true` ensures

8548

# consistency in the number of results per page. Best practice is to set this

8549

# value to true if a client allows users to jump directly to a

8550

# non-sequential search results page.

8551

#

8552

# Enabling this flag may adversely impact performance.

8553

#

8554

# Defaults to false.

8555

"histogramFacets": { # Input only. # Optional. Restrictions on what fields to perform histogram on, such as

8556

# `COMPANY_SIZE` etc.

8557

#

8558

# Histogram facets to be specified in SearchJobsRequest.

8559

"compensationHistogramFacets": [ # Optional. Specifies compensation field-based histogram requests.

8560

# Duplicate values of CompensationHistogramRequest.type are not allowed.

8561

{ # Input only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8562

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8563

# Compensation based histogram request.

8564

"bucketingOption": { # Input only. # Required. Numeric histogram options, like buckets, whether include min or max value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8565

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8566

# Use this field to specify bucketing option for the histogram search response.

8567

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

8568

# value of the numeric field.

8569

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

8570

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

8571

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

8572

# [buckets_bound is supported.

8573

3.14,

8574

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8575

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8576

"type": "A String", # Required. Type of the request, representing which field the histogramming should be

8577

# performed over. A single request can only specify one histogram of each

8578

# `CompensationHistogramRequestType`.

8579

},

8580

],

8581

"customAttributeHistogramFacets": [ # Optional. Specifies the custom attributes histogram requests.

8582

# Duplicate values of CustomAttributeHistogramRequest.key are not

8583

# allowed.

8584

{ # Custom attributes histogram request. An error will be thrown if neither

8585

# string_value_histogram or long_value_histogram_bucketing_option has

8586

# been defined.

8587

"stringValueHistogram": True or False, # Optional. If set to true, the response will include the histogram value for

8588

# each key as a string.

8589

"longValueHistogramBucketingOption": { # Input only. # Optional. Specifies buckets used to perform a range histogram on Job's

8590

# filterable long custom field values, or min/max value requirements.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8591

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8592

# Use this field to specify bucketing option for the histogram search response.

8593

"requiresMinMax": True or False, # Optional. If set to true, the histogram result includes minimum/maximum

8594

# value of the numeric field.

8595

"bucketBounds": [ # Required. Two adjacent values form a histogram bucket. Values should be in

8596

# ascending order. For example, if [5, 10, 15] are provided, four buckets are

8597

# created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20

8598

# [buckets_bound is supported.

8599

3.14,

8600

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8601

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8602

"key": "A String", # Required. Specifies the custom field key to perform a histogram on. If specified

8603

# without `long_value_histogram_bucketing_option`, histogram on string values

8604

# of the given `key` is triggered, otherwise histogram is performed on long

8605

# values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8606

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8607

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8608

"simpleHistogramFacets": [ # Optional. Specifies the simple type of histogram facets, for example,

8609

# `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to

8610

# GetHistogramRequest.

8611

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8612

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8613

},

8614

"orderBy": "A String", # Deprecated. Use sort_by instead.

#

# Optional.

#

# The criteria determining how search results are sorted.

8619

# Defaults to SortBy.RELEVANCE_DESC if no value is specified.

8620

"jobView": "A String", # Optional. The number of job attributes returned for jobs in the

8621

# search response. Defaults to JobView.SMALL if no value is specified.

8622

"pageToken": "A String", # Optional. The token specifying the current offset within

8623

# search results. See SearchJobsResponse.next_page_token for

8624

# an explanation of how to obtain the next set of query results.

8625

"filters": { # Input only. # Deprecated. Use query instead.

#

# Optional.

#

# Restrictions on the scope of the search request, such as filtering

8630

# by location.

8631

#

8632

# Deprecated. Use JobQuery instead.

8633

#

8634

# The filters required to perform a search query or histogram.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8635

"categories": [ # Optional. The category filter specifies the categories of jobs to search against.

8636

# See Category for more information.

8637

#

8638

# If a value is not specified, jobs from any category are searched against.

8639

#

8640

# If multiple values are specified, jobs from any of the specified

8641

# categories are searched against.

8642

"A String",

8643

],

8644

"customAttributeFilter": "A String", # Optional. This filter specifies a structured syntax to match against the

8645

# Job.custom_attributes that are marked as `filterable`.

8646

#

8647

# The syntax for this expression is a subset of Google SQL syntax.

8648

#

8649

# Supported operators are: =, !=, <, <=, >, >= where the left of the operator

8650

# is a custom field key and the right of the operator is a number or string

8651

# (surrounded by quotes) value.

8652

#

8653

# Supported functions are LOWER(<field_name>) to

8654

# perform case insensitive match and EMPTY(<field_name>) to filter on the

8655

# existence of a key.

8656

#

8657

# Boolean expressions (AND/OR/NOT) are supported up to 3 levels of

8658

# nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can

8659

# be a maximum of 100 comparisons/functions in the expression. The expression

8660

# must be < 3000 bytes in length.

8661

#

8662

# Sample Query:

8663

# (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8664

"locationFilters": [ # Optional. The location filter specifies geo-regions containing the jobs to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8665

# search against. See LocationFilter for more information.

8666

#

8667

# If a location value is not specified, jobs are retrieved

8668

# from all locations.

8669

#

8670

# If multiple values are specified, jobs are retrieved from any of the

8671

# specified locations. If different values are specified for the

8672

# LocationFilter.distance_in_miles parameter, the maximum provided

8673

# distance is used for all locations.

8674

#

8675

# At most 5 location filters are allowed.

8676

{ # Input only.

8677

#

8678

# Geographic region of the search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8679

"regionCode": "A String", # Optional. CLDR region code of the country/region of the address. This will be used

8680

# to address ambiguity of the user-input location, e.g. "Liverpool"

8681

# against "Liverpool, NY, US" or "Liverpool, UK".

8682

#

8683

# Set this field if all the jobs to search against are from a same region,

8684

# or jobs are world-wide but the job seeker is from a specific region.

8685

#

8686

# See http://cldr.unicode.org/ and

8687

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

8688

# for details. Example: "CH" for Switzerland.

8689

"distanceInMiles": 3.14, # Optional. The distance_in_miles is applied when the location being searched for is

8690

# identified as a city or smaller. When the location being searched for is a

8691

# state or larger, this field is ignored.

8692

"isTelecommute": True or False, # Optional. Allows the client to return jobs without a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8693

# set location, specifically, telecommuting jobs (telecomuting is considered

8694

# by the service as a special location.

8695

# Job.allow_telecommute indicates if a job permits telecommuting.

8696

# If this field is true, telecommuting jobs are searched, and

8697

# name and lat_lng are

8698

# ignored.

8699

# This filter can be used by itself to search exclusively for telecommuting

8700

# jobs, or it can be combined with another location

8701

# filter to search for a combination of job locations,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8702

# such as "Mountain View" or "telecommuting" jobs. However, when used in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8703

# combination with other location filters, telecommuting jobs can be

8704

# treated as less relevant than other jobs in the search response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8705

"name": "A String", # Optional. The address name, such as "Mountain View" or "Bay Area".

8706

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Optional. The latitude and longitude of the geographic center from which to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8707

# search. This field is ignored if `location_name` is provided.

8708

# of doubles representing degrees latitude and degrees longitude. Unless

8709

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8710

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8711

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8712

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

8713

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8714

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8715

},

8716

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8717

"publishDateRange": "A String", # Optional. Jobs published within a range specified by this filter are searched

8718

# against, for example, DateRange.PAST_MONTH. If a value is not

8719

# specified, all open jobs are searched against regardless of the

8720

# date they were published.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8721

"companyTitles": [ # Optional. This filter specifies the exact company titles

8722

# of jobs to search against.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8723

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8724

# If a value is not specified, jobs within the search results can be

8725

# associated with any company.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8726

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8727

# If multiple values are specified, jobs within the search results may be

8728

# associated with any of the specified companies.

8729

#

8730

# At most 20 company title filters are allowed.

8731

"A String",

8732

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8733

"languageCodes": [ # Optional. This filter specifies the locale of jobs to search against,

8734

# for example, "en-US".

8735

#

8736

# If a value is not specified, the search results may contain jobs in any

# locale.

#

#

# Language codes should be in BCP-47 format, for example, "en-US" or

8741

# "sr-Latn". For more information, see [Tags for Identifying

8742

# Languages](https://tools.ietf.org/html/bcp47).

8743

#

8744

# At most 10 language code filters are allowed.

8745

"A String",

8746

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8747

"commuteFilter": { # Input only. # Optional. Allows filtering jobs by commute time with different travel methods (e.g.

8748

# driving or public transit). Note: this only works with COMMUTE

8749

# MODE. When specified, [JobFilters.location_filters] will be

8750

# ignored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8751

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8752

# Currently we do not support sorting by commute time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8753

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8754

# Parameters needed for commute search.

8755

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

8756

# commute time.

8757

# of doubles representing degrees latitude and degrees longitude. Unless

8758

# specified otherwise, this must conform to the

8759

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

8760

# standard</a>. Values must be within normalized ranges.

8761

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

8762

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

8763

},

8764

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

8765

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

8766

# Must not be present if departure_hour_local is specified.

8767

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

8768

# integer between 0 and 23, representing the hour in the time zone of the

8769

# start_location. Must not be present if road_traffic is specified.

8770

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

8771

# For city level addresses, the city center is used. For state and coarser

8772

# level addresses, text matching is used.

8773

# If this field is set to `false` or is not specified, only jobs that include

8774

# street level addresses will be returned by commute search.

8775

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

8776

# (one hour). Format is `123s`.

8777

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8778

"compensationFilter": { # Input only. # Optional. This search filter is applied only to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8779

# Job.compensation_info. For example, if the filter is specified

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8780

# as "Hourly job with per-hour compensation > $15", only jobs that meet

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8781

# this criteria are searched. If a filter is not defined, all open jobs

8782

# are searched.

8783

#

8784

# Filter on job compensation type and amount.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8785

"includeJobsWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

8786

"units": [ # Required. Specify desired `base compensation entry's`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8787

# CompensationInfo.CompensationUnit.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8788

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8789

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8790

"range": { # Compensation range. # Optional. Compensation range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8791

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8792

# to a maximal compensation value and the currency code is set to

8793

# match the currency code of

8794

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8795

"units": "A String", # The whole units of the amount.

8796

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

8797

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8798

"nanos": 42, # Number of nano (10^-9) units of the amount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8799

# The value must be between -999,999,999 and +999,999,999 inclusive.

8800

# If `units` is positive, `nanos` must be positive or zero.

8801

# If `units` is zero, `nanos` can be positive, zero, or negative.

8802

# If `units` is negative, `nanos` must be negative or zero.

8803

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8804

},

8805

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

8806

# to zero and the currency code is set to match the

8807

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8808

"units": "A String", # The whole units of the amount.

8809

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

8810

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8811

"nanos": 42, # Number of nano (10^-9) units of the amount.

8812

# The value must be between -999,999,999 and +999,999,999 inclusive.

8813

# If `units` is positive, `nanos` must be positive or zero.

8814

# If `units` is zero, `nanos` can be positive, zero, or negative.

8815

# If `units` is negative, `nanos` must be negative or zero.

8816

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8817

},

8818

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8819

"type": "A String", # Required. Type of filter.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8820

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8821

"query": "A String", # Optional. The query filter contains the keywords that match against the job

8822

# title, description, and location fields.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8823

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8824

# The maximum query size is 255 bytes/characters.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8825

"customFieldFilters": { # Deprecated. Use custom_attribute_filter instead.

#

# Optional.

#

# This filter specifies searching against

8830

# custom field values. See Job.filterable_custom_fields for information.

8831

# The key value specifies a number between 1-20 (the service

8832

# supports 20 custom fields) corresponding to the desired custom field map

8833

# value. If an invalid key is provided or specified together with

8834

# custom_attribute_filter, an error is thrown.

8835

"a_key": { # Input only.

8836

#

8837

# Custom field filter of the search.

8838

"type": "A String", # Optional. The type of filter.

8839

# Defaults to FilterType.OR.

8840

"queries": [ # Required. The query strings for the filter.

"A String",

],

},

},

"disableSpellCheck": True or False, # Optional. This flag controls the spell-check feature. If false, the

8846

# service attempts to correct a misspelled query,

8847

# for example, "enginee" is corrected to "engineer".

8848

#

8849

# Defaults to false: a spell check is performed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8850

"extendedCompensationFilter": { # Deprecated. Always use CompensationFilter. # Deprecated. Always use compensation_filter.

#

# Optional.

#

# This search filter is applied only to

8855

# Job.extended_compensation_info. For example, if the filter is specified

8856

# as "Hourly job with per-hour compensation > $15", only jobs that meet

8857

# these criteria are searched. If a filter is not defined, all open jobs

# are searched.

#

# Input only.

#

# Filter on job compensation type and amount.

8863

"includeJobWithUnspecifiedCompensationRange": True or False, # Optional. Whether to include jobs whose compensation range is unspecified.

8864

"compensationUnits": [ # Required. Specify desired `base compensation entry's`

8865

# ExtendedCompensationInfo.CompensationUnit.

8866

"A String",

8867

],

8868

"type": "A String", # Required. Type of filter.

8869

"currency": "A String", # Optional. Specify currency in 3-letter

8870

# [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If

8871

# unspecified, jobs are returned regardless of currency.

8872

"compensationRange": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

8873

#

8874

# Compensation range.

8875

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

8876

#

8877

# Decimal number.

8878

"micros": 42, # Micro (10^-6) units.

8879

# The value must be between -999,999 and +999,999 inclusive.

8880

# If `units` is positive, `micros` must be positive or zero.

8881

# If `units` is zero, `micros` can be positive, zero, or negative.

8882

# If `units` is negative, `micros` must be negative or zero.

8883

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

8884

"units": "A String", # Whole units.

8885

},

8886

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

8887

#

8888

# Decimal number.

8889

"micros": 42, # Micro (10^-6) units.

8890

# The value must be between -999,999 and +999,999 inclusive.

8891

# If `units` is positive, `micros` must be positive or zero.

8892

# If `units` is zero, `micros` can be positive, zero, or negative.

8893

# If `units` is negative, `micros` must be negative or zero.

8894

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

8895

"units": "A String", # Whole units.

8896

},

8897

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8898

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8899

"companyNames": [ # Optional. The company names filter specifies the company entities to search

8900

# against.

8901

#

8902

# If a value is not specified, jobs are searched for against all companies.

8903

#

8904

# If multiple values are specified, jobs are searched against the

8905

# specified companies.

8906

#

8907

# At most 20 company filters are allowed.

8908

"A String",

8909

],

8910

"tenantJobOnly": True or False, # Deprecated. Do not use this field.

8911

#

8912

# This flag controls whether the job search should be restricted to jobs

8913

# owned by the current user.

8914

#

8915

# Defaults to false where all jobs accessible to the

8916

# user are searched against.

8917

"employmentTypes": [ # Optional. The employment type filter specifies the employment type of jobs to

8918

# search against, such as EmploymentType.FULL_TIME.

8919

#

8920

# If a value is not specified, jobs in the search results include any

8921

# employment type.

8922

#

8923

# If multiple values are specified, jobs in the search results include any

8924

# of the specified employment types.

8925

"A String",

8926

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8927

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8928

"requestMetadata": { # Input only. # Required. The meta information collected about the job searcher, used to improve the

8929

# search quality of the service. The identifiers, (such as `user_id`) are

8930

# provided by users, and must be unique and consistent.

8931

#

8932

# Meta information related to the job searcher or entity

8933

# conducting the job search. This information is used to improve the

8934

# performance of the service.

8935

"sessionId": "A String", # Required. A unique session identification string. A session is defined as the

8936

# duration of an end user's interaction with the service over a period.

8937

# Obfuscate this field for privacy concerns before

8938

# providing it to the API.

8939

#

8940

# If this field is not available for some reason, please send "UNKNOWN". Note

8941

# that any improvements to the service model for a particular tenant site,

8942

# rely on this field being set correctly to some unique session_id.

8943

"domain": "A String", # Required. The client-defined scope or source of the service call, which typically

8944

# is the domain on

8945

# which the service has been implemented and is currently being run.

8946

#

8947

# For example, if the service is being run by client <em>Foo, Inc.</em>, on

8948

# job board www.foo.com and career site www.bar.com, then this field is

8949

# set to "foo.com" for use on the job board, and "bar.com" for use on the

8950

# career site.

8951

#

8952

# If this field is not available for some reason, send "UNKNOWN". Note that

8953

# any improvements to the service model for a particular tenant site rely on

8954

# this field being set correctly to some domain.

8955

"userId": "A String", # Required. A unique user identification string, as determined by the client. The

8956

# client is responsible for ensuring client-level uniqueness of this value

8957

# in order to have the strongest positive impact on search quality.

8958

# Obfuscate this field for privacy concerns before

8959

# providing it to the service.

8960

#

8961

# If this field is not available for some reason, please send "UNKNOWN". Note

8962

# that any improvements to the service model for a particular tenant site,

8963

# rely on this field being set correctly to some unique user_id.

8964

"deviceInfo": { # Input only. # Optional. The type of device used by the job seeker at the time of the call to the

8965

# service.

8966

#

8967

# Device information collected from the job seeker, candidate, or

8968

# other entity conducting the job search. Providing this information improves

8969

# the quality of the search results across devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8970

"id": "A String", # Optional. A device-specific ID. The ID must be a unique identifier that distinguishes

8971

# the device from other devices.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8972

"deviceType": "A String", # Optional. Type of the device.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8973

},

8974

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8975

"sortBy": "A String", # Optional. The criteria determining how search results are sorted.

8976

# Defaults to SortBy.RELEVANCE_DESC if no value is specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

8977

"enableBroadening": True or False, # Optional. Controls whether to broaden the search when it produces sparse results.

8978

# Broadened queries append results to the end of the matching results

8979

# list.

8980

#

8981

# Defaults to false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

8982

}

8983

8984

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

{ # Output only.

#

# Response for SearchJob method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

8995

"metadata": { # Output only. # Additional information for the API invocation, such as the request

8996

# tracking id.

8997

#

8998

# Additional information returned to client, such as debugging

8999

# information.

9000

"requestId": "A String", # A unique id associated with this call.

9001

# This id is logged for tracking purposes.

9002

"mode": "A String", # For search response only. Indicates the mode of a performed search.

9003

"experimentIdList": [ # Identifiers for the versions of the search algorithm used during

9004

# this API invocation if multiple algorithms are used.

9005

# The default value is empty.

9006

# For search response only.

9007

42,

9008

],

9009

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9010

"histogramResults": { # Output only. # The histogram results that match specified

9011

# SearchJobsRequest.HistogramFacets.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9012

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9013

# Histogram results that matches HistogramFacets specified in

9014

# SearchJobsRequest.

9015

"compensationHistogramResults": [ # Specifies compensation field-based histogram results that matches

9016

# HistogramFacets.compensation_histogram_requests.

9017

{ # Output only.

9018

#

9019

# Compensation based histogram result.

9020

"result": { # Output only. # Histogram result.

9021

#

9022

# Custom numeric bucketing result.

9023

"counts": [ # Count within each bucket. Its size is the length of

9024

# NumericBucketingOption.bucket_bounds plus 1.

9025

{ # Represents count of jobs within one bucket.

9026

"count": 42, # Number of jobs whose numeric field value fall into `range`.

9027

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

9028

# that is, the count represents number of jobs in this range.

9029

"to": 3.14, # Ending value of the bucket range.

9030

"from": 3.14, # Starting value of the bucket range.

},

},

],

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

9035

# [NumericBucketingOption.requires_min_max] is set to true.

9036

"maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if

9037

# [NumericBucketingOption.requires_min_max] is set to true.

9038

},

9039

"type": "A String", # Type of the request, corresponding to

9040

# CompensationHistogramRequest.type.

9041

},

9042

],

9043

"customAttributeHistogramResults": [ # Specifies histogram results for custom attributes that

9044

# matches HistogramFacets.custom_attribute_histogram_facets.

9045

{ # Output only.

9046

#

9047

# Custom attribute histogram result.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9048

"longValueHistogramResult": { # Output only. # Stores bucketed histogram counting result or min/max values for

9049

# custom attribute long values associated with `key`.

9050

#

9051

# Custom numeric bucketing result.

9052

"counts": [ # Count within each bucket. Its size is the length of

9053

# NumericBucketingOption.bucket_bounds plus 1.

9054

{ # Represents count of jobs within one bucket.

9055

"count": 42, # Number of jobs whose numeric field value fall into `range`.

9056

"range": { # Represents starting and ending value of a range in double. # Bucket range on which histogram was performed for the numeric field,

9057

# that is, the count represents number of jobs in this range.

9058

"to": 3.14, # Ending value of the bucket range.

9059

"from": 3.14, # Starting value of the bucket range.

},

},

],

"minValue": 3.14, # Stores the minimum value of the numeric field. Will be populated only if

9064

# [NumericBucketingOption.requires_min_max] is set to true.

9065

"maxValue": 3.14, # Stores the maximum value of the numeric field. Will be populated only if

9066

# [NumericBucketingOption.requires_min_max] is set to true.

9067

},

9068

"stringValueHistogramResult": { # Stores a map from the values of string custom field associated

9069

# with `key` to the number of jobs with that value in this histogram result.

9070

"a_key": 42,

9071

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9072

"key": "A String", # Stores the key of custom attribute the histogram is performed on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9073

},

9074

],

9075

"simpleHistogramResults": [ # Specifies histogram results that matches

9076

# HistogramFacets.simple_histogram_facets.

9077

{ # Output only.

9078

#

9079

# Result of a histogram call. The response contains the histogram map for the

9080

# search type specified by HistogramResult.field.

9081

# The response is a map of each filter value to the corresponding count of

9082

# jobs for that filter.

9083

"values": { # A map from the values of field to the number of jobs with that value

9084

# in this search result.

9085

#

9086

# Key: search type (filter names, such as the companyName).

9087

#

9088

# Values: the count of jobs that match the filter for this search.

9089

"a_key": 42,

9090

},

9091

"searchType": "A String", # The Histogram search filters.

},

],

},

"spellResult": { # Output only. # The spell checking result, and correction.

9096

#

9097

# Spell check result.

9098

"corrected": True or False, # Indicates if the query was corrected by the spell checker.

9099

"correctedText": "A String", # Correction output consisting of the corrected keyword string.

9100

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9101

"matchingJobs": [ # The Job entities that match the specified SearchJobsRequest.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9102

{ # Output only.

9103

#

9104

# Job entry with metadata inside SearchJobsResponse.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9105

"job": { # A Job resource represents a job posting (also referred to as a "job listing" # Job resource that matches the specified SearchJobsRequest.

9106

# or "job requisition"). A job belongs to a Company, which is the hiring

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9107

# entity responsible for the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9108

"jobTitle": "A String", # Required. The title of the job, such as "Software Engineer"

9109

#

9110

# The maximum number of allowed characters is 500.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9111

"region": "A String", # Optional. The job Region (for example, state, country) throughout which the job

9112

# is available. If this field is set, a

9113

# LocationFilter in a search query within the job region

9114

# finds this job if an exact location match is not specified.

9115

# If this field is set, setting job locations

9116

# to the same location level as this field is strongly recommended.

9117

"referenceUrl": "A String", # Output only. The URL of a web page that displays job details.

9118

"companyTitle": "A String", # Deprecated. Use company_display_name instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9119

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9120

# Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9121

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9122

# The name of the company listing the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9123

"responsibilities": "A String", # Optional. A description of job responsibilities. The use of this field is

9124

# recommended as an alternative to using the more general description

9125

# field.

9126

#

9127

# This field accepts and sanitizes HTML input, and also accepts

9128

# bold, italic, ordered list, and unordered list markup tags.

9129

#

9130

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9131

"compensationInfo": { # Job compensation details. # Optional. Job compensation information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9132

"annualizedTotalCompensationRange": { # Compensation range. # Output only. Annualized total compensation range. Computed as

9133

# all compensation entries' CompensationEntry.compensation times

9134

# CompensationEntry.expected_units_per_year.

9135

#

9136

# See CompensationEntry for explanation on compensation annualization.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9137

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

9138

# to a maximal compensation value and the currency code is set to

9139

# match the currency code of

9140

# min_compensation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9141

"units": "A String", # The whole units of the amount.

9142

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9143

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9144

"nanos": 42, # Number of nano (10^-9) units of the amount.

9145

# The value must be between -999,999,999 and +999,999,999 inclusive.

9146

# If `units` is positive, `nanos` must be positive or zero.

9147

# If `units` is zero, `nanos` can be positive, zero, or negative.

9148

# If `units` is negative, `nanos` must be negative or zero.

9149

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9150

},

9151

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

9152

# to zero and the currency code is set to match the

9153

# currency code of max_compensation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9154

"units": "A String", # The whole units of the amount.

9155

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9156

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9157

"nanos": 42, # Number of nano (10^-9) units of the amount.

9158

# The value must be between -999,999,999 and +999,999,999 inclusive.

9159

# If `units` is positive, `nanos` must be positive or zero.

9160

# If `units` is zero, `nanos` can be positive, zero, or negative.

9161

# If `units` is negative, `nanos` must be negative or zero.

9162

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9163

},

9164

},

9165

"min": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# A lower bound on a range for compensation or pay for the job.

9170

# The currency type is specified in compensation_amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9171

"units": "A String", # The whole units of the amount.

9172

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9173

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9174

"nanos": 42, # Number of nano (10^-9) units of the amount.

9175

# The value must be between -999,999,999 and +999,999,999 inclusive.

9176

# If `units` is positive, `nanos` must be positive or zero.

9177

# If `units` is zero, `nanos` can be positive, zero, or negative.

9178

# If `units` is negative, `nanos` must be negative or zero.

9179

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9180

},

9181

"entries": [ # Optional. Job compensation information.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9182

#

9183

# At most one entry can be of type

9184

# CompensationInfo.CompensationType.BASE, which is

9185

# referred as ** base compensation entry ** for the job.

9186

{ # A compensation entry that represents one component of compensation, such

9187

# as base pay, bonus, or other compensation type.

9188

#

9189

# Annualization: One compensation entry can be annualized if

9190

# - it contains valid amount or range.

9191

# - and its expected_units_per_year is set or can be derived.

9192

# Its annualized range is determined as (amount or range) times

9193

# expected_units_per_year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9194

"expectedUnitsPerYear": 3.14, # Optional. Expected number of units paid each year. If not specified, when

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9195

# Job.employment_types is FULLTIME, a default value is inferred

9196

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9202

"description": "A String", # Optional. Compensation description. For example, could

9203

# indicate equity terms or provide additional context to an estimated

9204

# bonus.

9205

"unit": "A String", # Optional. Frequency of the specified amount.

9206

#

9207

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

9208

"amount": { # Represents an amount of money with its currency type. # Optional. Compensation amount.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9209

"units": "A String", # The whole units of the amount.

9210

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9211

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9212

"nanos": 42, # Number of nano (10^-9) units of the amount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9213

# The value must be between -999,999,999 and +999,999,999 inclusive.

9214

# If `units` is positive, `nanos` must be positive or zero.

9215

# If `units` is zero, `nanos` can be positive, zero, or negative.

9216

# If `units` is negative, `nanos` must be negative or zero.

9217

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9218

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9219

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9220

"range": { # Compensation range. # Optional. Compensation range.

9221

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

9222

# to a maximal compensation value and the currency code is set to

9223

# match the currency code of

9224

# min_compensation.

9225

"units": "A String", # The whole units of the amount.

9226

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9227

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

9228

"nanos": 42, # Number of nano (10^-9) units of the amount.

9229

# The value must be between -999,999,999 and +999,999,999 inclusive.

9230

# If `units` is positive, `nanos` must be positive or zero.

9231

# If `units` is zero, `nanos` can be positive, zero, or negative.

9232

# If `units` is negative, `nanos` must be negative or zero.

9233

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

9234

},

9235

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

9236

# to zero and the currency code is set to match the

9237

# currency code of max_compensation.

9238

"units": "A String", # The whole units of the amount.

9239

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9240

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

9241

"nanos": 42, # Number of nano (10^-9) units of the amount.

9242

# The value must be between -999,999,999 and +999,999,999 inclusive.

9243

# If `units` is positive, `nanos` must be positive or zero.

9244

# If `units` is zero, `nanos` can be positive, zero, or negative.

9245

# If `units` is negative, `nanos` must be negative or zero.

9246

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

9247

},

9248

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9249

},

9250

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9251

"annualizedBaseCompensationRange": { # Compensation range. # Output only. Annualized base compensation range. Computed as

9252

# base compensation entry's CompensationEntry.compensation times

9253

# CompensationEntry.expected_units_per_year.

9254

#

9255

# See CompensationEntry for explanation on compensation annualization.

9256

"max": { # Represents an amount of money with its currency type. # Optional. The maximum amount of compensation. If left empty, the value is set

9257

# to a maximal compensation value and the currency code is set to

9258

# match the currency code of

9259

# min_compensation.

9260

"units": "A String", # The whole units of the amount.

9261

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9262

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

9263

"nanos": 42, # Number of nano (10^-9) units of the amount.

9264

# The value must be between -999,999,999 and +999,999,999 inclusive.

9265

# If `units` is positive, `nanos` must be positive or zero.

9266

# If `units` is zero, `nanos` can be positive, zero, or negative.

9267

# If `units` is negative, `nanos` must be negative or zero.

9268

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

9269

},

9270

"min": { # Represents an amount of money with its currency type. # Optional. The minimum amount of compensation. If left empty, the value is set

9271

# to zero and the currency code is set to match the

9272

# currency code of max_compensation.

9273

"units": "A String", # The whole units of the amount.

9274

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9275

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

9276

"nanos": 42, # Number of nano (10^-9) units of the amount.

9277

# The value must be between -999,999,999 and +999,999,999 inclusive.

9278

# If `units` is positive, `nanos` must be positive or zero.

9279

# If `units` is zero, `nanos` can be positive, zero, or negative.

9280

# If `units` is negative, `nanos` must be negative or zero.

9281

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

9282

},

9283

},

9284

"amount": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# The amount of compensation or pay for the job.

9289

# As an alternative, compensation_amount_min and

9290

# compensation_amount_max may be used to define a range of

9291

# compensation.

9292

"units": "A String", # The whole units of the amount.

9293

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9294

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

9295

"nanos": 42, # Number of nano (10^-9) units of the amount.

9296

# The value must be between -999,999,999 and +999,999,999 inclusive.

9297

# If `units` is positive, `nanos` must be positive or zero.

9298

# If `units` is zero, `nanos` can be positive, zero, or negative.

9299

# If `units` is negative, `nanos` must be negative or zero.

9300

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

9301

},

9302

"type": "A String", # Deprecated. Use entries instead.

#

# Optional.

#

# Type of job compensation.

9307

"max": { # Represents an amount of money with its currency type. # Deprecated. Use entries instead.

#

# Optional.

#

# An upper bound on a range for compensation or pay for the job.

9312

# The currency type is specified in compensation_amount.

9313

"units": "A String", # The whole units of the amount.

9314

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

9315

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

9316

"nanos": 42, # Number of nano (10^-9) units of the amount.

9317

# The value must be between -999,999,999 and +999,999,999 inclusive.

9318

# If `units` is positive, `nanos` must be positive or zero.

9319

# If `units` is zero, `nanos` can be positive, zero, or negative.

9320

# If `units` is negative, `nanos` must be negative or zero.

9321

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

9322

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9323

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9324

"expireTime": "A String", # Optional but strongly recommended for the best service

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9325

# experience.

9326

#

9327

# The expiration timestamp of the job. After this timestamp, the

9328

# job is marked as expired, and it no longer appears in search results. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9329

# expired job can't be deleted or listed by the DeleteJob and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9330

# ListJobs APIs, but it can be retrieved with the GetJob API or

9331

# updated with the UpdateJob API. An expired job can be updated and

9332

# opened again by using a future expiration timestamp. Updating an expired

9333

# job fails if there is another existing open job with same

9334

# requisition_id, company_name and language_code.

9335

#

9336

# The expired jobs are retained in our system for 90 days. However, the

9337

# overall expired job count cannot exceed 3 times the maximum of open jobs

9338

# count over the past week, otherwise jobs with earlier expire time are

9339

# cleaned first. Expired jobs are no longer accessible after they are cleaned

9340

# out.

9341

# The format of this field is RFC 3339 date strings. Example:

9342

# 2000-01-01T00:00:00.999999999Z

9343

# See

9344

# [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).

9345

#

9346

# A valid date range is between 1970-01-01T00:00:00.0Z and

9347

# 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire

9348

# time not provided.

9349

#

9350

# If this value is not provided at the time of job creation or is invalid,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9351

# the job posting expires after 30 days from the job's creation time. For

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9352

# example, if the job was created on 2017/01/01 13:00AM UTC with an

9353

# unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

9354

#

9355

# If this value is not provided but expiry_date is, expiry_date is

9356

# used.

9357

#

9358

# If this value is not provided on job update, it depends on the field masks

9359

# set by UpdateJobRequest.update_job_fields. If the field masks include

9360

# expiry_time, or the masks are empty meaning that every field is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9361

# updated, the job posting expires after 30 days from the job's last

9362

# update time. Otherwise the expiration date isn't updated.

9363

"updateTime": "A String", # Output only. The timestamp when this job was last updated.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9364

"department": "A String", # Optional. The department or functional area within the company with the open

9365

# position.

9366

#

9367

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9368

"jobLocations": [ # Output only. Structured locations of the job, resolved from locations.

9369

{ # Output only.

9370

#

9371

# A resource that represents a location with full geographic

9372

# information.

9373

"postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. # Postal address of the location that includes human readable information,

9374

# such as postal delivery and payments addresses. Given a postal address,

9375

# a postal service can deliver items to a premises, P.O. Box, or other

9376

# delivery location.

9377

# Given a postal address, a postal service can deliver items to a premise, P.O.

9378

# Box or similar.

9379

# It is not intended to model geographical locations (roads, towns,

9380

# mountains).

9381

#

9382

# In typical usage an address would be created via user input or from importing

9383

# existing data, depending on the type of process.

9384

#

9385

# Advice on address input / editing:

9386

# - Use an i18n-ready address widget such as

9387

# https://github.com/google/libaddressinput)

9388

# - Users should not be presented with UI elements for input or editing of

9389

# fields outside countries where that field is used.

9390

#

9391

# For more guidance on how to use this schema, please see:

9392

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9393

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

9394

# Examples: US city, IT comune, UK post town.

9395

# In regions of the world where localities are not well defined or do not fit

9396

# into this structure well, leave locality empty and use address_lines.

9397

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

9398

# addresses of a country or region.

9399

# For example, this can be a state, a province, an oblast, or a prefecture.

9400

# Specifically, for Spain this is the province and not the autonomous

9401

# community (e.g. "Barcelona" and not "Catalonia").

9402

# Many countries don't use an administrative area in postal addresses. E.g.

9403

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9404

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9405

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

9406

#

9407

# Because values in address_lines do not have type information and may

9408

# sometimes contain multiple values in a single field (e.g.

9409

# "Austin, TX"), it is important that the line order is clear. The order of

9410

# address lines should be "envelope order" for the country/region of the

9411

# address. In places where this can vary (e.g. Japan), address_language is

9412

# used to make it explicit (e.g. "ja" for large-to-small ordering and

9413

# "ja-Latn" or "en" for small-to-large). This way, the most specific line of

9414

# an address can be selected based on the language.

9415

#

9416

# The minimum permitted structural representation of an address consists

9417

# of a region_code with all remaining information placed in the

9418

# address_lines. It would be possible to format such an address very

9419

# approximately without geocoding, but no semantic reasoning could be

9420

# made about any of the address components until it was at least

9421

# partially resolved.

9422

#

9423

# Creating an address only containing a region_code and address_lines, and

9424

# then geocoding is the recommended way to handle completely unstructured

9425

# addresses (as opposed to guessing which parts of the address should be

9426

# localities or administrative areas).

9427

"A String",

9428

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9429

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

9430

# is never inferred and it is up to the user to ensure the value is

9431

# correct. See http://cldr.unicode.org/ and

9432

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

9433

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9434

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

9435

# postal codes to be present, but where they are used, they may trigger

9436

# additional validation with other parts of the address (e.g. state/zip

9437

# validation in the U.S.A.).

9438

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

9439

# in most regions. Where it is used, the value is either a string like

9440

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

9441

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

9442

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

9443

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

9444

# known). This is often the UI language of the input form or is expected

9445

# to match one of the languages used in the address' country/region, or their

9446

# transliterated equivalents.

9447

# This can affect formatting in certain countries, but is not critical

9448

# to the correctness of the data and will never affect any validation or

9449

# other non-formatting related operations.

9450

#

9451

# If this value is not known, it should be omitted (rather than specifying a

9452

# possibly incorrect default).

9453

#

9454

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

9455

"recipients": [ # Optional. The recipient at the address.

9456

# This field may, under certain circumstances, contain multiline information.

9457

# For example, it might contain "care of" information.

9458

"A String",

9459

],

9460

"sublocality": "A String", # Optional. Sublocality of the address.

9461

# For example, this can be neighborhoods, boroughs, districts.

9462

"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is

9463

# the latest revision.

9464

#

9465

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9466

},

9467

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

9468

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

9469

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

9470

# LocationType#LOCALITY.

9471

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

9472

# location bounding box in which a circle with the specified radius

9473

# centered from LatLng coves the area associated with the job location.

9474

# For example, currently, "Mountain View, CA, USA" has a radius of

9475

# 7885.79 meters.

9476

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

9477

# of doubles representing degrees latitude and degrees longitude. Unless

9478

# specified otherwise, this must conform to the

9479

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

9480

# standard</a>. Values must be within normalized ranges.

9481

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

9482

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

9483

},

9484

},

9485

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9486

"unindexedCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold non-filterable custom job attributes, similar to

9491

# filterable_custom_fields. These fields are distinct in that the data

9492

# in these fields are not indexed. Therefore, the client cannot search

9493

# against them, nor can the client use them to list jobs.

9494

#

9495

# The key of the map can be any valid string.

9496

"a_key": { # Resource that represents the custom data not captured by the standard fields.

9497

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"expiryDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Deprecated. Use expire_time instead.

9503

#

9504

# Optional but strongly recommended to be provided for the best service

9505

# experience.

9506

#

9507

# The expiration date of the job in UTC time. After 12 am on this date, the

9508

# job is marked as expired, and it no longer appears in search results.

9509

# The expired job can't be deleted or listed by the DeleteJob and

9510

# ListJobs APIs, but it can be retrieved with the GetJob API or

9511

# updated with the UpdateJob API. An expired job can be updated and

9512

# opened again by using a future expiration date. It can also remain expired.

9513

# Updating an expired job to be open fails if there is another existing open

9514

# job with same requisition_id, company_name and language_code.

9515

#

9516

# The expired jobs are retained in our system for 90 days. However, the

9517

# overall expired job count cannot exceed 3 times the maximum of open jobs

9518

# count over the past week, otherwise jobs with earlier expire time are

9519

# removed first. Expired jobs are no longer accessible after they are cleaned

9520

# out.

9521

#

9522

# A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are

9523

# ignored and treated as expiry date not provided.

9524

#

9525

# If this value is not provided on job creation or is invalid, the job

9526

# posting expires after 30 days from the job's creation time. For example, if

9527

# the job was created on 2017/01/01 13:00AM UTC with an unspecified

9528

# expiration date, the job expires after 2017/01/31 13:00AM UTC.

9529

#

9530

# If this value is not provided on job update, it depends on the field masks

9531

# set by UpdateJobRequest.update_job_fields. If the field masks include

9532

# expiry_date, or the masks are empty meaning that every field is

9533

# updated, the job expires after 30 days from the job's last update time.

9534

# Otherwise the expiration date isn't updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9535

# and time zone are either specified elsewhere or are not significant. The date

9536

# is relative to the Proleptic Gregorian Calendar. This can represent:

9537

#

9538

# * A full date, with non-zero year, month and day values

9539

# * A month and day value, with a zero year, e.g. an anniversary

9540

# * A year on its own, with zero month and day values

9541

# * A year and month value, with a zero day, e.g. a credit card expiration date

9542

#

9543

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9544

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9545

# if specifying a year by itself or a year and month where the day is not

9546

# significant.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9547

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9548

# a year.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9549

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

9550

# month and day.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9551

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9552

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The end date of the job in UTC time zone. Typically this field

9553

# is used for contracting engagements.

9554

# Dates prior to 1970/1/1 and invalid date formats are ignored.

9555

# and time zone are either specified elsewhere or are not significant. The date

9556

# is relative to the Proleptic Gregorian Calendar. This can represent:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9557

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9558

# * A full date, with non-zero year, month and day values

9559

# * A month and day value, with a zero year, e.g. an anniversary

9560

# * A year on its own, with zero month and day values

9561

# * A year and month value, with a zero day, e.g. a credit card expiration date

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9562

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9563

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

9564

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

9565

# if specifying a year by itself or a year and month where the day is not

9566

# significant.

9567

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

9568

# a year.

9569

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

9570

# month and day.

9571

},

9572

"educationLevels": [ # Optional. The desired education level for the job, such as

9573

# "Bachelors", "Masters", "Doctorate".

9574

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9575

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9576

"customAttributes": { # Optional. A map of fields to hold both filterable and non-filterable custom job

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9577

# attributes that are not covered by the provided structured fields.

9578

#

9579

# This field is a more general combination of the deprecated id-based

9580

# filterable_custom_fields and string-based

9581

# non_filterable_custom_fields.

9582

#

9583

# The keys of the map are strings up to 64 bytes and must match the

9584

# pattern: a-zA-Z*.

9585

#

9586

# At most 100 filterable and at most 100 unfilterable keys are supported.

9587

# For filterable `string_values`, across all keys at most 200 values are

9588

# allowed, with each string no more than 255 characters. For unfilterable

9589

# `string_values`, the maximum total size of `string_values` across all keys

9590

# is 50KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9591

"a_key": { # Custom attribute values that are either filterable or non-filterable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9592

"longValue": "A String", # Optional but at least one of string_values or long_value must

9593

# be specified.

9594

#

9595

# This field is used to perform number range search.

9596

# (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For

9597

# `long_value`, a value between Long.MIN and Long.MAX is allowed.

9598

"stringValues": { # Represents array of string values. # Optional but at least one of string_values or long_value must

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9599

# be specified.

9600

#

9601

# This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or

9602

# `CASE_INSENSITIVE_MATCH`) search.

9603

# For filterable `string_values`, a maximum total number of 200 values

9604

# is allowed, with each `string_value` has a byte size of no more than

9605

# 255B. For unfilterable `string_values`, the maximum total byte size of

9606

# unfilterable `string_values` is 50KB.

9607

#

9608

# Empty strings are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9609

"values": [ # Required. String values.

9610

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9611

],

9612

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9613

"filterable": True or False, # Optional. If the `filterable` flag is true, custom field values are searchable.

9614

# If false, values are not searchable.

9615

#

9616

# Default is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9617

},

9618

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9619

"filterableCustomFields": { # Deprecated. Use custom_attributes instead.

#

# Optional.

#

# A map of fields to hold filterable custom job attributes not captured by

9624

# the standard fields such as job_title, company_name, or

9625

# level. These custom fields store arbitrary

9626

# string values, and can be used for purposes not covered by

9627

# the structured fields. For the best search experience, use of the

9628

# structured rather than custom fields is recommended.

9629

#

9630

# Data stored in these custom fields fields are indexed and

9631

# searched against by keyword searches (see

9632

# SearchJobsRequest.custom_field_filters][]).

9633

#

9634

# The map key must be a number between 1-20. If an invalid key is

9635

# provided on job create or update, an error is returned.

9636

"a_key": { # Resource that represents the custom data not captured by the standard fields.

9637

"values": [ # Optional. The values of the custom data.

"A String",

],

},

},

"languageCode": "A String", # Optional. The language of the posting. This field is distinct from

9643

# any requirements for fluency that are associated with the job.

9644

#

9645

# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".

9646

# For more information, see

9647

# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:

9648

# class="external" target="_blank" }.

9649

#

9650

# If this field is unspecified and Job.description is present, detected

9651

# language code based on Job.description is assigned, otherwise

9652

# defaults to 'en_US'.

9653

"visibility": "A String", # Optional. The visibility of the job.

9654

# Defaults to JobVisibility.PRIVATE if not specified.

9655

# Currently only JobVisibility.PRIVATE is supported.

9656

"name": "A String", # Required during job update.

9657

#

9658

# Resource name assigned to a job by the API, for example, "/jobs/foo". Use

9659

# of this field in job queries and API calls is preferred over the use of

9660

# requisition_id since this value is unique.

9661

"distributorCompanyId": "A String", # Optional but one of company_name or distributor_company_id must be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9662

# provided.

9663

#

9664

# A unique company identifier used by job distributors to identify an

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9665

# employer's company entity. company_name takes precedence over

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9666

# this field, and is the recommended field to use to identify companies.

9667

#

9668

# The maximum number of allowed characters is 255.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9669

"promotionValue": 42, # Optional. A promotion value of the job, as determined by the client.

9670

# The value determines the sort order of the jobs returned when searching for

9671

# jobs using the featured jobs search call, with higher promotional values

9672

# being returned first and ties being resolved by relevance sort. Only the

9673

# jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

9674

#

9675

# Default value is 0, and negative values are treated as 0.

9676

"publishDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The date this job was most recently published in UTC format. The default

9677

# value is the time the request arrives at the server.

9678

# and time zone are either specified elsewhere or are not significant. The date

9679

# is relative to the Proleptic Gregorian Calendar. This can represent:

9680

#

9681

# * A full date, with non-zero year, month and day values

9682

# * A month and day value, with a zero year, e.g. an anniversary

9683

# * A year on its own, with zero month and day values

9684

# * A year and month value, with a zero day, e.g. a credit card expiration date

9685

#

9686

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

9687

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

9688

# if specifying a year by itself or a year and month where the day is not

9689

# significant.

9690

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

9691

# a year.

9692

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

9693

# month and day.

9694

},

9695

"applicationUrls": [ # Optional but at least one of application_urls,

9696

# application_email_list or application_instruction must be

9697

# specified.

9698

#

9699

# Use this URL field to direct an applicant to a website, for example to

9700

# link to an online application form.

9701

#

9702

# The maximum number of allowed characters is 2,000.

9703

"A String",

9704

],

9705

"companyDisplayName": "A String", # Output only. The name of the company listing the job.

9706

"requisitionId": "A String", # Required. The requisition ID, also referred to as the posting ID, assigned by the

9707

# client to identify a job. This field is intended to be used by clients

9708

# for client identification and tracking of listings. A job is not allowed

9709

# to be created if there is another job with the same requisition_id,

9710

# company_name and language_code.

9711

#

9712

# The maximum number of allowed characters is 255.

9713

"qualifications": "A String", # Optional. A description of the qualifications required to perform the

9714

# job. The use of this field is recommended

9715

# as an alternative to using the more general description field.

9716

#

9717

# This field accepts and sanitizes HTML input, and also accepts

9718

# bold, italic, ordered list, and unordered list markup tags.

9719

#

9720

# The maximum number of allowed characters is 10,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9721

"createTime": "A String", # Output only. The timestamp when this job was created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9722

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Optional. The start date of the job in UTC time zone. Typically this field

9723

# is used for contracting engagements.

9724

# Dates prior to 1970/1/1 and invalid date formats are ignored.

9725

# and time zone are either specified elsewhere or are not significant. The date

9726

# is relative to the Proleptic Gregorian Calendar. This can represent:

9727

#

9728

# * A full date, with non-zero year, month and day values

9729

# * A month and day value, with a zero year, e.g. an anniversary

9730

# * A year on its own, with zero month and day values

9731

# * A year and month value, with a zero day, e.g. a credit card expiration date

9732

#

9733

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

9734

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

9735

# if specifying a year by itself or a year and month where the day is not

9736

# significant.

9737

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

9738

# a year.

9739

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

9740

# month and day.

9741

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9742

"level": "A String", # Optional. The experience level associated with the job, such as "Entry Level".

9743

"applicationInstruction": "A String", # Optional but at least one of application_urls,

9744

# application_email_list or application_instruction must be

9745

# specified.

9746

#

9747

# Use this field to provide instructions, such as "Mail your application

9748

# to ...", that a candidate can follow to apply for the job.

9749

#

9750

# This field accepts and sanitizes HTML input, and also accepts

9751

# bold, italic, ordered list, and unordered list markup tags.

9752

#

9753

# The maximum number of allowed characters is 3,000.

9754

"benefits": [ # Optional. The benefits included with the job.

9755

"A String",

9756

],

9757

"incentives": "A String", # Optional. A description of bonus, commission, and other compensation

9758

# incentives associated with the job not including salary or pay.

9759

#

9760

# The maximum number of allowed characters is 10,000.

9761

"employmentTypes": [ # Optional. The employment type(s) of a job, for example,

# full time or

# part time.

"A String",

],

"locations": [ # Optional but strongly recommended for the best service experience.

9767

#

9768

# Location(s) where the emploeyer is looking to hire for this job posting.

9769

#

9770

# Specifying the full street address(es) of the hiring location enables

9771

# better API results, especially job searches by commute time.

9772

#

9773

# At most 50 locations are allowed for best search performance. If a job has

9774

# more locations, it is suggested to split it into multiple jobs with unique

9775

# requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as

9776

# multiple jobs with the same requisition_id, company_name and

9777

# language_code are not allowed. If the original requisition_id must

9778

# be preserved, a custom field should be used for storage. It is also

9779

# suggested to group the locations that close to each other in the same job

9780

# for better search experience.

9781

#

9782

# The maximum number of allowed characters is 500.

9783

"A String",

9784

],

9785

"extendedCompensationInfo": { # Deprecated. Use CompensationInfo. # Deprecated. Always use compensation_info.

#

# Optional.

#

# Job compensation information.

9790

#

9791

# This field replaces compensation_info. Only

9792

# CompensationInfo.entries or extended_compensation_info can be set,

9793

# otherwise an exception is thrown.

9794

#

9795

# Describes job compensation.

9796

"currency": "A String", # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)

9797

# currency code.

9798

"annualizedTotalCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized total compensation range.

9799

#

9800

# Compensation range.

9801

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

9802

#

9803

# Decimal number.

9804

"micros": 42, # Micro (10^-6) units.

9805

# The value must be between -999,999 and +999,999 inclusive.

9806

# If `units` is positive, `micros` must be positive or zero.

9807

# If `units` is zero, `micros` can be positive, zero, or negative.

9808

# If `units` is negative, `micros` must be negative or zero.

9809

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9810

"units": "A String", # Whole units.

9811

},

9812

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

9813

#

9814

# Decimal number.

9815

"micros": 42, # Micro (10^-6) units.

9816

# The value must be between -999,999 and +999,999 inclusive.

9817

# If `units` is positive, `micros` must be positive or zero.

9818

# If `units` is zero, `micros` can be positive, zero, or negative.

9819

# If `units` is negative, `micros` must be negative or zero.

9820

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9821

"units": "A String", # Whole units.

9822

},

9823

},

9824

"entries": [ # Optional. Job compensation information.

9825

#

9826

# At most one entry can be of type

9827

# ExtendedCompensationInfo.CompensationType.BASE, which is

9828

# referred as ** base compensation entry ** for the job.

9829

{ # Deprecated. See CompensationInfo.

9830

#

9831

# A compensation entry that represents one component of compensation, such

9832

# as base pay, bonus, or other compensation type.

9833

#

9834

# Annualization: One compensation entry can be annualized if

9835

# - it contains valid amount or range.

9836

# - and its expected_units_per_year is set or can be derived.

9837

# Its annualized range is determined as (amount or range) times

9838

# expected_units_per_year.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

9839

"amount": { # Deprecated. See CompensationInfo. # Optional. Monetary amount.

9840

#

9841

# Decimal number.

9842

"micros": 42, # Micro (10^-6) units.

9843

# The value must be between -999,999 and +999,999 inclusive.

9844

# If `units` is positive, `micros` must be positive or zero.

9845

# If `units` is zero, `micros` can be positive, zero, or negative.

9846

# If `units` is negative, `micros` must be negative or zero.

9847

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9848

"units": "A String", # Whole units.

9849

},

9850

"type": "A String", # Required. Compensation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9851

"range": { # Deprecated. See CompensationInfo. # Optional. Compensation range.

9852

#

9853

# Compensation range.

9854

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

9855

#

9856

# Decimal number.

9857

"micros": 42, # Micro (10^-6) units.

9858

# The value must be between -999,999 and +999,999 inclusive.

9859

# If `units` is positive, `micros` must be positive or zero.

9860

# If `units` is zero, `micros` can be positive, zero, or negative.

9861

# If `units` is negative, `micros` must be negative or zero.

9862

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9863

"units": "A String", # Whole units.

9864

},

9865

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

9866

#

9867

# Decimal number.

9868

"micros": 42, # Micro (10^-6) units.

9869

# The value must be between -999,999 and +999,999 inclusive.

9870

# If `units` is positive, `micros` must be positive or zero.

9871

# If `units` is zero, `micros` can be positive, zero, or negative.

9872

# If `units` is negative, `micros` must be negative or zero.

9873

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9874

"units": "A String", # Whole units.

9875

},

9876

},

9877

"expectedUnitsPerYear": { # Deprecated. See CompensationInfo. # Optional. Expected number of units paid each year. If not specified, when

9878

# Job.employment_types is FULLTIME, a default value is inferred

9879

# based on unit. Default values:

# - HOURLY: 2080

# - DAILY: 260

# - WEEKLY: 52

# - MONTHLY: 12

# - ANNUAL: 1

#

# Decimal number.

"micros": 42, # Micro (10^-6) units.

9888

# The value must be between -999,999 and +999,999 inclusive.

9889

# If `units` is positive, `micros` must be positive or zero.

9890

# If `units` is zero, `micros` can be positive, zero, or negative.

9891

# If `units` is negative, `micros` must be negative or zero.

9892

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9893

"units": "A String", # Whole units.

9894

},

9895

"unspecified": True or False, # Optional. Indicates compensation amount and range are unset.

9896

"description": "A String", # Optional. Compensation description.

9897

"unit": "A String", # Optional. Frequency of the specified amount.

9898

#

9899

# Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9900

},

9901

],

9902

"annualizedTotalCompensationUnspecified": True or False, # Output only. Indicates annualized total compensation range cannot be derived, due to

9903

# the job's all CompensationEntry cannot be annualized.

9904

# See CompensationEntry for explanation on annualization and base

9905

# compensation entry.

9906

"annualizedBaseCompensationRange": { # Deprecated. See CompensationInfo. # Output only. Annualized base compensation range.

9907

#

9908

# Compensation range.

9909

"min": { # Deprecated. See CompensationInfo. # Required. Minimum value.

9910

#

9911

# Decimal number.

9912

"micros": 42, # Micro (10^-6) units.

9913

# The value must be between -999,999 and +999,999 inclusive.

9914

# If `units` is positive, `micros` must be positive or zero.

9915

# If `units` is zero, `micros` can be positive, zero, or negative.

9916

# If `units` is negative, `micros` must be negative or zero.

9917

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9918

"units": "A String", # Whole units.

9919

},

9920

"max": { # Deprecated. See CompensationInfo. # Required. Maximum value.

9921

#

9922

# Decimal number.

9923

"micros": 42, # Micro (10^-6) units.

9924

# The value must be between -999,999 and +999,999 inclusive.

9925

# If `units` is positive, `micros` must be positive or zero.

9926

# If `units` is zero, `micros` can be positive, zero, or negative.

9927

# If `units` is negative, `micros` must be negative or zero.

9928

# For example -1.75 is represented as `units`=-1 and `micros`=-750,000.

9929

"units": "A String", # Whole units.

9930

},

9931

},

9932

"annualizedBaseCompensationUnspecified": True or False, # Output only. Indicates annualized base compensation range cannot be derived, due to

9933

# the job's base compensation entry cannot be annualized.

9934

# See CompensationEntry for explanation on annualization and base

9935

# compensation entry.

9936

},

9937

"companyName": "A String", # Optional but one of company_name or distributor_company_id must be

9938

# provided.

9939

#

9940

# The resource name of the company listing the job, such as

9941

# /companies/foo. This field takes precedence over the

9942

# distributor-assigned company identifier, distributor_company_id.

9943

"description": "A String", # Required. The description of the job, which typically includes a multi-paragraph

9944

# description of the company and related information. Separate fields are

9945

# provided on the job object for responsibilities,

9946

# qualifications, and other job characteristics. Use of

9947

# these separate job fields is recommended.

9948

#

9949

# This field accepts and sanitizes HTML input, and also accepts

9950

# bold, italic, ordered list, and unordered list markup tags.

9951

#

9952

# The maximum number of allowed characters is 100,000.

9953

"applicationEmailList": [ # Optional but at least one of application_urls,

9954

# application_email_list or application_instruction must be

9955

# specified.

9956

#

9957

# Use this field to specify email address(es) to which resumes or

9958

# applications can be sent.

9959

#

9960

# The maximum number of allowed characters is 255.

9961

"A String",

9962

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9963

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9964

"searchTextSnippet": "A String", # Contains snippets of text from the Job.description and similar

9965

# fields that most closely match a search query's keywords, if available.

9966

# All HTML tags in the original fields are stripped when returned in this

9967

# field, and matching query keywords are enclosed in HTML bold tags.

9968

"jobTitleSnippet": "A String", # Contains snippets of text from the Job.job_title field most

9969

# closely matching a search query's keywords, if available. The matching

9970

# query keywords are enclosed in HTML bold tags.

9971

"jobSummary": "A String", # A summary of the job with core information that's displayed on the search

9972

# results listing page.

9973

"commuteInfo": { # Output only. # Commute information which is generated based on specified

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9974

# CommutePreference.

9975

#

9976

# Commute details related to this job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9977

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9978

# location. A duration of 0 seconds indicates that the job is not

9979

# reachable within the requested duration, but was returned as part of an

9980

# expanded query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9981

"jobLocation": { # Output only. # Location used as the destination in the commute calculation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

9982

#

9983

# A resource that represents a location with full geographic

9984

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

9985

"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]

9986

# such as postal delivery and payments addresses. Given a postal address,

9987

# a postal service can deliver items to a premises, P.O. Box, or other

9988

# delivery location.

9989

# Given a postal address, a postal service can deliver items to a premise, P.O.

9990

# Box or similar.

9991

# It is not intended to model geographical locations (roads, towns,

9992

# mountains).

9993

#

9994

# In typical usage an address would be created via user input or from importing

9995

# existing data, depending on the type of process.

9996

#

9997

# Advice on address input / editing:

9998

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

9999

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10000

# - Users should not be presented with UI elements for input or editing of

10001

# fields outside countries where that field is used.

10002

#

10003

# For more guidance on how to use this schema, please see:

10004

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

10005

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

10006

# Examples: US city, IT comune, UK post town.

10007

# In regions of the world where localities are not well defined or do not fit

10008

# into this structure well, leave locality empty and use address_lines.

10009

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

10010

# addresses of a country or region.

10011

# For example, this can be a state, a province, an oblast, or a prefecture.

10012

# Specifically, for Spain this is the province and not the autonomous

10013

# community (e.g. "Barcelona" and not "Catalonia").

10014

# Many countries don't use an administrative area in postal addresses. E.g.

10015

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10016

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10017

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10018

#

10019

# Because values in address_lines do not have type information and may

10020

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10021

# "Austin, TX"), it is important that the line order is clear. The order of

10022

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10023

# 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]

10024

# used to make it explicit (e.g. "ja" for large-to-small ordering and

10025

# "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]

10026

# an address can be selected based on the language.

10027

#

10028

# The minimum permitted structural representation of an address consists

10029

# of a region_code with all remaining information placed in the

10030

# address_lines. It would be possible to format such an address very

10031

# approximately without geocoding, but no semantic reasoning could be

10032

# made about any of the address components until it was at least

10033

# partially resolved.

10034

#

10035

# Creating an address only containing a region_code and address_lines, and

10036

# then geocoding is the recommended way to handle completely unstructured

10037

# addresses (as opposed to guessing which parts of the address should be

10038

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10039

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10040

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

10041

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

10042

# is never inferred and it is up to the user to ensure the value is

10043

# correct. See http://cldr.unicode.org/ and

10044

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

10045

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10046

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10047

# postal codes to be present, but where they are used, they may trigger

10048

# additional validation with other parts of the address (e.g. state/zip

10049

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10050

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

10051

# in most regions. Where it is used, the value is either a string like

10052

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

10053

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

10054

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

10055

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

10056

# known). This is often the UI language of the input form or is expected

10057

# to match one of the languages used in the address' country/region, or their

10058

# transliterated equivalents.

10059

# This can affect formatting in certain countries, but is not critical

10060

# to the correctness of the data and will never affect any validation or

10061

# other non-formatting related operations.

10062

#

10063

# If this value is not known, it should be omitted (rather than specifying a

10064

# possibly incorrect default).

10065

#

10066

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

10067

"recipients": [ # Optional. The recipient at the address.

10068

# This field may, under certain circumstances, contain multiline information.

10069

# For example, it might contain "care of" information.

10070

"A String",

10071

],

10072

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10073

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10074

"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]

10075

# the latest revision.

10076

#

10077

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10078

},

10079

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

10080

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

10081

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

10082

# LocationType#LOCALITY.

10083

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

10084

# location bounding box in which a circle with the specified radius

10085

# centered from LatLng coves the area associated with the job location.

10086

# For example, currently, "Mountain View, CA, USA" has a radius of

10087

# 7885.79 meters.

10088

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

10089

# of doubles representing degrees latitude and degrees longitude. Unless

10090

# specified otherwise, this must conform to the

10091

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

10092

# standard</a>. Values must be within normalized ranges.

10093

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

10094

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10095

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10096

},

10097

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10098

},

10099

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10100

"numJobsFromBroadenedQuery": 42, # If query broadening is enabled, we may append additional results from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10101

# broadened query. This number indicates how many of the jobs returned in the

10102

# jobs field are from the broadened query. These results are always at the

10103

# end of the jobs list. In particular, a value of 0 means all the jobs in the

10104

# jobs list are from the original (without broadening) query. If this

10105

# field is non-zero, subsequent requests with offset after this result set

10106

# should contain all broadened results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10107

"appliedCommuteFilter": { # Input only. # The commute filter the service applied to the specified query. This

10108

# information is only available when query has a valid CommutePreference.

10109

#

10110

# Parameters needed for commute search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10111

"startLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # Required. The latitude and longitude of the location from which to calculate the

10112

# commute time.

10113

# of doubles representing degrees latitude and degrees longitude. Unless

10114

# specified otherwise, this must conform to the

10115

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

10116

# standard</a>. Values must be within normalized ranges.

10117

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

10118

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

10119

},

10120

"method": "A String", # Required. The method of transportation for which to calculate the commute time.

10121

"roadTraffic": "A String", # Optional. Specifies the traffic density to use when calculating commute time.

10122

# Must not be present if departure_hour_local is specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

10123

"departureHourLocal": 42, # Optional. The departure hour to use to calculate traffic impact. Accepts an

10124

# integer between 0 and 23, representing the hour in the time zone of the

10125

# start_location. Must not be present if road_traffic is specified.

10126

"allowNonStreetLevelAddress": True or False, # Optional. If `true`, jobs without street level addresses may also be returned.

10127

# For city level addresses, the city center is used. For state and coarser

10128

# level addresses, text matching is used.

10129

# If this field is set to `false` or is not specified, only jobs that include

10130

# street level addresses will be returned by commute search.

10131

"travelTime": "A String", # Required. The maximum travel time in seconds. The maximum allowed value is `3600s`

10132

# (one hour). Format is `123s`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10133

},

10134

"jobView": "A String", # Corresponds to SearchJobsRequest.job_view.

10135

"nextPageToken": "A String", # The token that specifies the starting position of the next page of results.

10136

# This field is empty if there are no more results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10137

"appliedJobLocationFilters": [ # The location filters that the service applied to the specified query. If

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10138

# any filters are lat-lng based, the JobLocation.location_type is

10139

# JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.

10140

{ # Output only.

10141

#

10142

# A resource that represents a location with full geographic

10143

# information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10144

"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]

10145

# such as postal delivery and payments addresses. Given a postal address,

10146

# a postal service can deliver items to a premises, P.O. Box, or other

10147

# delivery location.

10148

# Given a postal address, a postal service can deliver items to a premise, P.O.

10149

# Box or similar.

10150

# It is not intended to model geographical locations (roads, towns,

10151

# mountains).

10152

#

10153

# In typical usage an address would be created via user input or from importing

10154

# existing data, depending on the type of process.

10155

#

10156

# Advice on address input / editing:

10157

# - Use an i18n-ready address widget such as

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

10158

# https://github.com/google/libaddressinput)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10159

# - Users should not be presented with UI elements for input or editing of

10160

# fields outside countries where that field is used.

10161

#

10162

# For more guidance on how to use this schema, please see:

10163

# https://support.google.com/business/answer/6397478

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

10164

"locality": "A String", # Optional. Generally refers to the city/town portion of the address.

10165

# Examples: US city, IT comune, UK post town.

10166

# In regions of the world where localities are not well defined or do not fit

10167

# into this structure well, leave locality empty and use address_lines.

10168

"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal

10169

# addresses of a country or region.

10170

# For example, this can be a state, a province, an oblast, or a prefecture.

10171

# Specifically, for Spain this is the province and not the autonomous

10172

# community (e.g. "Barcelona" and not "Catalonia").

10173

# Many countries don't use an administrative area in postal addresses. E.g.

10174

# in Switzerland this should be left unpopulated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10175

"organization": "A String", # Optional. The name of the organization at the address.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10176

"addressLines": [ # Unstructured address lines describing the lower levels of an address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10177

#

10178

# Because values in address_lines do not have type information and may

10179

# sometimes contain multiple values in a single field (e.g.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10180

# "Austin, TX"), it is important that the line order is clear. The order of

10181

# address lines should be "envelope order" for the country/region of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10182

# 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]

10183

# used to make it explicit (e.g. "ja" for large-to-small ordering and

10184

# "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]

10185

# an address can be selected based on the language.

10186

#

10187

# The minimum permitted structural representation of an address consists

10188

# of a region_code with all remaining information placed in the

10189

# address_lines. It would be possible to format such an address very

10190

# approximately without geocoding, but no semantic reasoning could be

10191

# made about any of the address components until it was at least

10192

# partially resolved.

10193

#

10194

# Creating an address only containing a region_code and address_lines, and

10195

# then geocoding is the recommended way to handle completely unstructured

10196

# addresses (as opposed to guessing which parts of the address should be

10197

# localities or administrative areas).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10198

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10199

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

10200

"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This

10201

# is never inferred and it is up to the user to ensure the value is

10202

# correct. See http://cldr.unicode.org/ and

10203

# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html

10204

# for details. Example: "CH" for Switzerland.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10205

"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10206

# postal codes to be present, but where they are used, they may trigger

10207

# additional validation with other parts of the address (e.g. state/zip

10208

# validation in the U.S.A.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10209

"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used

10210

# in most regions. Where it is used, the value is either a string like

10211

# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number

10212

# alone, representing the "sector code" (Jamaica), "delivery area indicator"

10213

# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

10214

"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if

10215

# known). This is often the UI language of the input form or is expected

10216

# to match one of the languages used in the address' country/region, or their

10217

# transliterated equivalents.

10218

# This can affect formatting in certain countries, but is not critical

10219

# to the correctness of the data and will never affect any validation or

10220

# other non-formatting related operations.

10221

#

10222

# If this value is not known, it should be omitted (rather than specifying a

10223

# possibly incorrect default).

10224

#

10225

# Examples: "zh-Hant", "ja", "ja-Latn", "en".

10226

"recipients": [ # Optional. The recipient at the address.

10227

# This field may, under certain circumstances, contain multiline information.

10228

# For example, it might contain "care of" information.

10229

"A String",

10230

],

10231

"sublocality": "A String", # Optional. Sublocality of the address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10232

# For example, this can be neighborhoods, boroughs, districts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10233

"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]

10234

# the latest revision.

10235

#

10236

# All new revisions **must** be backward compatible with old revisions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10237

},

10238

"locationType": "A String", # The type of a location, which corresponds to the address lines field of

10239

# PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of

10240

# LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of

10241

# LocationType#LOCALITY.

10242

"radiusMeters": 3.14, # Radius in meters of the job location. This value is derived from the

10243

# location bounding box in which a circle with the specified radius

10244

# centered from LatLng coves the area associated with the job location.

10245

# For example, currently, "Mountain View, CA, USA" has a radius of

10246

# 7885.79 meters.

10247

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair.

10248

# of doubles representing degrees latitude and degrees longitude. Unless

10249

# specified otherwise, this must conform to the

10250

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

10251

# standard</a>. Values must be within normalized ranges.

10252

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

10253

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10254

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

10255

},

10256

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

10257

"estimatedTotalSize": "A String", # An estimation of the number of jobs that match the specified query.

10258

#

10259

# This number is not guaranteed to be accurate. For accurate results,

10260

# seenenable_precise_result_size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10261

"totalSize": "A String", # The precise result count, which is available only if the client set

10262

# enable_precise_result_size to `true` or if the response

10263

# is the last page of results. Otherwise, the value will be `-1`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="searchForAlert_next">searchForAlert_next(previous_request, previous_response)</code>

10269

<pre>Retrieves the next page of results.

10270

10271

Args:

10272

previous_request: The request for the previous page. (required)

10273

previous_response: The response from the request for the previous page. (required)

10274

10275

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10276

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]

10277

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="search_next">search_next(previous_request, previous_response)</code>

10283

<pre>Retrieves the next page of results.

10284

10285

Args:

10286

previous_request: The request for the previous page. (required)

10287

previous_response: The response from the request for the previous page. (required)

10288

10289

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

10290

A request object that you can call 'execute()' on to request the next

Bu Sun Kim