Package google.cloud.talent.v3

Index

CompanyService

A service handles company management, including CRUD and job enumeration.

CreateCompany

rpc CreateCompany(CreateCompanyRequest) returns (Company)

Creates a new company entity.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteCompany

rpc DeleteCompany(DeleteCompanyRequest) returns (Empty)

Deletes specified company. Prerequisite: The company has no jobs associated with it.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetCompany

rpc GetCompany(GetCompanyRequest) returns (Company)

Retrieves specified company.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListCompanies

rpc ListCompanies(ListCompaniesRequest) returns (ListCompaniesResponse)

Lists all companies associated with the service account.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateCompany

rpc UpdateCompany(UpdateCompanyRequest) returns (Company)

Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Completion

A service handles auto completion.

CompleteQuery

rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse)

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

EventService

A service handles client event report.

CreateClientEvent

rpc CreateClientEvent(CreateClientEventRequest) returns (ClientEvent)

Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in self service tools. Learn more about self service tools.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

JobService

A service handles job management, including job CRUD, enumeration and search.

BatchDeleteJobs

rpc BatchDeleteJobs(BatchDeleteJobsRequest) returns (Empty)

Deletes a list of Jobs by filter.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateJob

rpc CreateJob(CreateJobRequest) returns (Job)

Creates a new job.

Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteJob

rpc DeleteJob(DeleteJobRequest) returns (Empty)

Deletes the specified job.

Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetJob

rpc GetJob(GetJobRequest) returns (Job)

Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListJobs

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)

Lists jobs by filter.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SearchJobs

rpc SearchJobs(SearchJobsRequest) returns (SearchJobsResponse)

Searches for jobs using the provided SearchJobsRequest.

This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SearchJobsForAlert

rpc SearchJobsForAlert(SearchJobsRequest) returns (SearchJobsResponse)

Searches for jobs using the provided SearchJobsRequest.

This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers.

This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateJob

rpc UpdateJob(UpdateJobRequest) returns (Job)

Updates specified job.

Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

BatchDeleteJobsRequest

Input only.

Batch delete jobs request.

Fields
parent

string

Required. The resource name of the project under which the job is created.

The format is "projects/{project_id}", for example, "projects/api-test-project".

filter

string

Required. The filter string specifies the jobs to be deleted.

Supported operator: =, AND

The fields eligible for filtering are:

  • companyName (Required)
  • requisitionId (Required)

Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1"

ClientEvent

An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.

Fields
request_id

string

Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.

event_id

string

Required. A unique identifier, generated by the client application. This event_id is used to establish the relationship between different events (see parent_event_id).

parent_event_id

string

Optional. The event_id of an event that resulted in the current event. For example, a [Job view][JobEventType.VIEW] event usually follows a parent [impression][JobEventType.IMPRESSION] event: A job seeker first does a search where a list of jobs appears ([impression][JobEventType.IMPRESSION]). The job seeker then selects a result and views the description of a particular job ([Job view][JobEventType.VIEW]).

create_time

Timestamp

Required. The timestamp of the event.

extra_info

map<string, string>

Optional. Extra information about this event. Used for storing information with no matching field in [event][google.cloud.talent.v3.ClientEvent.event] payload, for example, user application specific context or details.

At most 20 keys are supported. The maximum total size of all keys and values is 2 KB.

job_event

JobEvent

A event issued when a job seeker interacts with the application that implements Cloud Talent Solution.

CommuteFilter

Input only.

Parameters needed for commute search.

Fields
commute_method

CommuteMethod

Required. The method of transportation for which to calculate the commute time.

start_coordinates

LatLng

Required. The latitude and longitude of the location from which to calculate the commute time.

travel_duration

Duration

Required. The maximum travel time in seconds. The maximum allowed value is 3600s (one hour). Format is 123s.

allow_imprecise_addresses

bool

Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search.

Note: If allow_imprecise_addresses is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a travel_duration time of 0 regardless of distance from the job seeker.

Union field traffic_option. Optional.

Traffic factor to take into account while searching by commute. traffic_option can be only one of the following:

road_traffic

RoadTraffic

Optional. Specifies the traffic density to use when calculating commute time.

departure_time

TimeOfDay

Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone.

Currently traffic model is restricted to hour level resolution.

CommuteMethod

Method for commute.

Enums
COMMUTE_METHOD_UNSPECIFIED Commute method is not specified.
DRIVING Commute time is calculated based on driving time.
TRANSIT Commute time is calculated based on public transit including bus, metro, subway, etc.

RoadTraffic

The traffic density to use when calculating commute time.

Enums
ROAD_TRAFFIC_UNSPECIFIED Road traffic situation is not specified.
TRAFFIC_FREE Optimal commute time without considering any traffic impact.
BUSY_HOUR Commute time calculation takes in account the peak traffic impact.

Company

A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

Fields
name

string

Required during company update.

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

The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

display_name

string

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

external_id

string

Required. Client side company identifier, used to uniquely identify the company.

The maximum number of allowed characters is 255.

size

CompanySize

Optional. The employer's company size.

headquarters_address

string

Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

hiring_agency

bool

Optional. Set to true if it is the hiring agency that post jobs for other employers.

Defaults to false if not provided.

eeo_text

string

Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles.

The maximum number of allowed characters is 500.

website_uri

string

Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com".

The maximum number of allowed characters is 255.

career_site_uri

string

Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

image_uri

string

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

keyword_searchable_job_custom_attributes[]

string

Optional. A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword search. Jobs with string_values under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.

derived_info

DerivedInfo

Output only. Derived details about the company.

suspended

bool

Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

DerivedInfo

Derived details about the company.

