v4beta1

Default value.

Candidate has applied or a recruiter put candidate into consideration but candidate is not yet screened / no decision has been made to move or not move the candidate to the next stage.

A recruiter decided to screen the candidate for this role.

Candidate is being / was sent to the customer / hiring manager for detailed review.

Candidate was approved by the client / hiring manager and is being / was interviewed for the role.

Candidate will be / has been given an offer of employment.

Candidate has accepted their offer of employment.

Candidate has begun (or completed) their employment or assignment with the employer.

Default value.

The current stage is in progress or pending, for example, interviews in progress.

The current stage was terminated by a candidate decision.

The current stage was terminated by an employer or agency decision.

The current stage is successfully completed, but the next stage (if applicable) has not begun.

The current stage was closed without an exception, or terminated for reasons unrealated to the candidate.

Default value.

Job application signal.

In the context of Profile.availability_signals, this signal is related to the candidate's most recent application. last_update_time is calculated from max(Application.create_time) from all Application records where Application.source is any of the following: APPLY_DIRECT_WEB APPLY_DIRECT_MOBILE_WEB APPLY_DIRECT_MOBILE_APP APPLY_DIRECT_IN_PERSON APPLY_INDIRECT

In the context of AvailabilityFilter, the filter is applied on Profile.availability_signals where type is JOB_APPLICATION.

Resume update signal.

In the context of Profile.availability_signals, this signal is related to the candidate's most recent update to their resume. For a SummarizedProfile.summary, last_update_time is calculated from max(Profile.resume_update_time) from all SummarizedProfile.profiles.

In the context of AvailabilityFilter, the filter is applied on Profile.availability_signals where type is RESUME_UPDATE.

Candidate update signal.

In the context of Profile.availability_signals, this signal is related to the candidate's most recent update to their profile. For a SummarizedProfile.summary, last_update_time is calculated from max(Profile.candidate_update_time) from all SummarizedProfile.profiles.

In the context of AvailabilityFilter, the filter is applied on Profile.availability_signals where type is CANDIDATE_UPDATE.

Client submission signal.

In the context of Profile.availability_signals, this signal is related to the candidate's most recent submission. last_update_time is calculated from max(Application.create_time) from all Application records where Application.stage is any of the following: HIRING_MANAGER_REVIEW INTERVIEW OFFER_EXTENDED OFFER_ACCEPTED STARTED

In the context of AvailabilityFilter, the filter is applied on Profile.availability_signals where type is CLIENT_SUBMISSION.

Commute method isn't specified.

Commute time is calculated based on driving time.

Commute time is calculated based on public transit including bus, metro, subway, and so on.

Commute time is calculated based on walking time.

Commute time is calculated based on biking time.

Default value if the size isn't specified.

The company has less than 50 employees.

The company has between 50 and 99 employees.

The company has between 100 and 499 employees.

The company has between 500 and 999 employees.

The company has between 1,000 and 4,999 employees.

The company has between 5,000 and 9,999 employees.

The company has 10,000 or more employees.

Default value.

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.

Signing bonus.

Equity.

Profit sharing.

Commission.

Tips.

Other compensation type.

Default value.

Hourly.

Daily.

Weekly

Monthly.

Yearly.

One time.

Other compensation units.

Default value.

Suggestions are based only on the data provided by the client.

Suggestions are based on all jobs data in the system that's visible to the client

Default value.

Suggest job titles for jobs autocomplete.

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

Suggest company names for jobs autocomplete.

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

Suggest both job titles and company names for jobs autocomplete.

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

Default value.

Personal use.

Work use.

School use.

Default value.

Data owned by this tenant is used to improve search/recommendation quality across tenants.

Data owned by this tenant is used to improve search/recommendation quality for this tenant only.

Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten

Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school

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

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; 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.

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.

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.

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; 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.

The device type isn't specified.

A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)

A mobile device web browser, such as a phone or tablet with a Chrome browser.

An Android device native application.

An iOS device native application.

A bot, as opposed to a device operated by human beings, such as a web crawler.

Other devices types.

The diversification level isn't specified.

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.

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. If you are using pageToken to page through the result set, latency might be lower but we can't guarantee that all results are returned. If you are using page offset, latency might be higher but all results are returned.

Default value.

Apply to all employers in Profile.employment_records.

Apply only to current employer in Profile.employment_records.

