googleapis
Version:
Google APIs Client Library for Node.js
859 lines • 129 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace jobs_v4 {
export interface Options extends GlobalOptions {
version: 'v4';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Talent Solution API
*
* Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.
*
* @example
* ```js
* const {google} = require('googleapis');
* const jobs = google.jobs('v4');
* ```
*/
export class Jobs {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Application related details of a job posting.
*/
export interface Schema$ApplicationInfo {
/**
* 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.
*/
emails?: string[] | null;
/**
* 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.
*/
instruction?: string | null;
/**
* 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.
*/
uris?: string[] | null;
}
/**
* Request to create a batch of jobs.
*/
export interface Schema$BatchCreateJobsRequest {
/**
* Required. The jobs to be created. A maximum of 200 jobs can be created in a batch.
*/
jobs?: Schema$Job[];
}
/**
* The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.
*/
export interface Schema$BatchCreateJobsResponse {
/**
* List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
*/
jobResults?: Schema$JobResult[];
}
/**
* Request to delete a batch of jobs.
*/
export interface Schema$BatchDeleteJobsRequest {
/**
* The names of the jobs to delete. The format is "projects/{project_id\}/tenants/{tenant_id\}/jobs/{job_id\}". For example, "projects/foo/tenants/bar/jobs/baz". A maximum of 200 jobs can be deleted in a batch.
*/
names?: string[] | null;
}
/**
* The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.
*/
export interface Schema$BatchDeleteJobsResponse {
/**
* List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
*/
jobResults?: Schema$JobResult[];
}
/**
* Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.
*/
export interface Schema$BatchOperationMetadata {
/**
* The time when the batch operation is created.
*/
createTime?: string | null;
/**
* The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.
*/
endTime?: string | null;
/**
* Count of failed item(s) inside an operation.
*/
failureCount?: number | null;
/**
* The state of a long running operation.
*/
state?: string | null;
/**
* More detailed information about operation state.
*/
stateDescription?: string | null;
/**
* Count of successful item(s) inside an operation.
*/
successCount?: number | null;
/**
* Count of total item(s) inside an operation.
*/
totalCount?: number | null;
/**
* The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.
*/
updateTime?: string | null;
}
/**
* Request to update a batch of jobs.
*/
export interface Schema$BatchUpdateJobsRequest {
/**
* Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch.
*/
jobs?: Schema$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.
*/
updateMask?: string | null;
}
/**
* The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.
*/
export interface Schema$BatchUpdateJobsResponse {
/**
* List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
*/
jobResults?: Schema$JobResult[];
}
/**
* An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results 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.
*/
export interface Schema$ClientEvent {
/**
* Required. The timestamp of the event.
*/
createTime?: string | null;
/**
* Required. A unique identifier, generated by the client application.
*/
eventId?: string | null;
/**
* Notes about the event provided by recruiters or other users, for example, feedback on why a job was bookmarked.
*/
eventNotes?: string | null;
/**
* An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
*/
jobEvent?: Schema$JobEvent;
/**
* Strongly recommended for the best service experience. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.
*/
requestId?: string | null;
}
/**
* Parameters needed for commute search.
*/
export interface Schema$CommuteFilter {
/**
* 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.
*/
allowImpreciseAddresses?: boolean | null;
/**
* Required. The method of transportation to calculate the commute time for.
*/
commuteMethod?: string | null;
/**
* 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.
*/
departureTime?: Schema$TimeOfDay;
/**
* Specifies the traffic density to use when calculating commute time.
*/
roadTraffic?: string | null;
/**
* Required. The latitude and longitude of the location to calculate the commute time from.
*/
startCoordinates?: Schema$LatLng;
/**
* Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.
*/
travelDuration?: string | null;
}
/**
* Commute details related to this job.
*/
export interface Schema$CommuteInfo {
/**
* Location used as the destination in the commute calculation.
*/
jobLocation?: Schema$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.
*/
travelDuration?: string | null;
}
/**
* 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.
*/
export interface Schema$Company {
/**
* The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
*/
careerSiteUri?: string | null;
/**
* Output only. Derived details about the company.
*/
derivedInfo?: Schema$CompanyDerivedInfo;
/**
* Required. The display name of the company, for example, "Google LLC".
*/
displayName?: string | null;
/**
* 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.
*/
eeoText?: string | null;
/**
* Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
*/
externalId?: string | null;
/**
* 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.
*/
headquartersAddress?: string | null;
/**
* Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
*/
hiringAgency?: boolean | null;
/**
* A URI that hosts the employer's company logo.
*/
imageUri?: string | null;
/**
* This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. 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.
*/
keywordSearchableJobCustomAttributes?: string[] | null;
/**
* 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".
*/
name?: string | null;
/**
* The employer's company size.
*/
size?: string | null;
/**
* 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.
*/
suspended?: boolean | null;
/**
* 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.
*/
websiteUri?: string | null;
}
/**
* Derived details about the company.
*/
export interface Schema$CompanyDerivedInfo {
/**
* A structured headquarters location of the company, resolved from Company.headquarters_address if provided.
*/
headquartersLocation?: Schema$Location;
}
/**
* 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.
*/
export interface Schema$CompensationEntry {
/**
* Compensation amount.
*/
amount?: Schema$Money;
/**
* Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.
*/
description?: string | null;
/**
* 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
*/
expectedUnitsPerYear?: number | null;
/**
* Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.
*/
type?: string | null;
/**
* Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
*/
unit?: string | null;
}
/**
* Filter on job compensation type and amount.
*/
export interface Schema$CompensationFilter {
/**
* If set to true, jobs with unspecified compensation range fields are included.
*/
includeJobsWithUnspecifiedCompensationRange?: boolean | null;
/**
* Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Required. Type of filter.
*/
type?: string | null;
/**
* Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.
*/
units?: string[] | null;
}
/**
* Job compensation details.
*/
export interface Schema$CompensationInfo {
/**
* 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.
*/
annualizedBaseCompensationRange?: Schema$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.
*/
annualizedTotalCompensationRange?: Schema$CompensationRange;
/**
* Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.
*/
entries?: Schema$CompensationEntry[];
}
/**
* Compensation range.
*/
export interface Schema$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.
*/
maxCompensation?: Schema$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.
*/
minCompensation?: Schema$Money;
}
/**
* Response of auto-complete query.
*/
export interface Schema$CompleteQueryResponse {
/**
* Results of the matching job/company candidates.
*/
completionResults?: Schema$CompletionResult[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
}
/**
* Resource that represents completion results.
*/
export interface Schema$CompletionResult {
/**
* The URI of the company image for COMPANY_NAME.
*/
imageUri?: string | null;
/**
* The suggestion for the query.
*/
suggestion?: string | null;
/**
* The completion topic.
*/
type?: string | null;
}
/**
* Custom attribute values that are either filterable or non-filterable.
*/
export interface Schema$CustomAttribute {
/**
* If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.
*/
filterable?: boolean | null;
/**
* If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.
*/
keywordSearchable?: boolean | null;
/**
* 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.
*/
longValues?: string[] | null;
/**
* 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_value`s, 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.
*/
stringValues?: string[] | null;
}
/**
* Custom ranking information for SearchJobsRequest.
*/
export interface Schema$CustomRankingInfo {
/**
* 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.
*/
importanceLevel?: string | null;
/**
* 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 < 200 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)
*/
rankingExpression?: string | null;
}
/**
* 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.
*/
export interface Schema$DeviceInfo {
/**
* Type of the device.
*/
deviceType?: string | null;
/**
* A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.
*/
id?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* The histogram request.
*/
export interface Schema$HistogramQuery {
/**
* An expression specifies a histogram request against matching jobs for searches. See SearchJobsRequest.histogram_queries for details about syntax.
*/
histogramQuery?: string | null;
}
/**
* Histogram result that matches HistogramQuery specified in searches.
*/
export interface Schema$HistogramQueryResult {
/**
* 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 `-`, for example, `0-1000`, `MIN-0`, and `0-MAX`.
*/
histogram?: {
[key: string]: string;
} | null;
/**
* Requested histogram expression.
*/
histogramQuery?: string | null;
}
/**
* 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.
*/
export interface Schema$Job {
/**
* 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. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500.
*/
addresses?: string[] | null;
/**
* Job application information.
*/
applicationInfo?: Schema$ApplicationInfo;
/**
* 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".
*/
company?: string | null;
/**
* Output only. Display name of the company listing the job.
*/
companyDisplayName?: string | null;
/**
* Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee.
*/
compensationInfo?: Schema$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*`. 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.
*/
customAttributes?: {
[key: string]: Schema$CustomAttribute;
} | null;
/**
* The desired education degrees for the job, such as Bachelors, Masters.
*/
degreeTypes?: string[] | null;
/**
* The department or functional area within the company with the open position. The maximum number of allowed characters is 255.
*/
department?: string | null;
/**
* Output only. Derived details about the job posting.
*/
derivedInfo?: Schema$JobDerivedInfo;
/**
* 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.
*/
description?: string | null;
/**
* The employment type(s) of a job, for example, full time or part time.
*/
employmentTypes?: string[] | null;
/**
* 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.
*/
incentives?: string | null;
/**
* The benefits included with the job.
*/
jobBenefits?: string[] | null;
/**
* The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
*/
jobEndTime?: string | null;
/**
* The experience level associated with the job, such as "Entry Level".
*/
jobLevel?: string | null;
/**
* The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
*/
jobStartTime?: string | null;
/**
* 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](https://tools.ietf.org/html/bcp47){: 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'.
*/
languageCode?: string | null;
/**
* 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". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
*/
name?: string | null;
/**
* Output only. The timestamp when this job posting was created.
*/
postingCreateTime?: string | null;
/**
* 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.
*/
postingExpireTime?: string | null;
/**
* 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.
*/
postingPublishTime?: string | null;
/**
* 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.
*/
postingRegion?: string | null;
/**
* Output only. The timestamp when this job posting was last updated.
*/
postingUpdateTime?: string | null;
/**
* Options for job processing.
*/
processingOptions?: Schema$ProcessingOptions;
/**
* 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.
*/
promotionValue?: number | null;
/**
* 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.
*/
qualifications?: string | null;
/**
* 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.
*/
requisitionId?: string | null;
/**
* 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.
*/
responsibilities?: string | null;
/**
* Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
*/
title?: string | null;
/**
* Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.
*/
visibility?: string | null;
}
/**
* Derived details about the job posting.
*/
export interface Schema$JobDerivedInfo {
/**
* Job categories derived from Job.title and Job.description.
*/
jobCategories?: string[] | null;
/**
* Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.
*/
locations?: Schema$Location[];
}
/**
* An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
*/
export interface Schema$JobEvent {
/**
* 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".
*/
jobs?: string[] | null;
/**
* Required. The type of the event (see JobEventType).
*/
type?: string | null;
}
/**
* The query required to perform a search query.
*/
export interface Schema$JobQuery {
/**
* 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.
*/
commuteFilter?: Schema$CommuteFilter;
/**
* 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". At most 20 company filters are allowed.
*/
companies?: string[] | null;
/**
* This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly. Alternatively, the value being searched for can be wrapped in different match operators. `SUBSTRING_MATCH([value])` The company name must contain a case insensitive substring match of the value. Using this function may increase latency. Sample Value: `SUBSTRING_MATCH(google)` `MULTI_WORD_TOKEN_MATCH([value])` The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency. Sample Value: `MULTI_WORD_TOKEN_MATCH(google)` 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.
*/
companyDisplayNames?: string[] | null;
/**
* 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.
*/
compensationFilter?: Schema$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 < 10000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years \> 10`
*/
customAttributeFilter?: string | null;
/**
* 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.
*/
disableSpellCheck?: boolean | null;
/**
* 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.
*/
employmentTypes?: string[] | null;
/**
* This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed.
*/
excludedJobs?: string[] | null;
/**
* 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.
*/
jobCategories?: string[] | null;
/**
* 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.
*/
languageCodes?: string[] | null;
/**
* 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.
*/
locationFilters?: Schema$LocationFilter[];
/**
* Jobs published within a range specified by this filter are searched against.
*/
publishTimeRange?: Schema$TimestampRange;
/**
* The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.
*/
query?: string | null;
/**
* 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](https://tools.ietf.org/html/bcp47).
*/
queryLanguageCode?: string | null;
}
/**
* Mutation result of a job from a batch operation.
*/
export interface Schema$JobResult {
/**
* 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.
*/
job?: Schema$Job;
/**
* The status of the job processed. This field is populated if the processing of the job fails.
*/
status?: Schema$Status;
}
/**
* An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
*/
export interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number | null;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number | null;
}
/**
* The List companies response object.
*/
export interface Schema$ListCompaniesResponse {
/**
* Companies for the current client.
*/
companies?: Schema$Company[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* List jobs response.
*/
export interface Schema$ListJobsResponse {
/**
* The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.
*/
jobs?: Schema$Job[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* The List tenants response object.
*/
export interface Schema$ListTenantsResponse {
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* Tenants for the current client.
*/
tenants?: Schema$Tenant[];
}
/**
* A resource that represents a location with full geographic information.
*/
export interface Schema$Location {
/**
* An object representing a latitude/longitude pair.
*/
latLng?: Schema$LatLng;
/**
* 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.
*/
locationType?: string | null;
/**
* 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.
*/
postalAddress?: Schema$PostalAddress;
/**
* 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.
*/
radiusMiles?: number | null;
}
/**
* Geographic region of the search.
*/
export interface Schema$LocationFilter {
/**
* The address name, such as "Mountain View" or "Bay Area".
*/
address?: string | null;
/**
* 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.
*/
distanceInMiles?: number | null;
/**
* The latitude and longitude of the geographic center to search from. This field is ignored if `address` is provided.
*/
latLng?: Schema$LatLng;
/**
* CLDR region code of the country/region. This field may be used in two ways: 1) If telecommute preference is not set, this field is used address ambiguity of the user-input address. For example, "Liverpool" may refer to "Liverpool, NY, US" or "Liverpool, UK". This region code biases the address resolution toward a specific country or territory. If this field is not set, address resolution is biased toward the United States by default. 2) If telecommute preference is set to TELECOMMUTE_ALLOWED, the telecommute location filter will be limited to the region specified in this field. If this field is not set, the telecommute job locations will not be See https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
*/
regionCode?: string | null;
/**
* 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, the telecommute status of the jobs is ignored. Jobs that have PostingRegion.TELECOMMUTE and have additional Job.addresses may still be matched based on other location filters using address or latlng. 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.
*/
telecommutePreference?: string | null;
}
/**
* Job entry with metadata inside SearchJobsResponse.
*/
export interface Schema$MatchingJob {
/**
* Commute information which is generated based on specified CommuteFilter.
*/
commuteInfo?: Schema$CommuteInfo;
/**
* Job resource that matches the specified SearchJobsRequest.
*/
job?: Schema$Job;
/**
* A summary of the job with core information that's displayed on the search results listing page.
*/
jobSummary?: string | null;
/**
* Contains snippets of text from the Job.title field most c