googleapis
Version:
Google APIs Client Library for Node.js
909 lines • 107 kB
TypeScript
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace jobs_v3 {
interface Options extends GlobalOptions {
version: 'v3';
}
interface StandardParameters {
/**
* 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
* const {google} = require('googleapis');
* const jobs = google.jobs('v3');
*
* @namespace jobs
* @type {Function}
* @version v3
* @variation v3
* @param {object=} options Options for Jobs
*/
class Jobs {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Application related details of a job posting.
*/
interface Schema$ApplicationInfo {
/**
* Optional but at least one of uris, emails or instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255.
*/
emails?: string[];
/**
* Optional but at least one of uris, emails or instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.
*/
instruction?: string;
/**
* Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.
*/
uris?: string[];
}
/**
* Input only. Batch delete jobs request.
*/
interface Schema$BatchDeleteJobsRequest {
/**
* Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1"
*/
filter?: string;
}
/**
* Represents count of jobs within one bucket.
*/
interface Schema$BucketizedCount {
/**
* Number of jobs whose numeric field value fall into `range`.
*/
count?: number;
/**
* Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range.
*/
range?: Schema$BucketRange;
}
/**
* Represents starting and ending value of a range in double.
*/
interface Schema$BucketRange {
/**
* Starting value of the bucket range.
*/
from?: number;
/**
* Ending value of the bucket range.
*/
to?: number;
}
/**
* An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.
*/
interface Schema$ClientEvent {
/**
* Required. The timestamp of the event.
*/
createTime?: string;
/**
* Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id).
*/
eventId?: string;
/**
* Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB.
*/
extraInfo?: {
[key: string]: string;
};
/**
* A event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
*/
jobEvent?: Schema$JobEvent;
/**
* Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view).
*/
parentEventId?: string;
/**
* Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.
*/
requestId?: string;
}
/**
* Input only. Parameters needed for commute search.
*/
interface Schema$CommuteFilter {
/**
* Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker.
*/
allowImpreciseAddresses?: boolean;
/**
* Required. The method of transportation for which to calculate the commute time.
*/
commuteMethod?: string;
/**
* Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution.
*/
departureTime?: Schema$TimeOfDay;
/**
* Optional. Specifies the traffic density to use when calculating commute time.
*/
roadTraffic?: string;
/**
* Required. The latitude and longitude of the location from which to calculate the commute time.
*/
startCoordinates?: Schema$LatLng;
/**
* Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.
*/
travelDuration?: string;
}
/**
* Output only. Commute details related to this job.
*/
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 is not reachable within the requested duration, but was returned as part of an expanded query.
*/
travelDuration?: string;
}
/**
* 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.
*/
interface Schema$Company {
/**
* Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
*/
careerSiteUri?: string;
/**
* Output only. Derived details about the company.
*/
derivedInfo?: Schema$CompanyDerivedInfo;
/**
* Required. The display name of the company, for example, "Google, LLC".
*/
displayName?: string;
/**
* Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.
*/
eeoText?: string;
/**
* Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
*/
externalId?: string;
/**
* Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.
*/
headquartersAddress?: string;
/**
* Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
*/
hiringAgency?: boolean;
/**
* Optional. A URI that hosts the employer's company logo.
*/
imageUri?: string;
/**
* Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.
*/
keywordSearchableJobCustomAttributes?: string[];
/**
* Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
*/
name?: string;
/**
* Optional. The employer's company size.
*/
size?: string;
/**
* 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;
/**
* Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.
*/
websiteUri?: string;
}
/**
* Derived details about the company.
*/
interface Schema$CompanyDerivedInfo {
/**
* A structured headquarters location of the company, resolved from Company.hq_location 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.
*/
interface Schema$CompensationEntry {
/**
* Optional. Compensation amount.
*/
amount?: Schema$Money;
/**
* Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.
*/
description?: string;
/**
* Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1
*/
expectedUnitsPerYear?: number;
/**
* Optional. Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.
*/
type?: string;
/**
* Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
*/
unit?: string;
}
/**
* Input only. Filter on job compensation type and amount.
*/
interface Schema$CompensationFilter {
/**
* Optional. If set to true, jobs with unspecified compensation range fields are included.
*/
includeJobsWithUnspecifiedCompensationRange?: boolean;
/**
* Optional. Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Required. Type of filter.
*/
type?: string;
/**
* Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.
*/
units?: string[];
}
/**
* Input only. Compensation based histogram request.
*/
interface Schema$CompensationHistogramRequest {
/**
* Required. Numeric histogram options, like buckets, whether include min or max value.
*/
bucketingOption?: Schema$NumericBucketingOption;
/**
* Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`.
*/
type?: string;
}
/**
* Output only. Compensation based histogram result.
*/
interface Schema$CompensationHistogramResult {
/**
* Histogram result.
*/
result?: Schema$NumericBucketingResult;
/**
* Type of the request, corresponding to CompensationHistogramRequest.type.
*/
type?: string;
}
/**
* Job compensation details.
*/
interface Schema$CompensationInfo {
/**
* Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.
*/
annualizedBaseCompensationRange?: Schema$CompensationRange;
/**
* Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.
*/
annualizedTotalCompensationRange?: Schema$CompensationRange;
/**
* Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.
*/
entries?: Schema$CompensationEntry[];
}
/**
* Compensation range.
*/
interface Schema$CompensationRange {
/**
* Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation.
*/
maxCompensation?: Schema$Money;
/**
* Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation.
*/
minCompensation?: Schema$Money;
}
/**
* Output only. Response of auto-complete query.
*/
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;
}
/**
* Output only. Resource that represents completion results.
*/
interface Schema$CompletionResult {
/**
* The URI of the company image for CompletionType.COMPANY_NAME.
*/
imageUri?: string;
/**
* The suggestion for the query.
*/
suggestion?: string;
/**
* The completion topic.
*/
type?: string;
}
/**
* The report event request.
*/
interface Schema$CreateClientEventRequest {
/**
* Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
*/
clientEvent?: Schema$ClientEvent;
}
/**
* Input only. The Request of the CreateCompany method.
*/
interface Schema$CreateCompanyRequest {
/**
* Required. The company to be created.
*/
company?: Schema$Company;
}
/**
* Input only. Create job request.
*/
interface Schema$CreateJobRequest {
/**
* Required. The Job to be created.
*/
job?: Schema$Job;
}
/**
* Custom attribute values that are either filterable or non-filterable.
*/
interface Schema$CustomAttribute {
/**
* Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false.
*/
filterable?: boolean;
/**
* Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.
*/
longValues?: string[];
/**
* Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed.
*/
stringValues?: string[];
}
/**
* Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.
*/
interface Schema$CustomAttributeHistogramRequest {
/**
* Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values.
*/
key?: string;
/**
* Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements.
*/
longValueHistogramBucketingOption?: Schema$NumericBucketingOption;
/**
* Optional. If set to true, the response includes the histogram value for each key as a string.
*/
stringValueHistogram?: boolean;
}
/**
* Output only. Custom attribute histogram result.
*/
interface Schema$CustomAttributeHistogramResult {
/**
* Stores the key of custom attribute the histogram is performed on.
*/
key?: string;
/**
* Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`.
*/
longValueHistogramResult?: Schema$NumericBucketingResult;
/**
* Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result.
*/
stringValueHistogramResult?: {
[key: string]: number;
};
}
/**
* 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.
*/
interface Schema$DeviceInfo {
/**
* Optional. Type of the device.
*/
deviceType?: string;
/**
* Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.
*/
id?: string;
}
/**
* 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); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
/**
* Input only. Histogram facets to be specified in SearchJobsRequest.
*/
interface Schema$HistogramFacets {
/**
* Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.
*/
compensationHistogramFacets?: Schema$CompensationHistogramRequest[];
/**
* Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.
*/
customAttributeHistogramFacets?: Schema$CustomAttributeHistogramRequest[];
/**
* Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.
*/
simpleHistogramFacets?: string[];
}
/**
* Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter.
*/
interface Schema$HistogramResult {
/**
* The Histogram search filters.
*/
searchType?: string;
/**
* A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search.
*/
values?: {
[key: string]: number;
};
}
/**
* Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest.
*/
interface Schema$HistogramResults {
/**
* Specifies compensation field-based histogram results that match HistogramFacets.compensation_histogram_requests.
*/
compensationHistogramResults?: Schema$CompensationHistogramResult[];
/**
* Specifies histogram results for custom attributes that match HistogramFacets.custom_attribute_histogram_facets.
*/
customAttributeHistogramResults?: Schema$CustomAttributeHistogramResult[];
/**
* Specifies histogram results that matches HistogramFacets.simple_histogram_facets.
*/
simpleHistogramResults?: Schema$HistogramResult[];
}
/**
* 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.
*/
interface Schema$Job {
/**
* Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.
*/
addresses?: string[];
/**
* Required. At least one field within ApplicationInfo must be specified. Job application information.
*/
applicationInfo?: Schema$ApplicationInfo;
/**
* Output only. Display name of the company listing the job.
*/
companyDisplayName?: string;
/**
* Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo".
*/
companyName?: string;
/**
* Optional. Job compensation information.
*/
compensationInfo?: Schema$CompensationInfo;
/**
* Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. 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;
};
/**
* Optional. The desired education degrees for the job, such as Bachelors, Masters.
*/
degreeTypes?: string[];
/**
* Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255.
*/
department?: string;
/**
* 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;
/**
* Optional. The employment type(s) of a job, for example, full time or part time.
*/
employmentTypes?: string[];
/**
* Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.
*/
incentives?: string;
/**
* Optional. The benefits included with the job.
*/
jobBenefits?: string[];
/**
* Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
*/
jobEndTime?: string;
/**
* Optional. The experience level associated with the job, such as "Entry Level".
*/
jobLevel?: string;
/**
* Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
*/
jobStartTime?: string;
/**
* Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](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;
/**
* Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
*/
name?: string;
/**
* Output only. The timestamp when this job posting was created.
*/
postingCreateTime?: string;
/**
* Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company_name, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.
*/
postingExpireTime?: string;
/**
* Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.
*/
postingPublishTime?: string;
/**
* Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.
*/
postingRegion?: string;
/**
* Output only. The timestamp when this job posting was last updated.
*/
postingUpdateTime?: string;
/**
* Optional. Options for job processing.
*/
processingOptions?: Schema$ProcessingOptions;
/**
* Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.
*/
promotionValue?: number;
/**
* Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.
*/
qualifications?: string;
/**
* Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255.
*/
requisitionId?: string;
/**
* Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.
*/
responsibilities?: string;
/**
* Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
*/
title?: string;
/**
* Optional. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.
*/
visibility?: string;
}
/**
* Output only. Derived details about the job posting.
*/
interface Schema$JobDerivedInfo {
/**
* Job categories derived from Job.title and Job.description.
*/
jobCategories?: string[];
/**
* 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.
*/
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.
*/
jobs?: string[];
/**
* Required. The type of the event (see JobEventType).
*/
type?: string;
}
/**
* Input only. The query required to perform a search query.
*/
interface Schema$JobQuery {
/**
* Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time.
*/
commuteFilter?: Schema$CommuteFilter;
/**
* Optional. This filter specifies the exact 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.
*/
companyDisplayNames?: string[];
/**
* Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed.
*/
companyNames?: string[];
/**
* Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.
*/
compensationFilter?: Schema$CompensationFilter;
/**
* Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 3000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10`
*/
customAttributeFilter?: string;
/**
* Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed.
*/
disableSpellCheck?: boolean;
/**
* Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.
*/
employmentTypes?: string[];
/**
* Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.
*/
jobCategories?: string[];
/**
* Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.
*/
languageCodes?: string[];
/**
* Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.
*/
locationFilters?: Schema$LocationFilter[];
/**
* Optional. Jobs published within a range specified by this filter are searched against.
*/
publishTimeRange?: Schema$TimestampRange;
/**
* Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.
*/
query?: string;
}
/**
* An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
*/
interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number;
}
/**
* Output only. The List companies response object.
*/
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;
}
/**
* Output only. List jobs response.
*/
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;
}
/**
* Output only. A resource that represents a location with full geographic information.
*/
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 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;
/**
* 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 LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.
*/
radiusInMiles?: number;
}
/**
* Input only. Geographic region of the search.
*/
interface Schema$LocationFilter {
/**
* Optional. The address name, such as "Mountain View" or "Bay Area".
*/
address?: string;
/**
* Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored.
*/
distanceInMiles?: number;
/**
* Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if `address` is provided.
*/
latLng?: Schema$LatLng;
/**
* Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
*/
regionCode?: string;
/**
* Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response.
*/
telecommutePreference?: string;
}
/**
* Output only. Job entry with metadata inside SearchJobsResponse.
*/
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;
/**
* Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.
*/
jobTitleSnippet?: string;
/**
* Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.
*/
searchTextSnippet?: string;
}
/**
* Represents an amount of money with its currency type.
*/
interface Schema$Money {
/**
* The 3-letter currency code defined in ISO 4217.
*/
currencyCode?: string;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string;
}
/**
* Input only. Use this field to specify bucketing option for the histogram search response.
*/
interface Schema$NumericBucketingOption {
/**
* Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four bu