Apply only to past (not current) employers in Profile.employment_records.

The default value if the employment type isn't specified.

The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.

The job entails working fewer hours than a full time job, typically less than 40 hours a week.

The job is offered as a contracted, as opposed to a salaried employee, position.

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.

The job is offered as a temporary employment opportunity, usually a short-term engagement.

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.

The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.

The job requires an employee to work on an as-needed basis with a flexible schedule.

The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.

The job does not fit any of the other listed types.

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

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.

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 CompensationUnit and amount or range overlaps with provided CompensationRange.

See CompensationInfo.CompensationEntry for definition of base compensation entry.

Set exactly one units and populate range.

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

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

Default value.

Disables sanitization on HTML input.

Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags.

Default value if the importance level isn't specified.

The given ranking expression is of None importance, existing relevance score (determined by API algorithm) dominates job's final ranking position.

The given ranking expression is of Low importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).

The given ranking expression is of Mild importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).

The given ranking expression is of Medium importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).

The given ranking expression is of High importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).

The given ranking expression is of Extreme importance, and dominates job's final ranking position with existing relevance score (determined by API algorithm) ignored.

Default value if the type isn't specified.

The job includes access to programs that support child care, such as daycare.

The job includes dental services covered by a dental insurance plan.

The job offers specific benefits to domestic partners.

The job allows for a flexible work schedule.

The job includes health services covered by a medical insurance plan.

The job includes a life insurance plan provided by the employer or available for purchase by the employee.

The job allows for a leave of absence to a parent to care for a newborn child.

The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.

The job allows for paid time off due to illness.

The job includes paid time off for vacation.

The job includes vision services covered by a vision insurance plan.

The default value if the category isn't specified.

An accounting and finance job, such as an Accountant.

An administrative and office job, such as an Administrative Assistant.

An advertising and marketing job, such as Marketing Manager.

An animal care job, such as Veterinarian.

An art, fashion, or design job, such as Designer.

A business operations job, such as Business Operations Manager.

A cleaning and facilities job, such as Custodial Staff.

A computer and IT job, such as Systems Administrator.

A construction job, such as General Laborer.

A customer service job, such s Cashier.

An education job, such as School Teacher.

An entertainment and travel job, such as Flight Attendant.

A farming or outdoor job, such as Park Ranger.

A healthcare job, such as Registered Nurse.

A human resources job, such as Human Resources Director.

An installation, maintenance, or repair job, such as Electrician.

A legal job, such as Law Clerk.

A management job, often used in conjunction with another category, such as Store Manager.

A manufacturing or warehouse job, such as Assembly Technician.

A media, communications, or writing job, such as Media Relations.

An oil, gas or mining job, such as Offshore Driller.

A personal care and services job, such as Hair Stylist.

A protective services job, such as Security Guard.

A real estate job, such as Buyer's Agent.

A restaurant and hospitality job, such as Restaurant Server.

A sales and/or retail job, such Sales Associate.

A science and engineering job, such as Lab Technician.

A social services or non-profit job, such as Case Worker.

A sports, fitness, or recreation job, such as Personal Trainer.

A transportation or logistics job, such as Truck Driver.

The event is unspecified by other provided values.

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.

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).

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.

The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.

The job seeker or other entity interacting with the service submitted an application for a job.

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.

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.

The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job from the search results page without viewing the details of the job posting. If sending this event, JobEventType.VIEW event shouldn't be sent.

The job seeker, or other entity interacting with the service, performs an action with a single click from the search results page to apply to a job (without viewing the details of the job posting), and is redirected to a different website to complete the application. If a candidate performs this action, send only this event to the service. Do not also send JobEventType.APPLICATION_START, JobEventType.APPLICATION_FINISH or JobEventType.VIEW events.

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.

The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.

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.

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.

A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.

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.

The default value if the level isn't specified.

Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.

Experienced individual contributors, typically with 2+ years of experience in a similar role.

Entry- to mid-level managers responsible for managing a team of people.

Senior-level managers responsible for managing teams of managers.

Executive-level managers and above, including C-level positions.

Default value.

A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.

A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company, Job.DerivedInfo.locations, Job.language_code.

A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.

All available attributes are included in the search results.

Default value if the type isn't specified.

A country level location.

A state or equivalent level location.

A county or equivalent level location.

A city or equivalent level location.