Fields
headquarters_location

Location

A structured headquarters location of the company, resolved from [Company.hq_location][] if provided.

CompanySize

An enum that represents the size of the company.

Enums
COMPANY_SIZE_UNSPECIFIED Default value if the size is not specified.
MINI The company has less than 50 employees.
SMALL The company has between 50 and 99 employees.
SMEDIUM The company has between 100 and 499 employees.
MEDIUM The company has between 500 and 999 employees.
BIG The company has between 1,000 and 4,999 employees.
BIGGER The company has between 5,000 and 9,999 employees.
GIANT The company has 10,000 or more employees.

CompensationFilter

Input only.

Filter on job compensation type and amount.

Fields
type

FilterType

Required. Type of filter.

units[]

CompensationUnit

Required. Specify desired base compensation entry's CompensationInfo.CompensationUnit.

range

CompensationRange

Optional. Compensation range.

include_jobs_with_unspecified_compensation_range

bool

Optional. If set to true, jobs with unspecified compensation range fields are included.

FilterType

Specify the type of filtering.

Enums
FILTER_TYPE_UNSPECIFIED Filter type unspecified. Position holder, INVALID, should never be used.
UNIT_ONLY

Filter by base compensation entry's unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided units. Populate one or more units.

See CompensationInfo.CompensationEntry for definition of base compensation entry.

UNIT_AND_AMOUNT

Filter by base compensation entry's unit and amount / range. A job is a match if and only if the job contains a base CompensationEntry, and the base entry's unit matches provided [compensation_units][] and amount or range overlaps with provided [compensation_range][].

See CompensationInfo.CompensationEntry for definition of base compensation entry.

Set exactly one units and populate range.

ANNUALIZED_BASE_AMOUNT

Filter by annualized base compensation amount and base compensation entry's unit. Populate range and zero or more units.

ANNUALIZED_TOTAL_AMOUNT

Filter by annualized total compensation amount and base compensation entry's unit . Populate range and zero or more units.

CompensationHistogramRequest

Input only.

Compensation based histogram request.

Fields
type

CompensationHistogramRequestType

Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each CompensationHistogramRequestType.

bucketing_option

NumericBucketingOption

Required. Numeric histogram options, like buckets, whether include min or max value.

CompensationHistogramRequestType

Compensation histogram request type. A single histogram request can only specify a each of the 'compensationHistogramRequestType's once.

Enums
COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED Default value. Invalid.
BASE Histogram by job's base compensation. See [CompensationEntry][] for definition of base compensation.
ANNUALIZED_BASE Histogram by job's annualized base compensation. See [CompensationEntry][] for definition of annualized base compensation.
ANNUALIZED_TOTAL Histogram by job's annualized total compensation. See [CompensationEntry][] for definition of annualized total compensation.

CompensationHistogramResult

Output only.

Compensation based histogram result.

Fields
type

CompensationHistogramRequestType

Type of the request, corresponding to CompensationHistogramRequest.type.

result

NumericBucketingResult

Histogram result.

CompensationInfo

Job compensation details.

Fields
entries[]

CompensationEntry

Optional. Job compensation information.

At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.

annualized_base_compensation_range

CompensationRange

Output only. Annualized base compensation range. Computed as base compensation entry's [CompensationEntry.compensation][] times CompensationEntry.expected_units_per_year.

See CompensationEntry for explanation on compensation annualization.

annualized_total_compensation_range

CompensationRange

Output only. Annualized total compensation range. Computed as all compensation entries' [CompensationEntry.compensation][] times CompensationEntry.expected_units_per_year.

See CompensationEntry for explanation on compensation annualization.

CompensationEntry

A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type.

Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.

Fields
type

CompensationType

Optional. Compensation type.

Default is [CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED][].

unit

CompensationUnit

Optional. Frequency of the specified amount.

Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

description

string

Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.

expected_units_per_year

DoubleValue

Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1

Union field compensation_amount. Optional.

Compensation amount. It could be a fixed amount or a floating range. compensation_amount can be only one of the following:

amount

Money

Optional. Compensation amount.

range

CompensationRange

Optional. Compensation range.

CompensationRange

Compensation range.

Fields
max_compensation

Money

Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation.

min_compensation

Money

Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation.

CompensationType

The type of compensation.

For compensation amounts specified in non-monetary amounts, describe the compensation scheme in the CompensationEntry.description.

For example, tipping format is described in CompensationEntry.description (for example, "expect 15-20% tips based on customer bill.") and an estimate of the tips provided in CompensationEntry.amount or CompensationEntry.range ($10 per hour).

