googleapis
Version:
Google APIs Client Library for Node.js
908 lines • 126 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_v2 {
interface Options extends GlobalOptions {
version: 'v2';
}
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('v2');
*
* @namespace jobs
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Jobs
*/
class Jobs {
context: APIRequestContext;
companies: Resource$Companies;
jobs: Resource$Jobs;
v2: Resource$V2;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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 = "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;
}
/**
* Output only. Commute details related to this job.
*/
interface Schema$CommuteInfo {
/**
* Location used as the destination in the commute calculation.
*/
jobLocation?: Schema$JobLocation;
/**
* 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;
}
/**
* Input only. Parameters needed for commute search.
*/
interface Schema$CommutePreference {
/**
* Optional. 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 is not specified, only jobs that include street level addresses will be returned by commute search.
*/
allowNonStreetLevelAddress?: boolean;
/**
* Optional. The departure hour to use to calculate traffic impact. Accepts an integer between 0 and 23, representing the hour in the time zone of the start_location. Must not be present if road_traffic is specified.
*/
departureHourLocal?: number;
/**
* Required. The method of transportation for which to calculate the commute time.
*/
method?: string;
/**
* Optional. Specifies the traffic density to use when calculating commute time. Must not be present if departure_hour_local is specified.
*/
roadTraffic?: string;
/**
* Required. The latitude and longitude of the location from which to calculate the commute time.
*/
startLocation?: Schema$LatLng;
/**
* Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.
*/
travelTime?: string;
}
/**
* A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position.
*/
interface Schema$Company {
/**
* Optional. The URL to employer's career site or careers page on the employer's web site.
*/
careerPageLink?: string;
/**
* Optional. Identifiers external to the application that help to further identify the employer.
*/
companyInfoSources?: Schema$CompanyInfoSource[];
/**
* Optional. The employer's company size.
*/
companySize?: string;
/**
* Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored.
*/
disableLocationOptimization?: boolean;
/**
* Required. The name of the employer to be displayed with the job, for example, "Google, LLC.".
*/
displayName?: string;
/**
* Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided.
*/
distributorBillingCompanyId?: string;
/**
* Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255.
*/
distributorCompanyId?: 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;
/**
* 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. 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 structured_company_hq_location.
*/
hqLocation?: string;
/**
* Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted.
*/
imageUrl?: 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 might not be properly searchable, and those keyword queries need to be surrounded by quotes.
*/
keywordSearchableCustomAttributes?: string[];
/**
* Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes.
*/
keywordSearchableCustomFields?: number[];
/**
* Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
*/
name?: string;
/**
* Output only. A structured headquarters location of the company, resolved from hq_location if possible.
*/
structuredCompanyHqLocation?: Schema$JobLocation;
/**
* 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;
/**
* Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.".
*/
title?: string;
/**
* Optional. The URL representing the company's primary web site or home page, such as, "www.google.com".
*/
website?: string;
}
/**
* A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`.
*/
interface Schema$CompanyInfoSource {
/**
* Optional. The Google's Knowledge Graph value for the employer's company.
*/
freebaseMid?: string;
/**
* Optional. The numeric identifier for the employer's Google+ business page.
*/
gplusId?: string;
/**
* Optional. The numeric identifier for the employer's headquarters on Google Maps, namely, the Google Maps CID (cell id).
*/
mapsCid?: string;
/**
* Optional. A Google identifier that does not match any of the other types.
*/
unknownTypeId?: string;
}
/**
* 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;
/**
* Required. Compensation type.
*/
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. Whether to include jobs whose compensation range is unspecified.
*/
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 {
/**
* Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation.
*/
amount?: Schema$Money;
/**
* 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[];
/**
* Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount.
*/
max?: Schema$Money;
/**
* Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount.
*/
min?: Schema$Money;
/**
* Deprecated. Use entries instead. Optional. Type of job compensation.
*/
type?: string;
}
/**
* 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.
*/
max?: 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.
*/
min?: 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 URL for the company logo if `type=COMPANY_NAME`.
*/
imageUrl?: string;
/**
* The suggestion for the query.
*/
suggestion?: string;
/**
* The completion topic.
*/
type?: string;
}
/**
* Input only. Create job request.
*/
interface Schema$CreateJobRequest {
/**
* Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.
*/
disableStreetAddressResolution?: boolean;
/**
* Required. The Job to be created.
*/
job?: Schema$Job;
/**
* Optional. Options for job processing.
*/
processingOptions?: Schema$JobProcessingOptions;
}
/**
* 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 at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed.
*/
longValue?: string;
/**
* Optional but at least one of string_values or long_value 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 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed.
*/
stringValues?: Schema$StringValues;
}
/**
* Custom attributes histogram request. An error will be 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 will include 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;
};
}
/**
* Resource that represents the custom data not captured by the standard fields.
*/
interface Schema$CustomField {
/**
* Optional. The values of the custom data.
*/
values?: string[];
}
/**
* Input only. Custom field filter of the search.
*/
interface Schema$CustomFieldFilter {
/**
* Required. The query strings for the filter.
*/
queries?: string[];
/**
* Optional. The type of filter. Defaults to FilterType.OR.
*/
type?: string;
}
/**
* Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number;
}
/**
* Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
*/
interface Schema$DeleteJobsByFilterRequest {
/**
* Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.
*/
disableFastProcess?: boolean;
/**
* Required. Restrictions on the scope of the delete request.
*/
filter?: Schema$Filter;
}
/**
* Input only. 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 {
}
/**
* Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount.
*/
interface Schema$ExtendedCompensationFilter {
/**
* Optional. Compensation range.
*/
compensationRange?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Required. Specify desired `base compensation entry's` ExtendedCompensationInfo.CompensationUnit.
*/
compensationUnits?: string[];
/**
* Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If unspecified, jobs are returned regardless of currency.
*/
currency?: string;
/**
* Optional. Whether to include jobs whose compensation range is unspecified.
*/
includeJobWithUnspecifiedCompensationRange?: boolean;
/**
* Required. Type of filter.
*/
type?: string;
}
/**
* Deprecated. Use CompensationInfo. Describes job compensation.
*/
interface Schema$ExtendedCompensationInfo {
/**
* Output only. Annualized base compensation range.
*/
annualizedBaseCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Output only. Indicates annualized base compensation range cannot be derived, due to the job's base compensation entry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.
*/
annualizedBaseCompensationUnspecified?: boolean;
/**
* Output only. Annualized total compensation range.
*/
annualizedTotalCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Output only. Indicates annualized total compensation range cannot be derived, due to the job's all CompensationEntry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.
*/
annualizedTotalCompensationUnspecified?: boolean;
/**
* Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
*/
currency?: string;
/**
* Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.
*/
entries?: Schema$ExtendedCompensationInfoCompensationEntry[];
}
/**
* Deprecated. See CompensationInfo. 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$ExtendedCompensationInfoCompensationEntry {
/**
* Optional. Monetary amount.
*/
amount?: Schema$ExtendedCompensationInfoDecimal;
/**
* Optional. Compensation description.
*/
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?: Schema$ExtendedCompensationInfoDecimal;
/**
* Optional. Compensation range.
*/
range?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Required. Compensation type.
*/
type?: string;
/**
* Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
*/
unit?: string;
/**
* Optional. Indicates compensation amount and range are unset.
*/
unspecified?: boolean;
}
/**
* Deprecated. See CompensationInfo. Compensation range.
*/
interface Schema$ExtendedCompensationInfoCompensationRange {
/**
* Required. Maximum value.
*/
max?: Schema$ExtendedCompensationInfoDecimal;
/**
* Required. Minimum value.
*/
min?: Schema$ExtendedCompensationInfoDecimal;
}
/**
* Deprecated. See CompensationInfo. Decimal number.
*/
interface Schema$ExtendedCompensationInfoDecimal {
/**
* Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. If `units` is positive, `micros` must be positive or zero. If `units` is zero, `micros` can be positive, zero, or negative. If `units` is negative, `micros` must be negative or zero. For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
*/
micros?: number;
/**
* Whole units.
*/
units?: string;
}
/**
* Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted.
*/
interface Schema$Filter {
/**
* Required. The requisition ID (or posting ID) assigned by the client to identify a job. This is intended for client identification and tracking of listings. name takes precedence over this field The maximum number of allowed characters is 225.
*/
requisitionId?: string;
}
/**
* Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method.
*/
interface Schema$GetHistogramRequest {
/**
* Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false.
*/
allowBroadening?: boolean;
/**
* Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram.
*/
filters?: Schema$JobFilters;
/**
* Optional. Query used to search against jobs, such as keyword, location filters, etc.
*/
query?: Schema$JobQuery;
/**
* Meta information, such as `user_id`, collected from the job searcher or other entity conducting a job search, is used to improve the service's search quality. Users determine identifier values, which must be unique and consist.
*/
requestMetadata?: Schema$RequestMetadata;
/**
* Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution.
*/
searchTypes?: string[];
}
/**
* Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method.
*/
interface Schema$GetHistogramResponse {
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* The Histogram results.
*/
results?: Schema$HistogramResult[];
}
/**
* 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. This field is equivalent to GetHistogramRequest.
*/
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 matches HistogramFacets specified in SearchJobsRequest.
*/
interface Schema$HistogramResults {
/**
* Specifies compensation field-based histogram results that matches HistogramFacets.compensation_histogram_requests.
*/
compensationHistogramResults?: Schema$CompensationHistogramResult[];
/**
* Specifies histogram results for custom attributes that matches 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 at least one of application_urls, application_email_list or application_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 is 255.
*/
applicationEmailList?: string[];
/**
* Optional but at least one of application_urls, application_email_list or application_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.
*/
applicationInstruction?: string;
/**
* Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000.
*/
applicationUrls?: string[];
/**
* Optional. The benefits included with the job.
*/
benefits?: string[];
/**
* Output only. The name of the company listing the job.
*/
companyDisplayName?: string;
/**
* Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id.
*/
companyName?: string;
/**
* Deprecated. Use company_display_name instead. Output only. The name of the company listing the job.
*/
companyTitle?: string;
/**
* Optional. Job compensation information.
*/
compensationInfo?: Schema$CompensationInfo;
/**
* Output only. The timestamp when this job was created.
*/
createTime?: string;
/**
* Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. 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 department or functional area within the company with the open position. The maximum number of allowed characters is 255.
*/
department?: string;
/**
* Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.
*/
description?: string;
/**
* Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255.
*/
distributorCompanyId?: string;
/**
* Optional. The desired education level for the job, such as "Bachelors", "Masters", "Doctorate".
*/
educationLevels?: string[];
/**
* Optional. The employment type(s) of a job, for example, full time or part time.
*/
employmentTypes?: string[];
/**
* Optional. The end date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored.
*/
endDate?: Schema$Date;
/**
* 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 requisition_id, company_name and language_code. 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. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. 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 but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. 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.
*/
expireTime?: string;
/**
* Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, 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 date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. 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 removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on 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_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.
*/
expiryDate?: Schema$Date;
/**
* Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown.
*/
extendedCompensationInfo?: Schema$ExtendedCompensationInfo;
/**
* Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned.
*/
filterableCustomFields?: {
[key: string]: Schema$CustomField;
};
/**
* 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;
/**
* Output only. Structured locations of the job, resolved from locations.
*/
jobLocations?: Schema$JobLocation[];
/**
* Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
*/
jobTitle?: 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;
/**
* Optional. The experience level associated with the job, such as "Entry Level".
*/
level?: string;
/**
* Optional but strongly recommended for the best service experience. Location(s) where the emploeyer 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 requisition_id, company_name and language_code 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.
*/
locations?: string[];
/**
* Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". 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;
/**
* 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. The date this job was most recently published in UTC format. The default value is the time the request arrives at the server.
*/
publishDate?: Schema$Date;
/**
* 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;
/**
* Output only. The URL of a web page that displays job details.
*/
referenceUrl?: string;
/**
* Optional. The job Region (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 if an exact location match is not specified. If this field is set, setting job locations to the same location level as this field is strongly recommended.
*/
region?: 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 listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. 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 ta