A postal code level location.

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.

A district or equivalent level location.

A smaller district or equivalent level display.

A neighborhood level location.

A street address level location.

Default value.

A positive outcome / passing indicator (for example, candidate was recommended for hiring or to be moved forward in the hiring process, candidate passed a test).

A neutral outcome / no clear indicator (for example, no strong reccommendation either to move forward / not move forward, neutral score).

A negative outcome / failing indicator (for example, candidate was recommended to NOT move forward in the hiring process, failed a test).

The assessment outcome is not available or otherwise unknown (for example, candidate did not complete assessment).

Default value.

A landline.

A mobile.

A fax.

A pager.

A TTY (test telephone) or TDD (telecommunication device for the deaf).

A voicemail.

A virtual telephone number is a number that can be routed to another number and managed by the user via Web, SMS, IVR, and so on. It is associated with a particular person, and may be routed to either a MOBILE or LANDLINE number. The phone usage should be set to PERSONAL for these phone types. Some more information can be found here: https://en.wikipedia.org/wiki/Personal_Numbers

Voice over IP numbers. This includes TSoIP (Telephony Service over IP).

In some regions (e.g. the USA), it is impossible to distinguish between fixed-line and mobile numbers by looking at the phone number itself.

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

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.

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'.

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.

Default value.

Send this event when a ProfileEvent.profiles was sent as a part of a result set for a CTS API call and was rendered in the end user's UI (that is, the ProfileEvent.recruiter).

The VIEW event records the action of a candidate's profile being viewed by an end user. This is critical to tracking product metrics and should be sent for every profile VIEW that happens in your system, whether the event is associated with an API call (for example, a recruiter making a request for a result set and clicking on a profile) or not (a recruiter using the system to view profile details without making a request).

For a VIEW events associated with API calls, the ClientEvent.request_id should be populated. If the VIEW is not associated with an API call, request_id should not be populated.

This event requires a valid recruiter and one valid ID in profiles.

The profile is bookmarked.

Default value.

The profile contents in HR-XML format. See https://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more information about Human Resources XML.

Resume type not specified.

Road traffic situation isn't specified.

Optimal commute time without considering any traffic impact.

Commute time calculation takes in account the peak traffic impact.

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

The job search matches against all jobs, and featured jobs (jobs with promotionValue > 0) are not specially handled.

The job search matches only against featured jobs (jobs with a promotionValue > 0). This method doesn't return any jobs having a promotionValue <= 0. The search results order is determined by the promotionValue (jobs with a higher promotionValue are returned higher up in the search results), with relevance being used as a tiebreaker.

Default value.

Lacks any proficiency in this skill.

Have a common knowledge or an understanding of basic techniques and concepts.

Have the level of experience gained in a classroom and/or experimental scenarios or as a trainee on-the-job.

Be able to successfully complete tasks in this skill as requested. Help from an expert may be required from time to time, but can usually perform skill independently.

Can perform the actions associated with this skill without assistance.

Known as an expert in this area.

Default value.

The batch operation is being prepared for processing.

The batch operation is actively being processed.

The batch operation is processed, and at least one item has been successfully processed.

The batch operation is done and no item has been successfully processed.

The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation is called.

The batch operation is done after google.longrunning.Operations.CancelOperation is called. Any items processed before cancelling are returned in the response.

Default value if the telecommute preference isn't specified.

Exclude telecommute jobs.

Allow telecommute jobs.

Default value.

Earliest profile create time.

Latest profile update time.

Default value.

The resource is only visible to the GCP account who owns it.

The resource is visible to the owner and may be visible to other applications and processes at Google.

The resource is visible to the owner and may be visible to all other API clients.

Activity display name.

Number of characters allowed is 100.

Activity description.

Number of characters allowed is 100,000.

Activity URI.

Number of characters allowed is 4,000.

The first creation date of the activity.

This object should have the same structure as Date

The last update date of the activity.

This object should have the same structure as Date

A list of team members involved in this activity.

Number of characters allowed is 100.

The limitation for max number of team members is 50.

A list of skills used in this activity.

The limitation for max number of skills used is 50.

This object should have the same structure as Skill

Output only. Activity name snippet shows how the display_name is related to a search query. It's empty if the display_name isn't related to the search query.

Output only. Activity description snippet shows how the description is related to a search query. It's empty if the description isn't related to the search query.