For example, equity is described in CompensationEntry.description (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and value estimated in CompensationEntry.amount or CompensationEntry.range. If no value estimate is possible, units are CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED and then further clarified in CompensationEntry.description field.

Enums
COMPENSATION_TYPE_UNSPECIFIED Default value.
BASE Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.
BONUS Bonus.
SIGNING_BONUS Signing bonus.
EQUITY Equity.
PROFIT_SHARING Profit sharing.
COMMISSIONS Commission.
TIPS Tips.
OTHER_COMPENSATION_TYPE Other compensation type.

CompensationUnit

Pay frequency.

Enums
COMPENSATION_UNIT_UNSPECIFIED Default value.
HOURLY Hourly.
DAILY Daily.
WEEKLY Weekly
MONTHLY Monthly.
YEARLY Yearly.
ONE_TIME One time.
OTHER_COMPENSATION_UNIT Other compensation units.

CompleteQueryRequest

Input only.

Auto-complete parameters.

Fields
name

string

Required. Resource name of project the completion is performed within.

The format is "projects/{project_id}", for example, "projects/api-test-project".

query

string

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

language_codes[]

string

Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned.

For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned.

For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned.

The maximum number of allowed characters is 255.

page_size

int32

Required. Completion result count.

The maximum allowed page size is 10.

company_name

string

Optional. If provided, restricts completion to specified company.

The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

scope

CompletionScope

Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.

type

CompletionType

Optional. The completion topic. The default is CompletionType.COMBINED.

language_code
(deprecated)

string

Deprecated. Use language_codes instead.

Optional.

The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned.

For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned.

For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned.

The maximum number of allowed characters is 255.

CompletionScope

Enum to specify the scope of completion.

Enums
COMPLETION_SCOPE_UNSPECIFIED Default value.
TENANT Suggestions are based only on the data provided by the client.
PUBLIC Suggestions are based on all jobs data in the system that's visible to the client

CompletionType

Enum to specify auto-completion topics.

Enums
COMPLETION_TYPE_UNSPECIFIED Default value.
JOB_TITLE Only suggest job titles.
COMPANY_NAME Only suggest company names.
COMBINED Suggest both job titles and company names.

CompleteQueryResponse

Output only.

Response of auto-complete query.

Fields
completion_results[]

CompletionResult

Results of the matching job/company candidates.

metadata

ResponseMetadata

Additional information for the API invocation, such as the request tracking id.

CompletionResult

Output only.

Resource that represents completion results.

Fields
suggestion

string

The suggestion for the query.

type

CompletionType

The completion topic.

image_uri

string

The URI of the company image for [CompletionType.COMPANY_NAME][].

CreateClientEventRequest

The report event request.

Fields
parent

string

Parent project name.

client_event

ClientEvent

Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.

CreateCompanyRequest

Input only.

The Request of the CreateCompany method.

Fields
parent

string

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

The format is "projects/{project_id}", for example, "projects/api-test-project".

company

Company

Required. The company to be created.

CreateJobRequest

Input only.

Create job request.

Fields
parent

string

Required. The resource name of the project under which the job is created.

The format is "projects/{project_id}", for example, "projects/api-test-project".

job

Job

Required. The Job to be created.

CustomAttribute

Custom attribute values that are either filterable or non-filterable.

Fields
string_values[]

string

Optional but exactly one of string_values or long_values must be specified.

This field is used to perform a string match (CASE_SENSITIVE_MATCH or CASE_INSENSITIVE_MATCH) search. For filterable string_values, a maximum total number of 200 values is allowed, with each string_value has a byte size of no more than 500B. For unfilterable string_values, the maximum total byte size of unfilterable string_values is 50KB.

Empty string is not allowed.

long_values[]

int64

Optional but exactly one of string_values or long_values must be specified.

This field is used to perform number range search. (EQ, GT, GE, LE, LT) over filterable long_value.

Currently at most 1 long_values is supported.

filterable

bool

Optional. If the filterable flag is true, custom field values are searchable. If false, values are not searchable.

Default is false.

CustomAttributeHistogramRequest

Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.

Fields
key

string

Required. Specifies the custom field key to perform a histogram on. If specified without long_value_histogram_bucketing_option, histogram on string values of the given key is triggered, otherwise histogram is performed on long values.

string_value_histogram

bool

Optional. If set to true, the response includes the histogram value for each key as a string.

long_value_histogram_bucketing_option

NumericBucketingOption

Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements.

CustomAttributeHistogramResult

Output only.

Custom attribute histogram result.

Fields
key

string

Stores the key of custom attribute the histogram is performed on.

string_value_histogram_result

map<string, int32>

Stores a map from the values of string custom field associated with key to the number of jobs with that value in this histogram result.

long_value_histogram_result

NumericBucketingResult

Stores bucketed histogram counting result or min/max values for custom attribute long values associated with key.

DegreeType

Educational degree level defined in International Standard Classification of Education (ISCED).

Enums
DEGREE_TYPE_UNSPECIFIED Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten
PRIMARY_EDUCATION Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school
LOWER_SECONDARY_EDUCATION Lower secondary education; First stage of secondary education building on primary education, typically with a more subject-oriented curriculum. ISCED code 2. Ex) Middle school
UPPER_SECONDARY_EDUCATION Middle education; Second/final stage of secondary education preparing for tertiary education and/or providing skills relevant to employment. Usually with an increased range of subject options and streams. ISCED code 3. Ex) High school
ADULT_REMEDIAL_EDUCATION Adult Remedial Education; Programmes providing learning experiences that build on secondary education and prepare for labour market entry and/or tertiary education. The content is broader than secondary but not as complex as tertiary education. ISCED code 4.
ASSOCIATES_OR_EQUIVALENT Associate's or equivalent; Short first tertiary programmes that are typically practically-based, occupationally-specific and prepare for labour market entry. These programmes may also provide a pathway to other tertiary programmes. ISCED code 5.
BACHELORS_OR_EQUIVALENT Bachelor's or equivalent; Programmes designed to provide intermediate academic and/or professional knowledge, skills and competencies leading to a first tertiary degree or equivalent qualification. ISCED code 6.
MASTERS_OR_EQUIVALENT Master's or equivalent; Programmes designed to provide advanced academic and/or professional knowledge, skills and competencies leading to a second tertiary degree or equivalent qualification. ISCED code 7.
DOCTORAL_OR_EQUIVALENT Doctoral or equivalent; Programmes designed primarily to lead to an advanced research qualification, usually concluding with the submission and defense of a substantive dissertation of publishable quality based on original research. ISCED code 8.

DeleteCompanyRequest

Input only.

Request to delete a company.

Fields
name

string

Required. The resource name of the company to be deleted.