Output only. Skill used snippet shows how the corresponding skills_used are related to a search query. It's empty if the corresponding skills_used are not related to the search query.

The usage of this contact method. For example, SCHOOL, WORK, PERSONAL.

The number should be among the values of ContactInfoUsage

The name of the contact method.

For example, "hangout", "skype".

Number of characters allowed is 100.

The contact id.

Number of characters allowed is 100.

The usage of the address. For example, SCHOOL, WORK, PERSONAL.

The number should be among the values of ContactInfoUsage

Unstructured address.

For example, "1600 Amphitheatre Pkwy, Mountain View, CA 94043", "Sunnyvale, California".

Number of characters allowed is 100.

Structured address that contains street address, city, state, country, and so on.

This object should have the same structure as PostalAddress

Indicates if it's the person's current address.

This object should have the same structure as BoolValue

Required during application update.

Resource name assigned to an application by the API.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

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

The maximum number of allowed characters is 255.

Output only. Resource name of the candidate of this application.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

One of either a job or a company is required.

Resource name of the job which the candidate applied for.

The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

One of either a job or a company is required.

Resource name of the company which the candidate applied for.

The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz".

The application date.

This object should have the same structure as Date

Required. What is the most recent stage of the application (that is, new, screen, send cv, hired, finished work)? This field is intentionally not comprehensive of every possible status, but instead, represents statuses that would be used to indicate to the ML models good / bad matches.

The number should be among the values of ApplicationStage

The application state.

The number should be among the values of ApplicationState

All interviews (screen, onsite, and so on) conducted as part of this application (includes details such as user conducting the interview, timestamp, feedback, and so on).

This object should have the same structure as Interview

If the candidate is referred by a employee.

This object should have the same structure as BoolValue

Required. Reflects the time that the application was created.

This object should have the same structure as Timestamp

The last update timestamp.

This object should have the same structure as Timestamp

Free text reason behind the recruitement outcome (for example, reason for withdraw / reject, reason for an unsuccessful finish, and so on).

Number of characters allowed is 100.

Outcome positiveness shows how positive the outcome is.

The number should be among the values of Outcome

Output only. Indicates whether this job application is a match to application related filters. This value is only applicable in profile search response.

This object should have the same structure as BoolValue

Output only. Job title snippet shows how the job title is related to a search query. It's empty if the job title isn't related to the search query.

Start date. If it's missing, The API matches profiles with application date not after the end date.

This object should have the same structure as Date

End date. If it's missing, The API matches profiles with application date not before the start date.

This object should have the same structure as Date

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.

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.

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.

The job requisition id in the application. The API does an exact match on the Job.requisition_id of Application.job in profiles.

The job title in the application. The API does an exact match on the Job.title of Application.job in profiles.

If true, the API excludes all profiles with any Application.job matching the filters.

Required. User entered or selected outcome reason. The API does an exact match on the Application.outcome_notes in profiles.

If true, The API excludes all candidates with any Application.outcome_notes matching the outcome reason specified in the filter.

Required. Type of signal to apply filter on.

The number should be among the values of AvailabilitySignalType

Required. Range of times to filter candidate signals by.

This object should have the same structure as TimestampRange

If multiple AvailabilityFilter are provided, the default behavior is to OR all filters, but if this field is set to true, this particular AvailabilityFilter will be AND'ed against other AvailabilityFilter.

Type of signal.

The number should be among the values of AvailabilitySignalType

Timestamp of when the given availability activity last happened.

This object should have the same structure as Timestamp

Indicates if the last_update_time is within AvailabilityFilter.range.

Returned only in a search response when there is an AvailabilityFilter in ProfileQuery.availability_filters where signal_type matches type.

This object should have the same structure as BoolValue

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

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

Required. The jobs to be created.

This object should have the same structure as Job

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

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

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/foo/companies/bar" AND requisitionId = "req-1"

The state of a long running operation.

The number should be among the values of State

More detailed information about operation state.

Count of successful item(s) inside an operation.

Count of failed item(s) inside an operation.

Count of total item(s) inside an operation.

The time when the batch operation is created.

This object should have the same structure as Timestamp

The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.

This object should have the same structure as Timestamp

The time when the batch operation is finished and google.longrunning.Operation.done is set to true.

This object should have the same structure as Timestamp

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

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