The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

DeleteJobRequest

Input only.

Delete job request.

Fields
name

string

Required. The resource name of the job to be deleted.

The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234".

DeviceInfo

Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.

Fields
device_type

DeviceType

Optional. Type of the device.

id

string

Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.

DeviceType

An enumeration describing an API access portal and exposure mechanism.

Enums
DEVICE_TYPE_UNSPECIFIED The device type isn't specified.
WEB A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)
MOBILE_WEB A mobile device web browser, such as a phone or tablet with a Chrome browser.
ANDROID An Android device native application.
IOS An iOS device native application.
BOT A bot, as opposed to a device operated by human beings, such as a web crawler.
OTHER Other devices types.

EmploymentType

An enum that represents the employment type of a job.

Enums
EMPLOYMENT_TYPE_UNSPECIFIED The default value if the employment type is not specified.
FULL_TIME The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.
PART_TIME The job entails working fewer hours than a full time job, typically less than 40 hours a week.
CONTRACTOR The job is offered as a contracted, as opposed to a salaried employee, position.
CONTRACT_TO_HIRE The job is offered as a contracted position with the understanding that it's converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.
TEMPORARY The job is offered as a temporary employment opportunity, usually a short-term engagement.
INTERN The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.
VOLUNTEER The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.
PER_DIEM The job requires an employee to work on an as-needed basis with a flexible schedule.
FLY_IN_FLY_OUT The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.
OTHER_EMPLOYMENT_TYPE The job does not fit any of the other listed types.

GetCompanyRequest

Input only.

Request for getting a company by name.

Fields
name

string

Required. The resource name of the company to be retrieved.

The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

GetJobRequest

Input only.

Get job request.

Fields
name

string

Required. The resource name of the job to retrieve.

The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234".

HistogramFacets

Input only.

Histogram facets to be specified in SearchJobsRequest.

Fields
simple_histogram_facets[]

SearchType

Optional. Specifies the simple type of histogram facets, for example, COMPANY_SIZE, EMPLOYMENT_TYPE etc.

custom_attribute_histogram_facets[]

CustomAttributeHistogramRequest

Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.

compensation_histogram_facets[]

CompensationHistogramRequest

Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.

HistogramResult

Output only.

Result of a histogram call. The response contains the histogram map for the search type specified by [HistogramResult.field][]. The response is a map of each filter value to the corresponding count of jobs for that filter.

Fields
search_type

SearchType

The Histogram search filters.

values

map<string, int32>

A map from the values of [field][] to the number of jobs with that value in this search result.

Key: search type (filter names, such as the companyName).

Values: the count of jobs that match the filter for this search.

HistogramResults

Output only.

Histogram results that match HistogramFacets specified in SearchJobsRequest.

Fields
simple_histogram_results[]

HistogramResult

Specifies histogram results that matches HistogramFacets.simple_histogram_facets.

custom_attribute_histogram_results[]

CustomAttributeHistogramResult

Specifies histogram results for custom attributes that match HistogramFacets.custom_attribute_histogram_facets.

compensation_histogram_results[]

CompensationHistogramResult

Specifies compensation field-based histogram results that match [HistogramFacets.compensation_histogram_requests][].

HtmlSanitization

Input only.

Option for HTML content sanitization on user input fields, for example, job description. By setting this option, user can determine whether and how sanitization is performed on these fields.

Enums
HTML_SANITIZATION_UNSPECIFIED Default value.
HTML_SANITIZATION_DISABLED Disables sanitization on HTML input.
SIMPLE_FORMATTING_ONLY Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags.

Job

A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

Fields
name

string

Required during job update.

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

The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234".

Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.

company_name

string

Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo".

requisition_id

string

Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id.

The maximum number of allowed characters is 255.

title

string

Required. The title of the job, such as "Software Engineer"

The maximum number of allowed characters is 500.

description

string

Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended.

This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

The maximum number of allowed characters is 100,000.

addresses[]

string

Optional but strongly recommended for the best service experience.

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

Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time.

At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience.

The maximum number of allowed characters is 500.

application_info

ApplicationInfo

Required. At least one field within ApplicationInfo must be specified.

Job application information.

job_benefits[]

JobBenefit

Optional. The benefits included with the job.

compensation_info

CompensationInfo

Optional. Job compensation information.

custom_attributes

map<string, CustomAttribute>

Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields.

The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.

At most 100 filterable and at most 100 unfilterable keys are supported. For filterable string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable string_values, the maximum total size of string_values across all keys is 50KB.

degree_types[]

DegreeType

Optional. The desired education degrees for the job, such as Bachelors, Masters.

department

string

Optional. The department or functional area within the company with the open position.

The maximum number of allowed characters is 255.

employment_types[]

EmploymentType

Optional. The employment type(s) of a job, for example, full time or part time.

incentives

string

Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay.

The maximum number of allowed characters is 10,000.

language_code

string

Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job.

Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages{: class="external" target="_blank" }.

If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.

job_level

JobLevel

Optional. The experience level associated with the job, such as "Entry Level".

promotion_value

int32

Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

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

qualifications

string

Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field.

This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

The maximum number of allowed characters is 10,000.

responsibilities

string

Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field.

This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

The maximum number of allowed characters is 10,000.

posting_region

PostingRegion

Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.

visibility
(deprecated)

Visibility

Deprecated. The job is only visible to the owner.

The visibility of the job.

Defaults to Visibility.ACCOUNT_ONLY if not specified.

job_start_time

Timestamp

Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

job_end_time

Timestamp

Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

posting_publish_time

Timestamp

Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.

posting_expire_time

Timestamp

Optional but strongly recommended for the best service experience.

The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the [DeleteJob][] and [ListJobs][] APIs, but it can be retrieved with the [GetJob][] API or updated with the [UpdateJob][] API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company_name, language_code and requisition_id.

The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out.

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

Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately.

If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include [expiry_time][], or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.

posting_create_time

Timestamp

Output only. The timestamp when this job posting was created.

posting_update_time

Timestamp

Output only. The timestamp when this job posting was last updated.

company_display_name

string

Output only. Display name of the company listing the job.

derived_info

DerivedInfo

Output only. Derived details about the job posting.

processing_options

ProcessingOptions

Optional. Options for job processing.

ApplicationInfo

Application related details of a job posting.

Fields
emails[]

string

Optional but at least one of uris, emails or instruction must be specified.

Use this field to specify email address(es) to which resumes or applications can be sent.

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

instruction

string

Optional but at least one of uris, emails or instruction must be specified.

Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job.

This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

The maximum number of allowed characters is 3,000.

uris[]

string

Optional but at least one of uris, emails or instruction must be specified.

Use this URI field to direct an applicant to a website, for example to link to an online application form.

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

DerivedInfo

Output only.

Derived details about the job posting.

Fields
locations[]

Location

Structured locations of the job, resolved from Job.addresses.

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

job_categories[]

JobCategory

Job categories derived from Job.title and Job.description.

ProcessingOptions

Input only.

Options for job processing.

Fields
disable_street_address_resolution

bool

Optional. If set to true, the service does not attempt to resolve a more precise address for the job.

html_sanitization

HtmlSanitization

Optional. Option for job HTML content sanitization. Applied fields are:

  • description
  • applicationInfo.instruction
  • incentives
  • qualifications
  • responsibilities

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

Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

JobBenefit

An enum that represents employee benefits included with the job.

Enums
JOB_BENEFIT_UNSPECIFIED Default value if the type is not specified.
CHILD_CARE The job includes access to programs that support child care, such as daycare.
DENTAL The job includes dental services covered by a dental insurance plan.
DOMESTIC_PARTNER The job offers specific benefits to domestic partners.
FLEXIBLE_HOURS The job allows for a flexible work schedule.
MEDICAL The job includes health services covered by a medical insurance plan.
LIFE_INSURANCE The job includes a life insurance plan provided by the employer or available for purchase by the employee.
PARENTAL_LEAVE The job allows for a leave of absence to a parent to care for a newborn child.
RETIREMENT_PLAN The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.
SICK_DAYS The job allows for paid time off due to illness.
VACATION The job includes paid time off for vacation.
VISION The job includes vision services covered by a vision insurance plan.

JobCategory

An enum that represents the categorization or primary focus of specific role. This value is different than the "industry" associated with a role, which is related to the categorization of the company listing the job.

Enums
JOB_CATEGORY_UNSPECIFIED The default value if the category isn't specified.
ACCOUNTING_AND_FINANCE An accounting and finance job, such as an Accountant.
ADMINISTRATIVE_AND_OFFICE An administrative and office job, such as an Administrative Assistant.
ADVERTISING_AND_MARKETING An advertising and marketing job, such as Marketing Manager.
ANIMAL_CARE An animal care job, such as Veterinarian.
ART_FASHION_AND_DESIGN An art, fashion, or design job, such as Designer.
BUSINESS_OPERATIONS A business operations job, such as Business Operations Manager.
CLEANING_AND_FACILITIES A cleaning and facilities job, such as Custodial Staff.
COMPUTER_AND_IT A computer and IT job, such as Systems Administrator.
CONSTRUCTION A construction job, such as General Laborer.
CUSTOMER_SERVICE A customer service job, such s Cashier.
EDUCATION An education job, such as School Teacher.
ENTERTAINMENT_AND_TRAVEL An entertainment and travel job, such as Flight Attendant.
FARMING_AND_OUTDOORS A farming or outdoor job, such as Park Ranger.
HEALTHCARE A healthcare job, such as Registered Nurse.
HUMAN_RESOURCES A human resources job, such as Human Resources Director.
INSTALLATION_MAINTENANCE_AND_REPAIR An installation, maintenance, or repair job, such as Electrician.
LEGAL A legal job, such as Law Clerk.
MANAGEMENT A management job, often used in conjunction with another category, such as Store Manager.
MANUFACTURING_AND_WAREHOUSE A manufacturing or warehouse job, such as Assembly Technician.
MEDIA_COMMUNICATIONS_AND_WRITING A media, communications, or writing job, such as Media Relations.
OIL_GAS_AND_MINING An oil, gas or mining job, such as Offshore Driller.
PERSONAL_CARE_AND_SERVICES A personal care and services job, such as Hair Stylist.
PROTECTIVE_SERVICES A protective services job, such as Security Guard.
REAL_ESTATE A real estate job, such as Buyer's Agent.
RESTAURANT_AND_HOSPITALITY A restaurant and hospitality job, such as Restaurant Server.
SALES_AND_RETAIL A sales and/or retail job, such Sales Associate.
SCIENCE_AND_ENGINEERING A science and engineering job, such as Lab Technician.
SOCIAL_SERVICES_AND_NON_PROFIT A social services or non-profit job, such as Case Worker.
SPORTS_FITNESS_AND_RECREATION A sports, fitness, or recreation job, such as Personal Trainer.
TRANSPORTATION_AND_LOGISTICS A transportation or logistics job, such as Truck Driver.

JobEvent

An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.

Fields
type

JobEventType

Required. The type of the event (see JobEventType).

jobs[]

string

Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job.

JobEventType

An enumeration of an event attributed to the behavior of the end user, such as a job seeker.