Required. The jobs to be updated.

This object should have the same structure as Job

Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation.

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.

If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.

This object should have the same structure as FieldMask

It is false by default. If true, API excludes all the potential available profiles.

Name of license or certification.

Number of characters allowed is 100.

Acquisition date or effective date of license or certification.

This object should have the same structure as Date

Expiration date of license of certification.

This object should have the same structure as Date

Authority of license, such as government.

Number of characters allowed is 100.

Description of license or certification.

Number of characters allowed is 100,000.

Strongly recommended for the best service experience.

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

Required. A unique identifier, generated by the client application.

Required. The timestamp of the event.

This object should have the same structure as Timestamp

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

This object should have the same structure as JobEvent

An event issued when a profile searcher interacts with the application that implements Cloud Talent Solution.

This object should have the same structure as ProfileEvent

Notes about the event provided by recruiters or other users, for example, feedback on why a profile was bookmarked.

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

The number should be among the values of CommuteMethod

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

This object should have the same structure as LatLng

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

This object should have the same structure as Duration

If true, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to false or isn't specified, only jobs that include street level addresses will be returned by commute search.

Specifies the traffic density to use when calculating commute time.

The number should be among the values of RoadTraffic

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.

This object should have the same structure as TimeOfDay

Location used as the destination in the commute calculation.

This object should have the same structure as Location

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

This object should have the same structure as Duration

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}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

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

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

The maximum number of allowed characters is 255.

The employer's company size.

The number should be among the values of CompanySize

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.

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

Defaults to false if not provided.

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.

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.

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

A URI that hosts the employer's company logo.

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

Output only. Derived details about the company.

This object should have the same structure as DerivedInfo

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.

Compensation type.

Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.

The number should be among the values of CompensationType

Frequency of the specified amount.

Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

The number should be among the values of CompensationUnit

Compensation amount.

This object should have the same structure as Money

Compensation range.

This object should have the same structure as CompensationRange

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

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

This object should have the same structure as DoubleValue

Required. Type of filter.

The number should be among the values of FilterType

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

The number should be among the values of CompensationUnit

Compensation range.

This object should have the same structure as CompensationRange

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

Job compensation information.

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

This object should have the same structure as CompensationEntry

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

See CompensationEntry for explanation on compensation annualization.

This object should have the same structure as CompensationRange

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

See CompensationEntry for explanation on compensation annualization.

This object should have the same structure as CompensationRange

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.

This object should have the same structure as Money

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.

This object should have the same structure as Money

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

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar".

If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

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.

The maximum number of allowed characters is 255.

Required. Completion result count.

The maximum allowed page size is 10.

If provided, restricts completion to specified company.

The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

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

The number should be among the values of CompletionScope

The completion topic. The default is CompletionType.COMBINED.

The number should be among the values of CompletionType

Results of the matching job/company candidates.

This object should have the same structure as CompletionResult

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

This object should have the same structure as ResponseMetadata

The suggestion for the query.

The completion topic.

The number should be among the values of CompletionType

The URI of the company image for COMPANY_NAME.

Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

Required. The application to be created.

This object should have the same structure as Application

Required. Resource name of the tenant under which the event is created.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".

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

This object should have the same structure as ClientEvent

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

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".

Required. The company to be created.

This object should have the same structure as Company

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

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified a default tenant is created. For example, "projects/foo".

Required. The Job to be created.

This object should have the same structure as Job

Required. The name of the tenant this profile belongs to.

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

Required. The profile to be created.

This object should have the same structure as Profile

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

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

Required. The tenant to be created.

This object should have the same structure as Tenant

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 isn't allowed.

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.

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

Default is false.

Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position.

An error is thrown if not specified.

The number should be among the values of ImportanceLevel

Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position.

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

Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number.

Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length.

The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results.

Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)

ISCED degree type.

The number should be among the values of DegreeType

Full Degree name.

For example, "B.S.", "Master of Arts", and so on.

Number of characters allowed is 100.

Fields of study for the degree.

For example, "Computer science", "engineering".

Number of characters allowed is 100.

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

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

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

The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

If tenant id is unspecified, the default tenant is used, for example, "projects/foo/companies/bar".

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

The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

Required. Resource name of the profile to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

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

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

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

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

This object should have the same structure as Location

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

The number should be among the values of JobCategory