Enums
JOB_EVENT_TYPE_UNSPECIFIED The event is unspecified by other provided values.
IMPRESSION The job seeker or other entity interacting with the service has had a job rendered in their view, such as in a list of search results in a compressed or clipped format. This event is typically associated with the viewing of a jobs list on a single page by a job seeker.
VIEW The job seeker, or other entity interacting with the service, has viewed the details of a job, including the full description. This event doesn't apply to the viewing a snippet of a job appearing as a part of the job search results. Viewing a snippet is associated with an impression).
VIEW_REDIRECT The job seeker or other entity interacting with the service performed an action to view a job and was redirected to a different website for job.
APPLICATION_START The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.
APPLICATION_FINISH The job seeker or other entity interacting with the service submitted an application for a job.
APPLICATION_QUICK_SUBMISSION The job seeker or other entity interacting with the service submitted an application for a job with a single click without entering information. If a job seeker performs this action, send only this event to the service. Do not also send JobEventType.APPLICATION_START or JobEventType.APPLICATION_FINISH events.
APPLICATION_REDIRECT The job seeker or other entity interacting with the service performed an action to apply to a job and was redirected to a different website to complete the application.
APPLICATION_COMPANY_SUBMIT This event should be used when a company submits an application on behalf of a job seeker. This event is intended for use by staffing agencies attempting to place candidates.
BOOKMARK The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.
NOTIFICATION The job seeker or other entity interacting with the service was sent a notification, such as an email alert or device notification, containing one or more jobs listings generated by the service.
HIRED The job seeker or other entity interacting with the service was employed by the hiring entity (employer). Send this event only if the job seeker was hired through an application that was initiated by a search conducted through the Cloud Talent Solution service.
SENT_CV A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.
INTERVIEW_GRANTED The entity interacting with the service (for example, the job seeker), was granted an initial interview by the hiring entity (employer). This event should only be sent if the job seeker was granted an interview as part of an application that was initiated by a search conducted through / recommendation provided by the Cloud Talent Solution service.
NOT_INTERESTED The job seeker or other entity interacting with the service showed no interest in the job.

JobLevel

An enum that represents the required experience level required for the job.

Enums
JOB_LEVEL_UNSPECIFIED The default value if the level is not specified.
ENTRY_LEVEL Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.
EXPERIENCED Experienced individual contributors, typically with 2+ years of experience in a similar role.
MANAGER Entry- to mid-level managers responsible for managing a team of people.
DIRECTOR Senior-level managers responsible for managing teams of managers.
EXECUTIVE Executive-level managers and above, including C-level positions.

JobQuery

Input only.

The query required to perform a search query.

Fields
query

string

Optional. The query string that matches against the job title, description, and location fields.

The maximum number of allowed characters is 255.

query_language_code

string

The language code of query. For example, "en-US". This field helps to better interpret the query.

If a value isn't specified, the query language code is automatically detected, which may not be accurate.

Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

company_names[]

string

Optional. This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

At most 20 company filters are allowed.

location_filters[]

LocationFilter

Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

job_categories[]

JobCategory

Optional. The category filter specifies the categories of jobs to search against. See [Category][] for more information.

If a value is not specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

commute_filter

CommuteFilter

Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with [COMMUTE MODE][Mode#COMMUTE]. When specified, [JobQuery.location_filters] is ignored.

Currently we don't support sorting by commute time.

company_display_names[]

string

Optional. This filter specifies the exact [company display name][Company.display_name] of the jobs to search against.

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

compensation_filter

CompensationFilter

Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

custom_attribute_filter

string

Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as filterable.

The syntax for this expression is a subset of SQL syntax.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\) and quote (") characters.

Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) to filter on the existence of a key.

Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length.

Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10

disable_spell_check

bool

Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer".

Defaults to false: a spell check is performed.

employment_types[]

EmploymentType

Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value is not specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

language_codes[]

string

Optional. This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

publish_time_range

TimestampRange

Optional. Jobs published within a range specified by this filter are searched against.

JobView

An enum that specifies the job attributes that are returned in the [MatchingJob.job][] in SearchJobsResponse or Job objects in ListJobsResponse.

Enums
JOB_VIEW_UNSPECIFIED Default value.
JOB_VIEW_ID_ONLY A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.
JOB_VIEW_MINIMAL A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.language_code.
JOB_VIEW_SMALL A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.
JOB_VIEW_FULL All available attributes are included in the search results.

ListCompaniesRequest

Input only.

List companies for which the client has ACL visibility.

Fields
parent

string

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

The format is "projects/{project_id}", for example, "projects/api-test-project".

page_token

string

Optional. The starting indicator from which to return results.

page_size

int32

Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

require_open_jobs

bool

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

Defaults to false.

If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

ListCompaniesResponse

Output only.

The List companies response object.

Fields
companies[]

Company

Companies for the current client.

next_page_token

string

A token to retrieve the next page of results.

metadata

ResponseMetadata

Additional information for the API invocation, such as the request tracking id.

ListJobsRequest

Input only.

List jobs request.

Fields
parent

string

Required. The resource name of the project under which the job is created.

The format is "projects/{project_id}", for example, "projects/api-test-project".

filter

string

Required. The filter string specifies the jobs to be enumerated.

Supported operator: =, AND

The fields eligible for filtering are:

  • companyName (Required)
  • requisitionId (Optional)

Sample Query:

  • companyName = "projects/api-test-project/companies/123"
  • companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1"

page_token

string

Optional. The starting point of a query result.

page_size

int32

Optional. The maximum number of jobs to be returned per page of results.

If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100.

Default is 100 if empty or a number < 1 is specified.

job_view

JobView

Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.

ListJobsResponse

Output only.

List jobs response.

Fields
jobs[]

Job

The Jobs for a given company.

The maximum number of items returned is based on the limit field provided in the request.

next_page_token

string

A token to retrieve the next page of results.

metadata

ResponseMetadata

Additional information for the API invocation, such as the request tracking id.

Location

Output only.

A resource that represents a location with full geographic information.

Fields
location_type

LocationType

The type of a location, which corresponds to the address lines field of [PostalAddress][]. For example, "Downtown, Atlanta, GA, USA" has a type of [LocationType#NEIGHBORHOOD][], and "Kansas City, KS, USA" has a type of [LocationType#LOCALITY][].

postal_address

PostalAddress

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

lat_lng

LatLng

An object representing a latitude/longitude pair.

radius_in_miles

double

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from [LatLng][] covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

LocationType

An enum which represents the type of a location.

Enums
LOCATION_TYPE_UNSPECIFIED Default value if the type is not specified.
COUNTRY A country level location.
ADMINISTRATIVE_AREA A state or equivalent level location.
SUB_ADMINISTRATIVE_AREA A county or equivalent level location.
LOCALITY A city or equivalent level location.
POSTAL_CODE A postal code level location.
SUB_LOCALITY A sublocality is a subdivision of a locality, for example a city borough, ward, or arrondissement. Sublocalities are usually recognized by a local political authority. For example, Manhattan and Brooklyn are recognized as boroughs by the City of New York, and are therefore modeled as sublocalities.
SUB_LOCALITY_1 A district or equivalent level location.
SUB_LOCALITY_2 A smaller district or equivalent level display.
NEIGHBORHOOD A neighborhood level location.
STREET_ADDRESS A street address level location.

LocationFilter

Input only.

Geographic region of the search.

Fields
address

string

Optional. The address name, such as "Mountain View" or "Bay Area".

region_code

string

Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK".

Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region.

See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

lat_lng

LatLng

Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if address is provided.

distance_in_miles

double

Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored.

telecommute_preference

TelecommutePreference

Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched.

This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response.

TelecommutePreference

Specify whether including telecommute jobs.

Enums
TELECOMMUTE_PREFERENCE_UNSPECIFIED Default value if the telecommute preference is not specified.
TELECOMMUTE_EXCLUDED Exclude telecommute jobs.
TELECOMMUTE_ALLOWED Allow telecommute jobs.

NumericBucketingOption

Input only.

Use this field to specify bucketing option for the histogram search response.

Fields
bucket_bounds[]

double

Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), [5, 10), [10, 15), [15, inf). At most 20 [buckets_bound][] is supported.

requires_min_max

bool

Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.

NumericBucketingResult

Output only.

Custom numeric bucketing result.

Fields
counts[]

BucketizedCount

Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1.

min_value

DoubleValue

Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.

max_value

DoubleValue

Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true.

BucketizedCount

Represents count of jobs within one bucket.

Fields
range

BucketRange

Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range.

count

int32

Number of jobs whose numeric field value fall into range.

BucketRange

Represents starting and ending value of a range in double.

Fields
from

double

Starting value of the bucket range.

to

double

Ending value of the bucket range.

PostingRegion

An enum that represents the job posting region. In most cases, job postings don't need to specify a region. If a region is given, jobs are eligible for searches in the specified region.

Enums
POSTING_REGION_UNSPECIFIED If the region is unspecified, the job is only returned if it matches the LocationFilter.
ADMINISTRATIVE_AREA

In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a ADMINISTRATIVE_AREA job is posted in "CA, USA", it's returned if LocationFilter has "Mountain View".

Administrative area refers to top-level administrative subdivision of this country. For example, US state, IT region, UK constituent nation and JP prefecture.

NATION In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a NATION_WIDE job is posted in "USA", it's returned if LocationFilter has 'Mountain View'.
TELECOMMUTE Job allows employees to work remotely (telecommute). If [locations][] are provided with this value, the job is considered as having a location, but telecommuting is allowed.

RequestMetadata

Input only.

Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.

Fields
domain

string

Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run.

For example, if the service is being run by client Foo, Inc., on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site.

If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain.

The maximum number of allowed characters is 255.

session_id

string

Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service.

If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id.

The maximum number of allowed characters is 255.

user_id

string

Required. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service.

If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to a unique user_id.

The maximum number of allowed characters is 255.

device_info

DeviceInfo

Optional. The type of device used by the job seeker at the time of the call to the service.

ResponseMetadata

Output only.

Additional information returned to client, such as debugging information.

Fields
request_id

string

A unique id associated with this call. This id is logged for tracking purposes.

SearchJobsRequest

Input only.

The Request body of the SearchJobs call.

Fields
parent

string

Required. The resource name of the project to search within.

The format is "projects/{project_id}", for example, "projects/api-test-project".

search_mode

SearchMode

Optional. Mode of a search.

Defaults to SearchMode.JOB_SEARCH.

request_metadata

RequestMetadata

Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as user_id) are provided by users, and must be unique and consistent.

job_query

JobQuery

Optional. Query used to search against jobs, such as keyword, location filters, etc.

enable_broadening

bool

Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list.

Defaults to false.

require_precise_result_size

bool

Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to true ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page.

Enabling this flag may adversely impact performance.

Defaults to false.

histogram_facets

HistogramFacets

Optional. Histogram requests for jobs matching JobQuery.

job_view

JobView

Optional. The desired job attributes returned for jobs in the search response. Defaults to [JobView.SMALL][] if no value is specified.

offset

int32

Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).

page_size

int32

Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.

page_token

string

Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.

order_by

string

Optional. The criteria determining how search results are sorted. Default is "relevance desc".