A structured headquarters location of the company, resolved from Company.headquarters_address if provided.

This object should have the same structure as Location

Type of the device.

The number should be among the values of DeviceType

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

The school name. For example "MIT", "University of California, Berkeley".

The field of study. This is to search against value provided in Degree.fields_of_study. For example "Computer Science", "Mathematics".

Education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.

The number should be among the values of DegreeType

Whether to apply negation to the filter so profiles matching the filter is excluded.

The start date of the education.

This object should have the same structure as Date

The end date of the education.

This object should have the same structure as Date

The expected graduation date if currently pursuing a degree.

This object should have the same structure as Date

The name of the school or institution.

For example, "Stanford University", "UC Berkeley", and so on.

Number of characters allowed is 250.

The physical address of the education institution.

This object should have the same structure as Address

The full description of the degree.

For example, "Master of Science in Computer Science", "B.S in Math".

Number of characters allowed is 100.

The structured notation of the degree.

This object should have the same structure as Degree

The description of the education.

Number of characters allowed is 100,000.

If this education is current.

This object should have the same structure as BoolValue

Output only. The school name snippet shows how the school_name is related to a search query in search result. It's empty if the school_name isn't related to the search query.

Output only. The job description snippet shows how the Degree is related to a search query in search result. It's empty if the Degree isn't related to the search query.

The usage of the email address. For example, SCHOOL, WORK, PERSONAL.

The number should be among the values of ContactInfoUsage

Email address.

Number of characters allowed is 4,000.

Required. The name of the employer, for example "Google", "Alphabet".

Define set of EmploymentRecords to search against.

Defaults to EmployerFilterMode.ALL_EMPLOYMENT_RECORDS.

The number should be among the values of EmployerFilterMode

Whether to apply negation to the filter so profiles matching the filter is excluded.

Start date of the employment.

This object should have the same structure as Date

End date of the employment.

This object should have the same structure as Date

The name of the employer company/organization.

For example, "Google", "Alphabet", and so on.

Number of characters allowed is 250.

The division name of the employment.

For example, division, department, client, and so on.

Number of characters allowed is 100.

The physical address of the employer.

This object should have the same structure as Address

The job title of the employment.

For example, "Software Engineer", "Data Scientist", and so on.

Number of characters allowed is 250.

The description of job content.

Number of characters allowed is 100,000.

If the jobs is a supervisor position.

This object should have the same structure as BoolValue

If this employment is self-employed.

This object should have the same structure as BoolValue

If this employment is current.

This object should have the same structure as BoolValue

Output only. The job title snippet shows how the job_title is related to a search query. It's empty if the job_title isn't related to the search query.

Output only. The job description snippet shows how the job_description is related to a search query. It's empty if the job_description isn't related to the search query.

Output only. The employer name snippet shows how the employer_name is related to a search query. It's empty if the employer_name isn't related to the search query.

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

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".

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

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

If tenant id is unspecified, the default tenant is used, for example, "projects/api-test-project/companies/bar".

Required. The resource name of the job to retrieve.

The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

Required. Resource name of the profile to get.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

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

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

An expression specifies a histogram request against matching resources (for example, jobs, profiles) for searches.

See SearchJobsRequest.histogram_queries and SearchProfilesRequest.histogram_queries for details about syntax.

Requested histogram expression.

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.

The key format is:

• (for string histogram) string values stored in the field.
• (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative.
• (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

The rating on this interview.

This object should have the same structure as Rating

Required. The overall decision resulting from this interview (positive, negative, nuetral).

The number should be among the values of Outcome

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}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

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

Required. The resource name of the company listing the job.

The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz".

If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

Required. The requisition ID, also referred to as the posting ID, is 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 isn't allowed to be created if there is another job with the same company, language_code and requisition_id.

The maximum number of allowed characters is 255.

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

The maximum number of allowed characters is 500.

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.

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', and so on.) as multiple jobs with the same company, 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.

Job application information.

This object should have the same structure as ApplicationInfo

The benefits included with the job.

The number should be among the values of JobBenefit

Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee.

This object should have the same structure as CompensationInfo

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.

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

The number should be among the values of DegreeType

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

The maximum number of allowed characters is 255.

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

The number should be among the values of EmploymentType

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.

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'.

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

The number should be among the values of JobLevel

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.

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.

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.

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.

The number should be among the values of PostingRegion

Deprecated. The job is only visible to the owner.

The visibility of the job.

Defaults to Visibility.ACCOUNT_ONLY if not specified.

The number should be among the values of Visibility

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

This object should have the same structure as Timestamp

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

This object should have the same structure as Timestamp

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.

This object should have the same structure as Timestamp

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 listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob 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, 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 number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out.

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

If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one.

If this value isn't 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 isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_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.

This object should have the same structure as Timestamp

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

This object should have the same structure as Timestamp

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

This object should have the same structure as Timestamp

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

Output only. Derived details about the job posting.

This object should have the same structure as DerivedInfo

Options for job processing.

This object should have the same structure as ProcessingOptions

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

The number should be among the values of JobEventType

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.

The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for example, "projects/foo/tenants/bar/jobs/baz".

The profile name associated with this client event.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".

List of job mutation results from a batch mutate operation. It can change until operation status is FINISHED, FAILED or CANCELLED.

This object should have the same structure as JobResult

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

The maximum number of allowed characters is 255.

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.

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}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz".

If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

At most 20 company filters are allowed.

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.

This object should have the same structure as LocationFilter

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

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

The number should be among the values of JobCategory

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

This object should have the same structure as CommuteFilter

This filter specifies the exact company 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.

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.

This object should have the same structure as CompensationFilter

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

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.

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

If a value isn't 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.

The number should be among the values of EmploymentType

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.

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

This object should have the same structure as TimestampRange

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

Here Job only contains basic information including name, company, language_code and requisition_id, use getJob method to retrieve detailed information of the created/updated job.

This object should have the same structure as Job

The status of the job processed. This field is populated if the processing of the job fails.

This object should have the same structure as Status

Required. The job title. For example, "Software engineer", or "Product manager".

Whether to apply negation to the filter so profiles matching the filter are excluded.

Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".

The starting indicator from which to return results.

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

Applications for the current client.

This object should have the same structure as Application

A token to retrieve the next page of results.

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

This object should have the same structure as ResponseMetadata

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

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar".

If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".

The starting indicator from which to return results.

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

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.

Companies for the current client.

This object should have the same structure as Company

A token to retrieve the next page of results.

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

This object should have the same structure as ResponseMetadata

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

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

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

Supported operator: =, AND

The fields eligible for filtering are:

• companyName (Required)
• requisitionId
• status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified.

Sample Query:

• companyName = "projects/foo/tenants/bar/companies/baz"
• companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1"
• companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"

The starting point of a query result.

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.

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

The number should be among the values of JobView

The Jobs for a given company.

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

This object should have the same structure as Job

A token to retrieve the next page of results.

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

This object should have the same structure as ResponseMetadata

Required. The resource name of the tenant under which the profile is created.

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

The filter string specifies the profiles to be enumerated.

Supported operator: =, AND

The field(s) eligible for filtering are:

• externalId
• groupId

externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error.

Sample Query:

• externalId = "externalId-1"
• groupId = "groupId-1"

The token that specifies the current offset (that is, starting result).

Please set the value to ListProfilesResponse.next_page_token to continue the list.

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

Default is 100 unless a positive number smaller than 100 is specified.

A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset.

Valid values are:

• name

This object should have the same structure as FieldMask

Profiles for the specific tenant.

This object should have the same structure as Profile

A token to retrieve the next page of results. This is empty if there are no more results.

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

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

The starting indicator from which to return results.

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

Tenants for the current client.

This object should have the same structure as Tenant

A token to retrieve the next page of results.

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

This object should have the same structure as ResponseMetadata

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

The number should be among the values of LocationType

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.

This object should have the same structure as PostalAddress

An object representing a latitude/longitude pair.

This object should have the same structure as LatLng

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 google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

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

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 to bias location resolution toward a specific country or territory. If this field is not set, application behavior is biased toward the United States by default.

See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. Note that this filter is not applicable for Profile Search related queries.

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

This object should have the same structure as LatLng

The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.

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.

This field is only used for job search requests.

The number should be among the values of TelecommutePreference

Whether to apply negation to the filter so profiles matching the filter are excluded.

Currently only supported in profile search.

Job resource that matches the specified SearchJobsRequest.

This object should have the same structure as Job

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

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

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 information which is generated based on specified CommuteFilter.

This object should have the same structure as CommuteInfo