Supported options are:

diversification_level

DiversificationLevel

Optional. Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.

Defaults to DiversificationLevel.SIMPLE if no value is specified.

disable_keyword_match

bool

Optional. Controls whether to disable exact keyword match on [Job.job_title][], Job.description, Job.company_display_name, [Job.locations][0], Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description.

For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value.

Please use [Company.keyword_searchable_custom_fields][] or [Company.keyword_searchable_custom_attributes][] if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests.

Defaults to false.

DiversificationLevel

Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.

Enums
DIVERSIFICATION_LEVEL_UNSPECIFIED The diversification level isn't specified. By default, jobs with this enum are ordered according to SIMPLE diversifying behavior.
DISABLED Disables diversification. Jobs that would normally be pushed to the last page would not have their positions altered. This may result in highly similar jobs appearing in sequence in the search results.
SIMPLE Default diversifying behavior. The result list is ordered so that highly similar results are pushed to the end of the last page of search results.

SearchMode

A string-represented enumeration of the job search mode. The service operate differently for different modes of service.

Enums
SEARCH_MODE_UNSPECIFIED The mode of the search method isn't specified. The default search behavior is identical to JOB_SEARCH search behavior.

SearchJobsResponse

Output only.

Response for SearchJob method.

Fields
matching_jobs[]

MatchingJob

The Job entities that match the specified SearchJobsRequest.

histogram_results

HistogramResults

The histogram results that match specified SearchJobsRequest.histogram_facets.

next_page_token

string

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

location_filters[]

Location

The location filters that the service applied to the specified query. If any filters are lat-lng based, the [JobLocation.location_type][] is [JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED][].

estimated_total_size

int32

An estimation of the number of jobs that match the specified query.

This number is not guaranteed to be accurate. For accurate results, see [enable_precise_result_size][].

total_size

int32

The precise result count, which is available only if the client set [enable_precise_result_size][] to true, or if the response is the last page of results. Otherwise, the value is -1.

metadata

ResponseMetadata

Additional information for the API invocation, such as the request tracking id.

broadened_query_jobs_count

int32

If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.

spell_correction

SpellingCorrection

The spell checking result, and correction.

CommuteInfo

Output only.

Commute details related to this job.

Fields
job_location

Location

Location used as the destination in the commute calculation.

travel_duration

Duration

The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query.

MatchingJob

Output only.

Job entry with metadata inside SearchJobsResponse.

Fields
job

Job

Job resource that matches the specified SearchJobsRequest.

job_summary

string

A summary of the job with core information that's displayed on the search results listing page.

job_title_snippet

string

Contains snippets of text from the [Job.job_title][] field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.

search_text_snippet

string

Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

commute_info

CommuteInfo

Commute information which is generated based on specified CommuteFilter.

SearchType

An enum that represents the type of search filters to apply during a job search. This field can also be used to specify the filter criteria of the histogram search call.

Enums
SEARCH_TYPE_UNSPECIFIED The default value if search type is not specified.
COMPANY_ID Filter by the [company id][distributor_company_id] field.
EMPLOYMENT_TYPE Filter by the employment type field, such as FULL_TIME or PART_TIME.
COMPANY_SIZE Filter by the company size type field, such as BIG, SMALL or BIGGER.
DATE_PUBLISHED Filter by the date published field. Possible return values are: * PAST_24_HOURS (The past 24 hours) * PAST_3_DAYS (The past 3 days) * PAST_WEEK (The past 7 days) * PAST_MONTH (The past 30 days) * PAST_YEAR (The past 365 days)
EDUCATION_LEVEL Filter by the required education level of the job.
EXPERIENCE_LEVEL Filter by the required experience level of the job.
ADMIN_1 Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
COUNTRY Filter by the country code of job, such as US, JP, FR.
CITY Filter by the "city name", "Admin1 code", for example, "Mountain View, CA" or "New York, NY".
LOCALE

Filter by the locale field of a job, such as "en-US", "fr-FR".

This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

LANGUAGE Filter by the language code portion of the locale field, such as "en" or "fr".
CATEGORY Filter by the [Category][].
CITY_COORDINATE Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.
ADMIN_1_COUNTRY A combination of state or province code with a country code. This field differs from JOB_ADMIN1, which can be used in multiple countries.
COMPANY_DISPLAY_NAME Company display name.
BASE_COMPENSATION_UNIT Base compensation unit.

SpellingCorrection

Output only.

Spell check result.

Fields
corrected

bool

Indicates if the query was corrected by the spell checker.

corrected_text

string

Correction output consisting of the corrected keyword string.

TimestampRange

Message representing a period of time between two timestamps.

Fields
start_time

Timestamp

Begin of the period.

end_time

Timestamp

End of the period.

UpdateCompanyRequest

Input only.

Request for updating a specified company.

Fields
company

Company

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

update_mask

FieldMask

Optional but strongly recommended for the best service experience.

If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated.

A field mask to specify the company fields to be updated. Only top level fields of Company are supported.

UpdateJobRequest

Input only.

Update job request.

Fields
job

Job

Required. The Job to be updated.

update_mask

FieldMask

Optional but strongly recommended to be provided for the best service experience.

If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated.

A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

Visibility

Deprecated. All resources are only visible to the owner.

An enum that represents who has view access to the resource.

Enums
VISIBILITY_UNSPECIFIED Default value.
ACCOUNT_ONLY The resource is only visible to the GCP account who owns it.
SHARED_WITH_GOOGLE The resource is visible to the owner and may be visible to other applications and processes at Google.
SHARED_WITH_PUBLIC The resource is visible to the owner and may be visible to all other API clients.