Name of the patent.

Number of characters allowed is 100.

A list of inventors' names.

Number of characters allowed for each is 100.

The status of the patent.

Number of characters allowed is 100.

The date the last time the status of the patent was checked.

This object should have the same structure as Date

The date that the patent was filed.

This object should have the same structure as Date

The name of the patent office.

Number of characters allowed is 100.

The number of the patent.

Number of characters allowed is 100.

The description of the patent.

Number of characters allowed is 100,000.

The skills used in this patent.

This object should have the same structure as Skill

The personal URI.

Number of characters allowed is 4,000.

A string represents a person's full name. For example, "Dr. John Smith".

Number of characters allowed is 100.

A person's name in a structured way (last name, first name, suffix, and so on.)

This object should have the same structure as PersonStructuredName

Preferred name for the person. This field is ignored if structured_name is provided.

Number of characters allowed is 100.

Required. The person name. For example, "John Smith".

Can be any combination of PersonName.structured_name.given_name, PersonName.structured_name.middle_initial, PersonName.structured_name.family_name, and PersonName.formatted_name.

Given/first name.

It's derived from formatted_name if not provided.

Number of characters allowed is 100.

Preferred given/first name or nickname.

Number of characters allowed is 100.

Middle initial.

It's derived from formatted_name if not provided.

Number of characters allowed is 20.

Family/last name.

It's derived from formatted_name if not provided.

Number of characters allowed is 100.

Suffixes.

Number of characters allowed is 20.

Prefixes.

Number of characters allowed is 20.

The usage of the phone. For example, SCHOOL, WORK, PERSONAL.

The number should be among the values of ContactInfoUsage

The phone type. For example, LANDLINE, MOBILE, FAX.

The number should be among the values of PhoneType

Phone number.

Any phone formats are supported and only exact matches are performed on searches. For example, if a phone number in profile is provided in the format of "(xxx)xxx-xxxx", in profile searches the same phone format has to be provided.

Number of characters allowed is 20.

When this number is available. Any descriptive string is expected.

Number of characters allowed is 100.

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

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 isn't disabled.

Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.

The number should be among the values of HtmlSanitization

Required during profile update.

Resource name assigned to a profile by the API.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".

Profile's id in client system, if available. This value is unique for each profile inside a tenant. An error is thrown if another profile with the same external_id is created.

The maximum number of bytes allowed is 100.

The source description indicating where the profile is acquired.

For example, if a candidate profile is acquired from a resume, the user can input "resume" here to indicate the source.

The maximum number of bytes allowed is 100.

The URI set by clients that links to this profile's client-side copy.

The maximum number of bytes allowed is 4000.

The cluster id of the profile to associate with other profile(s) for the same candidate.

This field should be generated by the customer. If a value is not provided, a random UUID is assigned to this field of the profile.

This is used to link multiple profiles to the same candidate. For example, a client has a candidate with two profiles, where one was created recently and the other one was created 5 years ago. These two profiles may be very different. The clients can create the first profile and get a generated group_id, and assign it when the second profile is created, indicating these two profiles are referring to the same candidate.

Indicates the hirable status of the candidate.

This object should have the same structure as BoolValue

The timestamp when the profile was first created at this source.

This object should have the same structure as Timestamp

The timestamp when the profile was last updated at this source.

This object should have the same structure as Timestamp

The timestamp when the profile was last updated as a result of a direct or indirect action by a candidate.

These actions include:

• Direct actions such as the candidate submitting a new resume as part of a job application to the agency, using a self-service tool such as a website to update their profile, and so on.
• Indirect actions by the candidate such as uploading a resume to a job board that is collected by the agency through a feed, providing a resume to a recruiter who then uploads it into the ATS, and so on.
• Updates made to the candidate's profile by the recruiter as a result of interacting with the candidate (for example adding a skill or work preference, and so on). Changes to recruiting_notes are specifically excluded from this action type.

Note: candidate_update_time must be greater than or equal to resume_update_time or an error is thrown.

This object should have the same structure as Timestamp

The timestamp when the candidate's resume was added or updated on the candidate's profile. Whether that resume was directly uploaded by a candidate, pulled from a 3rd party job board feed, added by a recruiter, and so on.

If this field is updated, it's expected that resume is provided in the create or update calls.

This object should have the same structure as Timestamp