package google.cloud.talent.v4beta1
Get desktop application:
View/edit binary Protocol Buffers messages
A service that handles application management, including CRUD and enumeration.
Creates a new application entity.
message
application_service.proto:83The Request of the CreateApplication method.
string parent = 1
Required. Resource name of the profile under which the application is created. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
optional application = 2
Required. The application to be created.
Retrieves specified application.
message
application_service.proto:97Request for getting a application by name.
string name = 1
Required. The resource name of the application to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
Updates specified application.
message
application_service.proto:107Request for updating a specified application.
optional application = 1
Required. The application resource to replace the current resource in the system.
optional update_mask = 2
Strongly recommended for the best service experience. If [update_mask][google.cloud.talent.v4beta1.UpdateApplicationRequest.update_mask] is provided, only the specified fields in [application][google.cloud.talent.v4beta1.UpdateApplicationRequest.application] are updated. Otherwise all the fields are updated. A field mask to specify the application fields to be updated. Only top level fields of [Application][google.cloud.talent.v4beta1.Application] are supported.
Deletes specified application.
message
application_service.proto:127Request to delete a application.
string name = 1
Required. The resource name of the application to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
Lists all applications associated with the profile.
message
application_service.proto:137List applications for which the client has ACL visibility.
string parent = 1
Required. Resource name of the profile under which the application is created. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
string page_token = 2
The starting indicator from which to return results.
int32 page_size = 3
The maximum number of applications to be returned, at most 100. Default is 100 if a non-positive number is provided.
message
application_service.proto:155The List applications response object.
repeated applications = 1
Applications for the current client.
string next_page_token = 2
A token to retrieve the next page of results.
optional metadata = 3
Additional information for the API invocation, such as the request tracking id.
A service that handles company management, including CRUD and enumeration.
Creates a new company entity.
message
company_service.proto:92The Request of the CreateCompany method.
string parent = 1
Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".
optional company = 2
Required. The company to be created.
rpc GetCompany (, )
company_service.proto:54Retrieves specified company.
message
company_service.proto:105Request for getting a company by name.
string name = 1
Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar". If tenant id is unspecified, the default tenant is used, for example, "projects/api-test-project/companies/bar".
Updates specified company.
message
company_service.proto:118Request for updating a specified company.
optional company = 1
Required. The company resource to replace the current resource in the system.
optional update_mask = 2
Strongly recommended for the best service experience. If [update_mask][google.cloud.talent.v4beta1.UpdateCompanyRequest.update_mask] is provided, only the specified fields in [company][google.cloud.talent.v4beta1.UpdateCompanyRequest.company] are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of [Company][google.cloud.talent.v4beta1.Company] are supported.
Deletes specified company. Prerequisite: The company has no jobs associated with it.
message
company_service.proto:138Request to delete a company.
string name = 1
Required. The resource name of the company to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used, for example, "projects/foo/companies/bar".
Lists all companies associated with the project.
message
company_service.proto:151List companies for which the client has ACL visibility.
string parent = 1
Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".
string page_token = 2
The starting indicator from which to return results.
int32 page_size = 3
The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.
bool require_open_jobs = 4
Set to true if the companies requested must have open jobs. Defaults to false. If true, at most [page_size][google.cloud.talent.v4beta1.ListCompaniesRequest.page_size] of companies are fetched, among which only those with open jobs are returned.
message
company_service.proto:179The List companies response object.
repeated companies = 1
Companies for the current client.
string next_page_token = 2
A token to retrieve the next page of results.
optional metadata = 3
Additional information for the API invocation, such as the request tracking id.
A service handles auto completion.
Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
message
completion_service.proto:49Auto-complete parameters.
string parent = 1
Required. Resource name of tenant the completion is performed within. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, the default tenant is used, for example, "projects/foo".
string query = 2
Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
repeated string language_codes = 3
The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For [CompletionType.JOB_TITLE][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.JOB_TITLE] type, only open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned. For [CompletionType.COMPANY_NAME][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMPANY_NAME] type, only companies having open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned. For [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED] type, only open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] or companies having open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned. The maximum number of allowed characters is 255.
int32 page_size = 4
Required. Completion result count. The maximum allowed page size is 10.
string company = 5
If provided, restricts completion to specified company. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used, for example, "projects/foo".
CompleteQueryRequest.CompletionScope scope = 6
The scope of the completion. The defaults is [CompletionScope.PUBLIC][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope.PUBLIC].
CompleteQueryRequest.CompletionType type = 7
The completion topic. The default is [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED].
message
completion_service.proto:145Response of auto-complete query.
repeated completion_results = 1
Results of the matching job/company candidates.
optional metadata = 2
Additional information for the API invocation, such as the request tracking id.
A service handles client event report.
Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools.
message
event_service.proto:58The report event request.
string parent = 1
Required. Resource name of the tenant under which the event is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".
optional client_event = 2
Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution.
service JobService
job_service.proto:41A service handles job management, including job CRUD, enumeration and search.
rpc CreateJob (, )
job_service.proto:51Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.
message
job_service.proto:185Create job request.
string parent = 1
Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified a default tenant is created. For example, "projects/foo".
optional job = 2
Required. The Job to be created.
rpc BatchCreateJobs (, )
job_service.proto:63Begins executing a batch create jobs operation.
message
job_service.proto:848Request to create a batch of jobs.
string parent = 1
Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".
repeated jobs = 2
Required. The jobs to be created.
rpc GetJob (, )
job_service.proto:77Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
message
job_service.proto:198Get job request.
string name = 1
Required. The resource name of the job to retrieve. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".
rpc UpdateJob (, )
job_service.proto:88Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.
message
job_service.proto:211Update job request.
optional job = 1
Required. The Job to be updated.
optional update_mask = 2
Strongly recommended for the best service experience. If [update_mask][google.cloud.talent.v4beta1.UpdateJobRequest.update_mask] is provided, only the specified fields in [job][google.cloud.talent.v4beta1.UpdateJobRequest.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][google.cloud.talent.v4beta1.Job] are supported.
rpc BatchUpdateJobs (, )
job_service.proto:100Begins executing a batch update jobs operation.
message
job_service.proto:861Request to update a batch of jobs.
string parent = 1
Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".
repeated jobs = 2
The jobs to be updated.
optional update_mask = 3
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][google.cloud.talent.v4beta1.BatchUpdateJobsRequest.update_mask] is provided, only the specified fields in [Job][google.cloud.talent.v4beta1.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][google.cloud.talent.v4beta1.Job] are supported. If [update_mask][google.cloud.talent.v4beta1.BatchUpdateJobsRequest.update_mask] is provided, The [Job][google.cloud.talent.v4beta1.Job] inside [JobResult][google.cloud.talent.v4beta1.JobOperationResult.JobResult] will only contains fields that is updated, plus the Id of the Job. Otherwise, [Job][google.cloud.talent.v4beta1.Job] will include all fields, which can yield a very large response.
rpc DeleteJob (, )
job_service.proto:116Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
message
job_service.proto:228Delete job request.
string name = 1
Required. The resource name of the job to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".
rpc BatchDeleteJobs (, )
job_service.proto:124Deletes a list of [Job][google.cloud.talent.v4beta1.Job]s by filter.
message
job_service.proto:241Batch delete jobs request.
string parent = 1
Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".
string filter = 2
Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/foo/companies/bar" AND requisitionId = "req-1"
rpc ListJobs (, )
job_service.proto:135Lists jobs by filter.
message
job_service.proto:264List jobs request.
string parent = 1
Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".
string filter = 2
Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` * `status` Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. Sample Query: * companyName = "projects/foo/tenants/bar/companies/baz" * companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1" * companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"
string page_token = 3
The starting point of a query result.
int32 page_size = 4
The maximum number of jobs to be returned per page of results. If [job_view][google.cloud.talent.v4beta1.ListJobsRequest.job_view] is set to [JobView.JOB_VIEW_ID_ONLY][google.cloud.talent.v4beta1.JobView.JOB_VIEW_ID_ONLY], the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
JobView job_view = 5
The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB_VIEW_FULL][google.cloud.talent.v4beta1.JobView.JOB_VIEW_FULL] if no value is specified.
message
job_service.proto:352List jobs response.
repeated jobs = 1
The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.
string next_page_token = 2
A token to retrieve the next page of results.
optional metadata = 3
Additional information for the API invocation, such as the request tracking id.
rpc SearchJobs (, )
job_service.proto:149Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest]. This call constrains the [visibility][google.cloud.talent.v4beta1.Job.visibility] of jobs present in the database, and only returns jobs that the caller has permission to search against.
Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest]. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the [visibility][google.cloud.talent.v4beta1.Job.visibility] of jobs present in the database, and only returns jobs the caller has permission to search against.
A service that handles profile management, including profile CRUD, enumeration and search.
rpc ListProfiles (, )
profile_service.proto:46Lists profiles by filter. The order is unspecified.
message
profile_service.proto:101List profiles request.
string parent = 1
Required. The resource name of the tenant under which the profile is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
string filter = 5
The filter string specifies the profiles to be enumerated. Supported operator: =, AND The field(s) eligible for filtering are: * `externalId` * `groupId` externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error. Sample Query: * externalId = "externalId-1" * groupId = "groupId-1"
string page_token = 2
The token that specifies the current offset (that is, starting result). Please set the value to [ListProfilesResponse.next_page_token][google.cloud.talent.v4beta1.ListProfilesResponse.next_page_token] to continue the list.
int32 page_size = 3
The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified.
optional read_mask = 4
A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset. Valid values are: * name
message
profile_service.proto:150The List profiles response object.
repeated profiles = 1
Profiles for the specific tenant.
string next_page_token = 2
A token to retrieve the next page of results. This is empty if there are no more results.
Creates and returns a new profile.
message
profile_service.proto:160Create profile request.
string parent = 1
Required. The name of the tenant this profile belongs to. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
optional profile = 2
Required. The profile to be created.
rpc GetProfile (, )
profile_service.proto:61Gets the specified profile.
message
profile_service.proto:172Get profile request.
string name = 1
Required. Resource name of the profile to get. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
Updates the specified profile and returns the updated result.
message
profile_service.proto:182Update profile request
optional profile = 1
Required. Profile to be updated.
optional update_mask = 2
A field mask to specify the profile fields to update. A full update is performed if it is unset. Valid values are: * external_id * source * source_types * uri * is_hirable * create_time * update_time * candidate_update_time * resume_update_time * resume * person_names * addresses * email_addresses * phone_numbers * personal_uris * additional_contact_info * employment_records * education_records * skills * activities * publications * patents * certifications * recruiting_notes * custom_attributes * group_id * external_system * source_note * primary_responsibilities * citizenships * work_authorizations * employee_types * language_code * qualification_summary * allowed_contact_types * preferred_contact_types * contact_availability * language_fluencies * work_preference * industry_experiences * work_environment_experiences * work_availability * security_clearances * references * assessments * interviews
Deletes the specified profile. Prerequisite: The profile has no associated applications or assignments associated.
message
profile_service.proto:242Delete profile request.
string name = 1
Required. Resource name of the profile to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
Searches for profiles within a tenant. For example, search by raw queries "software engineer in Mountain View" or search by structured filters (location filter, education filter, etc.). See [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest] for more information.
message
profile_service.proto:252The request body of the `SearchProfiles` call.
string parent = 1
Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
optional request_metadata = 2
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
optional profile_query = 3
Search query to execute. See [ProfileQuery][google.cloud.talent.v4beta1.ProfileQuery] for more details.
int32 page_size = 4
A limit on the number of profiles returned in the search results. A value above the default value 10 can increase search response time. The maximum value allowed is 100. Otherwise an error is thrown.
string page_token = 5
The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a [nextPageToken][google.cloud.talent.v4beta1.SearchProfilesResponse.next_page_token] field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.
int32 offset = 6
An integer that specifies the current offset (that is, starting result) in search results. This field is only considered if [page_token][google.cloud.talent.v4beta1.SearchProfilesRequest.page_token] is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to search from the first profile, and 10 means to search from the 11th profile. This can be used for pagination, for example pageSize = 10 and offset = 10 means to search from the second page.
bool disable_spell_check = 7
This flag controls the spell-check feature. If `false`, the service attempts to correct a misspelled query. For example, "enginee" is corrected to "engineer".
string order_by = 8
The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are: * "relevance desc": By descending relevance, as determined by the API algorithms. * "update_date desc": Sort by [Profile.update_time][google.cloud.talent.v4beta1.Profile.update_time] in descending order (recently updated profiles first). * "create_date desc": Sort by [Profile.create_time][google.cloud.talent.v4beta1.Profile.create_time] in descending order (recently created profiles first). * "first_name": Sort by [PersonName.PersonStructuredName.given_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name] in ascending order. * "first_name desc": Sort by [PersonName.PersonStructuredName.given_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name] in descending order. * "last_name": Sort by [PersonName.PersonStructuredName.family_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name] in ascending order. * "last_name desc": Sort by [PersonName.PersonStructuredName.family_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name] in ascending order.
bool case_sensitive_sort = 9
When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false).
repeated histogram_queries = 10
A list of expressions specifies histogram requests against matching profiles for [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest]. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types: * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]) Bucket build-in function creates a bucket with range of [start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets: * admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC". * locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York". * extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY". * postal_code: Postal code of profile which follows locale code. * country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB. * job_title: Normalized job titles specified in EmploymentHistory. * company_name: Normalized company name of profiles to match on. * institution: The school name. For example, "MIT", "University of California, Berkeley" * degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree. * experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive). * application_date: The application date specifies application start dates. See [ApplicationDateFilter][google.cloud.talent.v4beta1.ApplicationDateFilter] for more details. * application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See [ApplicationOutcomeNotesFilter][google.cloud.talent.v4beta1.ApplicationOutcomeNotesFilter] for more details. * application_job_title: The application job title specifies the job applied for in the application. See [ApplicationJobFilter][google.cloud.talent.v4beta1.ApplicationJobFilter] for more details. * hirable_status: Hirable status specifies the profile's hirable status. * string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"]. * numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions: * count(admin1) * count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")]) * count(string_custom_attribute["assigned_recruiter"]) * count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
string result_set_id = 12
An id that uniquely identifies the result set of a [SearchProfiles][google.cloud.talent.v4beta1.ProfileService.SearchProfiles] call. The id should be retrieved from the [SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProfilesResponse] message returned from a previous invocation of [SearchProfiles][google.cloud.talent.v4beta1.ProfileService.SearchProfiles]. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the [profile_query][google.cloud.talent.v4beta1.SearchProfilesRequest.profile_query]. A new [result_set_id][google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id] is returned as a handle to access this result set. If this field is set, the service will ignore the resource and [profile_query][google.cloud.talent.v4beta1.SearchProfilesRequest.profile_query] values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of [page_token][google.cloud.talent.v4beta1.SearchProfilesRequest.page_token] or [offset][google.cloud.talent.v4beta1.SearchProfilesRequest.offset] must be set. A typical use case is to invoke [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest] without this field, then use the resulting [result_set_id][google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id] in [SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProfilesResponse] to page through the results.
bool strict_keywords_search = 13
This flag is used to indicate whether the service will attempt to understand synonyms and terms related to the search query or treat the query "as is" when it generates a set of results. By default this flag is set to false, thus allowing expanded results to also be returned. For example a search for "software engineer" might also return candidates who have experience in jobs similar to software engineer positions. By setting this flag to true, the service will only attempt to deliver candidates has software engineer in his/her global fields by treating "software engineer" as a keyword. It is recommended to provide a feature in the UI (such as a checkbox) to allow recruiters to set this flag to true if they intend to search for longer boolean strings.
message
profile_service.proto:469Response of SearchProfiles method.
int64 estimated_total_size = 1
An estimation of the number of profiles that match the specified query. This number isn't guaranteed to be accurate.
optional spell_correction = 2
The spell checking result, and correction.
optional metadata = 3
Additional information for the API invocation, such as the request tracking id.
string next_page_token = 4
A token to retrieve the next page of results. This is empty if there are no more results.
repeated histogram_query_results = 5
The histogram results that match with specified [SearchProfilesRequest.histogram_queries][google.cloud.talent.v4beta1.SearchProfilesRequest.histogram_queries].
repeated summarized_profiles = 6
The profile entities that match the specified [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest].
string result_set_id = 7
An id that uniquely identifies the result set of a [SearchProfiles][google.cloud.talent.v4beta1.ProfileService.SearchProfiles] call for consistent results.
A service that handles tenant management, including CRUD and enumeration.
rpc CreateTenant (, )
tenant_service.proto:42Creates a new tenant entity.
message
tenant_service.proto:80The Request of the CreateTenant method.
string parent = 1
Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo".
optional tenant = 2
Required. The tenant to be created.
rpc GetTenant (, )
tenant_service.proto:50Retrieves specified tenant.
message
tenant_service.proto:92Request for getting a tenant by name.
string name = 1
Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
rpc UpdateTenant (, )
tenant_service.proto:57Updates specified tenant.
message
tenant_service.proto:101Request for updating a specified tenant.
optional tenant = 1
Required. The tenant resource to replace the current resource in the system.
optional update_mask = 2
Strongly recommended for the best service experience. If [update_mask][google.cloud.talent.v4beta1.UpdateTenantRequest.update_mask] is provided, only the specified fields in [tenant][google.cloud.talent.v4beta1.UpdateTenantRequest.tenant] are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of [Tenant][google.cloud.talent.v4beta1.Tenant] are supported.
rpc DeleteTenant (, )
tenant_service.proto:65Deletes specified tenant.
message
tenant_service.proto:121Request to delete a tenant.
string name = 1
Required. The resource name of the tenant to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
rpc ListTenants (, )
tenant_service.proto:72Lists all tenants associated with the project.
message
tenant_service.proto:130List tenants for which the client has ACL visibility.
string parent = 1
Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo".
string page_token = 2
The starting indicator from which to return results.
int32 page_size = 3
The maximum number of tenants to be returned, at most 100. Default is 100 if a non-positive number is provided.
message
tenant_service.proto:146The List tenants response object.
repeated tenants = 1
Tenants for the current client.
string next_page_token = 2
A token to retrieve the next page of results.
optional metadata = 3
Additional information for the API invocation, such as the request tracking id.
message
profile.proto:699Resource that represents an individual or collaborative activity participated in by a candidate, for example, an open-source project, a class assignment, and so on.
Used in:
string display_name = 1
Activity display name. Number of characters allowed is 100.
string description = 2
Activity description. Number of characters allowed is 100,000.
string uri = 3
Activity URI. Number of characters allowed is 4,000.
optional create_date = 4
The first creation date of the activity.
optional update_date = 5
The last update date of the activity.
repeated string team_members = 6
A list of team members involved in this activity. Number of characters allowed is 100. The limitation for max number of team members is 50.
repeated skills_used = 7
A list of skills used in this activity. The limitation for max number of skills used is 50.
string activity_name_snippet = 8
Output only. Activity name snippet shows how the [display_name][google.cloud.talent.v4beta1.Activity.display_name] is related to a search query. It's empty if the [display_name][google.cloud.talent.v4beta1.Activity.display_name] isn't related to the search query.
string activity_description_snippet = 9
Output only. Activity description snippet shows how the [description][google.cloud.talent.v4beta1.Activity.description] is related to a search query. It's empty if the [description][google.cloud.talent.v4beta1.Activity.description] isn't related to the search query.
repeated string skills_used_snippet = 10
Output only. Skill used snippet shows how the corresponding [skills_used][google.cloud.talent.v4beta1.Activity.skills_used] are related to a search query. It's empty if the corresponding [skills_used][google.cloud.talent.v4beta1.Activity.skills_used] are not related to the search query.
message
profile.proto:530Resource that represents contact information other than phone, email, URI and addresses.
Used in:
ContactInfoUsage usage = 1
The usage of this contact method. For example, SCHOOL, WORK, PERSONAL.
string name = 2
The name of the contact method. For example, "hangout", "skype". Number of characters allowed is 100.
string contact_id = 3
The contact id. Number of characters allowed is 100.
message
profile.proto:419Resource that represents a address.
Used in: , ,
ContactInfoUsage usage = 1
The usage of the address. For example, SCHOOL, WORK, PERSONAL.
oneof address
The address of a person. It can be one of [unstructured_address][google.cloud.talent.v4beta1.Address.unstructured_address] or [structured_address][google.cloud.talent.v4beta1.Address.structured_address].
string unstructured_address = 2
Unstructured address. For example, "1600 Amphitheatre Pkwy, Mountain View, CA 94043", "Sunnyvale, California". Number of characters allowed is 100.
structured_address = 3
Structured address that contains street address, city, state, country, and so on.
optional current = 4
Indicates if it's the person's current address.
message
application.proto:34Resource that represents a job application record of a candidate.
Used as response type in: ApplicationService.CreateApplication, ApplicationService.GetApplication, ApplicationService.UpdateApplication
Used as field type in: , ,
string name = 1
Required during application update. Resource name assigned to an application by the API. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
string external_id = 31
Required. Client side application identifier, used to uniquely identify the application. The maximum number of allowed characters is 255.
string profile = 2
Output only. Resource name of the candidate of this application. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
string job = 4
One of either a job or a company is required. Resource name of the job which the candidate applied for. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".
string company = 5
One of either a job or a company is required. Resource name of the company which the candidate applied for. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz".
optional application_date = 7
The application date.
Application.ApplicationStage stage = 11
Required. What is the most recent stage of the application (that is, new, screen, send cv, hired, finished work)? This field is intentionally not comprehensive of every possible status, but instead, represents statuses that would be used to indicate to the ML models good / bad matches.
Application.ApplicationState state = 13
The application state.
repeated interviews = 16
All interviews (screen, onsite, and so on) conducted as part of this application (includes details such as user conducting the interview, timestamp, feedback, and so on).
optional referral = 18
If the candidate is referred by a employee.
optional create_time = 19
Required. Reflects the time that the application was created.
optional update_time = 20
The last update timestamp.
string outcome_notes = 21
Free text reason behind the recruitement outcome (for example, reason for withdraw / reject, reason for an unsuccessful finish, and so on). Number of characters allowed is 100.
Outcome outcome = 22
Outcome positiveness shows how positive the outcome is.
optional is_match = 28
Output only. Indicates whether this job application is a match to application related filters. This value is only applicable in profile search response.
string job_title_snippet = 29
Output only. Job title snippet shows how the job title is related to a search query. It's empty if the job title isn't related to the search query.
The stage of the application.
Used in:
APPLICATION_STAGE_UNSPECIFIED = 0
Default value.
NEW = 1
Candidate has applied or a recruiter put candidate into consideration but candidate is not yet screened / no decision has been made to move or not move the candidate to the next stage.
SCREEN = 2
A recruiter decided to screen the candidate for this role.
HIRING_MANAGER_REVIEW = 3
Candidate is being / was sent to the customer / hiring manager for detailed review.
INTERVIEW = 4
Candidate was approved by the client / hiring manager and is being / was interviewed for the role.
OFFER_EXTENDED = 5
Candidate will be / has been given an offer of employment.
OFFER_ACCEPTED = 6
Candidate has accepted their offer of employment.
STARTED = 7
Candidate has begun (or completed) their employment or assignment with the employer.
Enum that represents the application status.
Used in:
APPLICATION_STATE_UNSPECIFIED = 0
Default value.
IN_PROGRESS = 1
The current stage is in progress or pending, for example, interviews in progress.
CANDIDATE_WITHDREW = 2
The current stage was terminated by a candidate decision.
EMPLOYER_WITHDREW = 3
The current stage was terminated by an employer or agency decision.
COMPLETED = 4
The current stage is successfully completed, but the next stage (if applicable) has not begun.
CLOSED = 5
The current stage was closed without an exception, or terminated for reasons unrealated to the candidate.
message
filters.proto:758Application Date Range Filter. The API matches profiles with [Application.application_date][google.cloud.talent.v4beta1.Application.application_date] between start date and end date (both boundaries are inclusive). The filter is ignored if both [start_date][google.cloud.talent.v4beta1.ApplicationDateFilter.start_date] and [end_date][google.cloud.talent.v4beta1.ApplicationDateFilter.end_date] are missing.
Used in:
optional start_date = 1
Start date. If it's missing, The API matches profiles with application date not after the end date.
optional end_date = 2
End date. If it's missing, The API matches profiles with application date not before the start date.
message
filters.proto:783Filter on the job information of Application.
Used in:
string job_requisition_id = 2
The job requisition id in the application. The API does an exact match on the [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] of [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles.
string job_title = 3
The job title in the application. The API does an exact match on the [Job.title][google.cloud.talent.v4beta1.Job.title] of [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles.
bool negated = 4
If true, the API excludes all profiles with any [Application.job][google.cloud.talent.v4beta1.Application.job] matching the filters.
message
filters.proto:769Outcome Notes Filter.
Used in:
string outcome_notes = 1
Required. User entered or selected outcome reason. The API does an exact match on the [Application.outcome_notes][google.cloud.talent.v4beta1.Application.outcome_notes] in profiles.
bool negated = 2
If true, The API excludes all candidates with any [Application.outcome_notes][google.cloud.talent.v4beta1.Application.outcome_notes] matching the outcome reason specified in the filter.
message
filters.proto:843Filter on availability signals.
Used in:
AvailabilitySignalType signal_type = 1
Required. Type of signal to apply filter on.
optional range = 2
Required. Range of times to filter candidate signals by.
bool required = 3
If multiple [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter] are provided, the default behavior is to OR all filters, but if this field is set to true, this particular [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter] will be AND'ed against other [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter].
message
profile.proto:293Candidate availability signal.
Used in:
AvailabilitySignalType type = 1
Type of signal.
optional last_update_time = 2
Timestamp of when the given availability activity last happened.
optional filter_satisfied = 3
Indicates if the [last_update_time][google.cloud.talent.v4beta1.AvailabilitySignal.last_update_time] is within [AvailabilityFilter.range][google.cloud.talent.v4beta1.AvailabilityFilter.range]. Returned only in a search response when there is an [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter] in [ProfileQuery.availability_filters][google.cloud.talent.v4beta1.ProfileQuery.availability_filters] where [signal_type][google.cloud.talent.v4beta1.AvailabilityFilter.signal_type] matches [type][google.cloud.talent.v4beta1.AvailabilitySignal.type].
The type of candidate availability signal.
Used in: ,
AVAILABILITY_SIGNAL_TYPE_UNSPECIFIED = 0
Default value.
JOB_APPLICATION = 1
Job application signal. In the context of [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals], this signal is related to the candidate's most recent application. [last_update_time][Profile.availability_signals.last_update_time] is calculated from max([Application.create_time][google.cloud.talent.v4beta1.Application.create_time]) from all [Application][google.cloud.talent.v4beta1.Application] records where [Application.source][google.cloud.talent.v4beta1.Application.source] is any of the following: [APPLY_DIRECT_WEB][google.cloud.talent.v4beta1.Application.ApplicationSource.APPLY_DIRECT_WEB] [APPLY_DIRECT_MOBILE_WEB][google.cloud.talent.v4beta1.Application.ApplicationSource.APPLY_DIRECT_MOBILE_WEB] [APPLY_DIRECT_MOBILE_APP][google.cloud.talent.v4beta1.Application.ApplicationSource.APPLY_DIRECT_MOBILE_APP] [APPLY_DIRECT_IN_PERSON][google.cloud.talent.v4beta1.Application.ApplicationSource.APPLY_DIRECT_IN_PERSON] [APPLY_INDIRECT][google.cloud.talent.v4beta1.Application.ApplicationSource.APPLY_INDIRECT] In the context of [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the filter is applied on [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals] where [type][Profile.availability_signals.type] is JOB_APPLICATION.
RESUME_UPDATE = 2
Resume update signal. In the context of [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals], this signal is related to the candidate’s most recent update to their resume. For a [SummarizedProfile.summary][google.cloud.talent.v4beta1.SummarizedProfile.summary], [last_update_time][Profile.availability_signals.last_update_time] is calculated from max([Profile.resume_update_time][google.cloud.talent.v4beta1.Profile.resume_update_time]) from all [SummarizedProfile.profiles][google.cloud.talent.v4beta1.SummarizedProfile.profiles]. In the context of [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the filter is applied on [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals] where [type][Profile.availability_signals.type] is RESUME_UPDATE.
CANDIDATE_UPDATE = 3
Candidate update signal. In the context of [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals], this signal is related to the candidate’s most recent update to their profile. For a [SummarizedProfile.summary][google.cloud.talent.v4beta1.SummarizedProfile.summary], [last_update_time][Profile.availability_signals.last_update_time] is calculated from max([Profile.candidate_update_time][google.cloud.talent.v4beta1.Profile.candidate_update_time]) from all [SummarizedProfile.profiles][google.cloud.talent.v4beta1.SummarizedProfile.profiles]. In the context of [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the filter is applied on [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals] where [type][Profile.availability_signals.type] is CANDIDATE_UPDATE.
CLIENT_SUBMISSION = 4
Client submission signal. In the context of [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals], this signal is related to the candidate’s most recent submission. [last_update_time][Profile.availability_signals.last_update_time] is calculated from max([Application.create_time][google.cloud.talent.v4beta1.Application.create_time]) from all [Application][google.cloud.talent.v4beta1.Application] records where [Application.stage][google.cloud.talent.v4beta1.Application.stage] is any of the following: [HIRING_MANAGER_REVIEW][google.cloud.talent.v4beta1.Application.ApplicationStage.HIRING_MANAGER_REVIEW] [INTERVIEW][google.cloud.talent.v4beta1.Application.ApplicationStage.INTERVIEW] [OFFER_EXTENDED][google.cloud.talent.v4beta1.Application.ApplicationStage.OFFER_EXTENDED] [OFFER_ACCEPTED][google.cloud.talent.v4beta1.Application.ApplicationStage.OFFER_ACCEPTED] [STARTED][google.cloud.talent.v4beta1.Application.ApplicationStage.STARTED] In the context of [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the filter is applied on [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals] where [type][Profile.availability_signals.type] is CLIENT_SUBMISSION.
message
common.proto:960Metadata used for long running operations returned by CTS batch APIs. It's used to replace [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].
BatchOperationMetadata.State state = 1
The state of a long running operation.
string state_description = 2
More detailed information about operation state.
int32 success_count = 3
Count of successful item(s) inside an operation.
int32 failure_count = 4
Count of failed item(s) inside an operation.
int32 total_count = 5
Count of total item(s) inside an operation.
optional create_time = 6
The time when the batch operation is created.
optional update_time = 7
The time when the batch operation status is updated. The metadata and the [update_time][google.cloud.talent.v4beta1.BatchOperationMetadata.update_time] is refreshed every minute otherwise cached data is returned.
optional end_time = 8
The time when the batch operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to `true`.
Used in:
STATE_UNSPECIFIED = 0
Default value.
INITIALIZING = 1
The batch operation is being prepared for processing.
PROCESSING = 2
The batch operation is actively being processed.
SUCCEEDED = 3
The batch operation is processed, and at least one item has been successfully processed.
FAILED = 4
The batch operation is done and no item has been successfully processed.
CANCELLING = 5
The batch operation is in the process of cancelling after [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called.
CANCELLED = 6
The batch operation is done after [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called. Any items processed before cancelling are returned in the response.
message
filters.proto:834Deprecated. Use AvailabilityFilter instead. Filter on availability signals.
Used in:
bool negated = 1
It is false by default. If true, API excludes all the potential available profiles.
message
common.proto:879Resource that represents a license or certification.
Used in:
string display_name = 1
Name of license or certification. Number of characters allowed is 100.
optional acquire_date = 2
Acquisition date or effective date of license or certification.
optional expire_date = 3
Expiration date of license of certification.
string authority = 4
Authority of license, such as government. Number of characters allowed is 100.
string description = 5
Description of license or certification. Number of characters allowed is 100,000.
message
event.proto:35An 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.
Used as response type in: EventService.CreateClientEvent
Used as field type in:
string request_id = 1
Strongly recommended for the best service experience. A unique ID generated in the API responses. It can be found in [ResponseMetadata.request_id][google.cloud.talent.v4beta1.ResponseMetadata.request_id].
string event_id = 2
Required. A unique identifier, generated by the client application.
optional create_time = 4
Required. The timestamp of the event.
oneof event
Required. The detail information of a specific event type.
job_event = 5
An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
profile_event = 6
An event issued when a profile searcher interacts with the application that implements Cloud Talent Solution.
string event_notes = 9
Notes about the event provided by recruiters or other users, for example, feedback on why a profile was bookmarked.
message
filters.proto:609Parameters needed for commute search.
Used in:
CommuteMethod commute_method = 1
Required. The method of transportation to calculate the commute time for.
optional start_coordinates = 2
Required. The latitude and longitude of the location to calculate the commute time from.
optional travel_duration = 3
Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.
bool allow_imprecise_addresses = 4
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.
oneof traffic_option
Traffic factor to take into account while searching by commute.
CommuteFilter.RoadTraffic road_traffic = 5
Specifies the traffic density to use when calculating commute time.
departure_time = 6
The departure time used to calculate traffic impact, represented as [google.type.TimeOfDay][google.type.TimeOfDay] in local time zone. Currently traffic model is restricted to hour level resolution.
The traffic density to use when calculating commute time.
Used in:
ROAD_TRAFFIC_UNSPECIFIED = 0
Road traffic situation isn't specified.
TRAFFIC_FREE = 1
Optimal commute time without considering any traffic impact.
BUSY_HOUR = 2
Commute time calculation takes in account the peak traffic impact.
Method for commute.
Used in:
COMMUTE_METHOD_UNSPECIFIED = 0
Commute method isn't specified.
DRIVING = 1
Commute time is calculated based on driving time.
TRANSIT = 2
Commute time is calculated based on public transit including bus, metro, subway, and so on.
WALKING = 3
Commute time is calculated based on walking time.
CYCLING = 4
Commute time is calculated based on biking time.
message
company.proto:33A 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.
Used as response type in: CompanyService.CreateCompany, CompanyService.GetCompany, CompanyService.UpdateCompany
Used as field type in: , ,
string name = 1
Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".
string display_name = 2
Required. The display name of the company, for example, "Google LLC".
string external_id = 3
Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
CompanySize size = 4
The employer's company size.
string headquarters_address = 5
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][google.cloud.talent.v4beta1.Company.DerivedInfo.headquarters_location].
bool hiring_agency = 6
Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
string eeo_text = 7
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.
string website_uri = 8
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.
string career_site_uri = 9
The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
string image_uri = 10
A URI that hosts the employer's company logo.
repeated string keyword_searchable_job_custom_attributes = 11
A list of keys of filterable [Job.custom_attributes][google.cloud.talent.v4beta1.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.
optional derived_info = 12
Output only. Derived details about the company.
bool suspended = 13
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.
message
company.proto:35Derived details about the company.
Used in:
optional headquarters_location = 1
A structured headquarters location of the company, resolved from [Company.headquarters_address][google.cloud.talent.v4beta1.Company.headquarters_address] if provided.
An enum that represents the size of the company.
Used in:
COMPANY_SIZE_UNSPECIFIED = 0
Default value if the size isn't specified.
MINI = 1
The company has less than 50 employees.
SMALL = 2
The company has between 50 and 99 employees.
SMEDIUM = 3
The company has between 100 and 499 employees.
MEDIUM = 4
The company has between 500 and 999 employees.
BIG = 5
The company has between 1,000 and 4,999 employees.
BIGGER = 6
The company has between 5,000 and 9,999 employees.
GIANT = 7
The company has 10,000 or more employees.
message
filters.proto:545Filter on job compensation type and amount.
Used in:
CompensationFilter.FilterType type = 1
Required. Type of filter.
repeated CompensationInfo.CompensationUnit units = 2
Required. Specify desired `base compensation entry's` [CompensationInfo.CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit].
optional range = 3
Compensation range.
bool include_jobs_with_unspecified_compensation_range = 4
If set to true, jobs with unspecified compensation range fields are included.
Specify the type of filtering.
Used in:
FILTER_TYPE_UNSPECIFIED = 0
Filter type unspecified. Position holder, INVALID, should never be used.
UNIT_ONLY = 1
Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided [units][google.cloud.talent.v4beta1.CompensationFilter.units]. Populate one or more [units][google.cloud.talent.v4beta1.CompensationFilter.units]. See [CompensationInfo.CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for definition of base compensation entry.
UNIT_AND_AMOUNT = 2
Filter by `base compensation entry's` unit and amount / range. A job is a match if and only if the job contains a base CompensationEntry, and the base entry's unit matches provided [CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit] and amount or range overlaps with provided [CompensationRange][google.cloud.talent.v4beta1.CompensationInfo.CompensationRange]. See [CompensationInfo.CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for definition of base compensation entry. Set exactly one [units][google.cloud.talent.v4beta1.CompensationFilter.units] and populate [range][google.cloud.talent.v4beta1.CompensationFilter.range].
ANNUALIZED_BASE_AMOUNT = 3
Filter by annualized base compensation amount and `base compensation entry's` unit. Populate [range][google.cloud.talent.v4beta1.CompensationFilter.range] and zero or more [units][google.cloud.talent.v4beta1.CompensationFilter.units].
ANNUALIZED_TOTAL_AMOUNT = 4
Filter by annualized total compensation amount and `base compensation entry's` unit . Populate [range][google.cloud.talent.v4beta1.CompensationFilter.range] and zero or more [units][google.cloud.talent.v4beta1.CompensationFilter.units].
message
common.proto:689Job compensation details.
Used in:
repeated entries = 1
Job compensation information. At most one entry can be of type [CompensationInfo.CompensationType.BASE][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.BASE], which is referred as **base compensation entry** for the job.
optional annualized_base_compensation_range = 2
Output only. Annualized base compensation range. Computed as base compensation entry's [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] times [CompensationEntry.expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year]. See [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
optional annualized_total_compensation_range = 3
Output only. Annualized total compensation range. Computed as all compensation entries' [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] times [CompensationEntry.expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year]. See [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
message
common.proto:706A 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][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]. - and its [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year] is set or can be derived. Its annualized range is determined as ([amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]) times [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].
Used in:
CompensationType type = 1
Compensation type. Default is [CompensationType.COMPENSATION_TYPE_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.COMPENSATION_TYPE_UNSPECIFIED].
CompensationUnit unit = 2
Frequency of the specified amount. Default is [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED].
oneof compensation_amount
Compensation amount. It could be a fixed amount or a floating range.
amount = 3
Compensation amount.
range = 4
Compensation range.
string description = 5
Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.
optional expected_units_per_year = 6
Expected number of units paid each year. If not specified, when [Job.employment_types][google.cloud.talent.v4beta1.Job.employment_types] is FULLTIME, a default value is inferred based on [unit][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.unit]. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1
message
common.proto:747Compensation range.
Used in: , ,
optional max_compensation = 2
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][google.type.Money.currency_code] of min_compensation.
optional min_compensation = 1
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][google.type.Money.currency_code] of max_compensation.
The type of compensation. For compensation amounts specified in non-monetary amounts, describe the compensation scheme in the [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description]. For example, tipping format is described in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] (for example, "expect 15-20% tips based on customer bill.") and an estimate of the tips provided in [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range] ($10 per hour). For example, equity is described in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and value estimated in [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]. If no value estimate is possible, units are [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED] and then further clarified in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] field.
Used in:
COMPENSATION_TYPE_UNSPECIFIED = 0
Default value.
BASE = 1
Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.
BONUS = 2
Bonus.
SIGNING_BONUS = 3
Signing bonus.
EQUITY = 4
Equity.
PROFIT_SHARING = 5
Profit sharing.
COMMISSIONS = 6
Commission.
TIPS = 7
Tips.
OTHER_COMPENSATION_TYPE = 8
Other compensation type.
Pay frequency.
Used in: ,
COMPENSATION_UNIT_UNSPECIFIED = 0
Default value.
HOURLY = 1
Hourly.
DAILY = 2
Daily.
WEEKLY = 3
Weekly
MONTHLY = 4
Monthly.
YEARLY = 5
Yearly.
ONE_TIME = 6
One time.
OTHER_COMPENSATION_UNIT = 7
Other compensation units.
Enum to specify the scope of completion.
Used in:
COMPLETION_SCOPE_UNSPECIFIED = 0
Default value.
TENANT = 1
Suggestions are based only on the data provided by the client.
PUBLIC = 2
Suggestions are based on all jobs data in the system that's visible to the client
Enum to specify auto-completion topics.
Used in: ,
COMPLETION_TYPE_UNSPECIFIED = 0
Default value.
JOB_TITLE = 1
Only suggest job titles.
COMPANY_NAME = 2
Only suggest company names.
COMBINED = 3
Suggest both job titles and company names.
message
completion_service.proto:147Resource that represents completion results.
Used in:
string suggestion = 1
The suggestion for the query.
CompleteQueryRequest.CompletionType type = 2
The completion topic.
string image_uri = 3
The URI of the company image for [COMPANY_NAME][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMPANY_NAME].
Enum that represents the usage of the contact information.
Used in: , , ,
CONTACT_INFO_USAGE_UNSPECIFIED = 0
Default value.
PERSONAL = 1
Personal use.
WORK = 2
Work use.
SCHOOL = 3
School use.
message
common.proto:634Custom attribute values that are either filterable or non-filterable.
Used in: ,
repeated string string_values = 1
Exactly one of [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4beta1.CustomAttribute.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.
repeated int64 long_values = 2
Exactly one of [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4beta1.CustomAttribute.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][google.cloud.talent.v4beta1.CustomAttribute.long_values] is supported.
bool filterable = 3
If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false.
message
profile.proto:677Resource that represents a degree pursuing or acquired by a candidate.
Used in:
DegreeType degree_type = 1
ISCED degree type.
string degree_name = 2
Full Degree name. For example, "B.S.", "Master of Arts", and so on. Number of characters allowed is 100.
repeated string fields_of_study = 3
Fields of study for the degree. For example, "Computer science", "engineering". Number of characters allowed is 100.
Educational degree level defined in International Standard Classification of Education (ISCED).
Used in: , ,
DEGREE_TYPE_UNSPECIFIED = 0
Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten
PRIMARY_EDUCATION = 1
Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school
LOWER_SECONDARY_EDUCATION = 2
Lower secondary education; First stage of secondary education building on primary education, typically with a more subject-oriented curriculum. ISCED code 2. Ex) Middle school
UPPER_SECONDARY_EDUCATION = 3
Middle education; Second/final stage of secondary education preparing for tertiary education and/or providing skills relevant to employment. Usually with an increased range of subject options and streams. ISCED code 3. Ex) High school
ADULT_REMEDIAL_EDUCATION = 4
Adult Remedial Education; Programmes providing learning experiences that build on secondary education and prepare for labour market entry and/or tertiary education. The content is broader than secondary but not as complex as tertiary education. ISCED code 4.
ASSOCIATES_OR_EQUIVALENT = 5
Associate's or equivalent; Short first tertiary programmes that are typically practically-based, occupationally-specific and prepare for labour market entry. These programmes may also provide a pathway to other tertiary programmes. ISCED code 5.
BACHELORS_OR_EQUIVALENT = 6
Bachelor's or equivalent; Programmes designed to provide intermediate academic and/or professional knowledge, skills and competencies leading to a first tertiary degree or equivalent qualification. ISCED code 6.
MASTERS_OR_EQUIVALENT = 7
Master's or equivalent; Programmes designed to provide advanced academic and/or professional knowledge, skills and competencies leading to a second tertiary degree or equivalent qualification. ISCED code 7.
DOCTORAL_OR_EQUIVALENT = 8
Doctoral or equivalent; Programmes designed primarily to lead to an advanced research qualification, usually concluding with the submission and defense of a substantive dissertation of publishable quality based on original research. ISCED code 8.
message
common.proto:597Device 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.
Used in:
DeviceInfo.DeviceType device_type = 1
Type of the device.
string id = 2
A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.
An enumeration describing an API access portal and exposure mechanism.
Used in:
DEVICE_TYPE_UNSPECIFIED = 0
The device type isn't specified.
WEB = 1
A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)
MOBILE_WEB = 2
A mobile device web browser, such as a phone or tablet with a Chrome browser.
ANDROID = 3
An Android device native application.
IOS = 4
An iOS device native application.
BOT = 5
A bot, as opposed to a device operated by human beings, such as a web crawler.
OTHER = 6
Other devices types.
message
filters.proto:715Education filter of the search.
Used in:
string school = 1
The school name. For example "MIT", "University of California, Berkeley".
string field_of_study = 2
The field of study. This is to search against value provided in [Degree.fields_of_study][google.cloud.talent.v4beta1.Degree.fields_of_study]. For example "Computer Science", "Mathematics".
DegreeType degree_type = 3
Education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
bool negated = 6
Whether to apply negation to the filter so profiles matching the filter is excluded.
message
profile.proto:617Resource that represents an education record of a candidate.
Used in:
optional start_date = 1
The start date of the education.
optional end_date = 2
The end date of the education.
optional expected_graduation_date = 3
The expected graduation date if currently pursuing a degree.
string school_name = 4
The name of the school or institution. For example, "Stanford University", "UC Berkeley", and so on. Number of characters allowed is 250.
optional address = 5
The physical address of the education institution.
oneof degree
The degree information. It can be one of [degree_description][google.cloud.talent.v4beta1.EducationRecord.degree_description] or [structured_degree][google.cloud.talent.v4beta1.EducationRecord.structured_degree].
string degree_description = 6
The full description of the degree. For example, "Master of Science in Computer Science", "B.S in Math". Number of characters allowed is 100.
structured_degree = 7
The structured notation of the degree.
string description = 8
The description of the education. Number of characters allowed is 100,000.
optional is_current = 9
If this education is current.
string school_name_snippet = 10
Output only. The school name snippet shows how the [school_name][google.cloud.talent.v4beta1.EducationRecord.school_name] is related to a search query in search result. It's empty if the [school_name][google.cloud.talent.v4beta1.EducationRecord.school_name] isn't related to the search query.
string degree_snippet = 11
Output only. The job description snippet shows how the [Degree][google.cloud.talent.v4beta1.Degree] is related to a search query in search result. It's empty if the [Degree][google.cloud.talent.v4beta1.Degree] isn't related to the search query.
message
profile.proto:446Resource that represents a person's email address.
Used in:
ContactInfoUsage usage = 1
The usage of the email address. For example, SCHOOL, WORK, PERSONAL.
string email_address = 2
Email address. Number of characters allowed is 4,000.
message
filters.proto:677Employer filter of the search.
Used in:
string employer = 1
Required. The name of the employer, for example "Google", "Alphabet".
EmployerFilter.EmployerFilterMode mode = 2
Define set of [EmploymentRecord][google.cloud.talent.v4beta1.EmploymentRecord]s to search against. Defaults to [EmployerFilterMode.ALL_EMPLOYMENT_RECORDS][google.cloud.talent.v4beta1.EmployerFilter.EmployerFilterMode.ALL_EMPLOYMENT_RECORDS].
bool negated = 3
Whether to apply negation to the filter so profiles matching the filter is excluded.
Enum indicating which set of [Profile.employment_records][google.cloud.talent.v4beta1.Profile.employment_records] to search against.
Used in:
EMPLOYER_FILTER_MODE_UNSPECIFIED = 0
Default value.
ALL_EMPLOYMENT_RECORDS = 1
Apply to all employers in [Profile.employment_records][google.cloud.talent.v4beta1.Profile.employment_records].
CURRENT_EMPLOYMENT_RECORDS_ONLY = 2
Apply only to current employer in [Profile.employment_records][google.cloud.talent.v4beta1.Profile.employment_records].
PAST_EMPLOYMENT_RECORDS_ONLY = 3
Apply only to past (not current) employers in [Profile.employment_records][google.cloud.talent.v4beta1.Profile.employment_records].
message
profile.proto:548Resource that represents an employment record of a candidate.
Used in:
optional start_date = 1
Start date of the employment.
optional end_date = 2
End date of the employment.
string employer_name = 3
The name of the employer company/organization. For example, "Google", "Alphabet", and so on. Number of characters allowed is 250.
string division_name = 4
The division name of the employment. For example, division, department, client, and so on. Number of characters allowed is 100.
optional address = 5
The physical address of the employer.
string job_title = 6
The job title of the employment. For example, "Software Engineer", "Data Scientist", and so on. Number of characters allowed is 250.
string job_description = 7
The description of job content. Number of characters allowed is 100,000.
optional is_supervisor = 8
If the jobs is a supervisor position.
optional is_self_employed = 9
If this employment is self-employed.
optional is_current = 10
If this employment is current.
string job_title_snippet = 11
Output only. The job title snippet shows how the [job_title][google.cloud.talent.v4beta1.EmploymentRecord.job_title] is related to a search query. It's empty if the [job_title][google.cloud.talent.v4beta1.EmploymentRecord.job_title] isn't related to the search query.
string job_description_snippet = 12
Output only. The job description snippet shows how the [job_description][google.cloud.talent.v4beta1.EmploymentRecord.job_description] is related to a search query. It's empty if the [job_description][google.cloud.talent.v4beta1.EmploymentRecord.job_description] isn't related to the search query.
string employer_name_snippet = 13
Output only. The employer name snippet shows how the [employer_name][google.cloud.talent.v4beta1.EmploymentRecord.employer_name] is related to a search query. It's empty if the [employer_name][google.cloud.talent.v4beta1.EmploymentRecord.employer_name] isn't related to the search query.
An enum that represents the employment type of a job.
Used in: ,
EMPLOYMENT_TYPE_UNSPECIFIED = 0
The default value if the employment type isn't specified.
FULL_TIME = 1
The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.
PART_TIME = 2
The job entails working fewer hours than a full time job, typically less than 40 hours a week.
CONTRACTOR = 3
The job is offered as a contracted, as opposed to a salaried employee, position.
CONTRACT_TO_HIRE = 4
The job is offered as a contracted position with the understanding that it's converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for [EmploymentType.CONTRACTOR][google.cloud.talent.v4beta1.EmploymentType.CONTRACTOR] jobs.
TEMPORARY = 5
The job is offered as a temporary employment opportunity, usually a short-term engagement.
INTERN = 6
The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.
VOLUNTEER = 7
The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.
PER_DIEM = 8
The job requires an employee to work on an as-needed basis with a flexible schedule.
FLY_IN_FLY_OUT = 9
The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.
OTHER_EMPLOYMENT_TYPE = 10
The job does not fit any of the other listed types.
message
histogram.proto:29The histogram request.
Used in: ,
string histogram_query = 1
An expression specifies a histogram request against matching resources (for example, jobs, profiles) for searches. See [SearchJobsRequest.histogram_queries][google.cloud.talent.v4beta1.SearchJobsRequest.histogram_queries] and [SearchProfilesRequest.histogram_queries][google.cloud.talent.v4beta1.SearchProfilesRequest.histogram_queries] for details about syntax.
message
histogram.proto:44Histogram result that matches [HistogramQuery][google.cloud.talent.v4beta1.HistogramQuery] specified in searches.
Used in: ,
string histogram_query = 1
Requested histogram expression.
map<string, int64> histogram = 2
A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: * (for string histogram) string values stored in the field. * (for named numeric bucket) name specified in `bucket()` function, like for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for example, `0-1000`, `MIN-0`, and `0-MAX`.
Option for HTML content sanitization on user input fields, for example, job description. By setting this option, user can determine whether and how sanitization is performed on these fields.
Used in:
HTML_SANITIZATION_UNSPECIFIED = 0
Default value.
HTML_SANITIZATION_DISABLED = 1
Disables sanitization on HTML input.
SIMPLE_FORMATTING_ONLY = 2
Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags.
message
common.proto:932Details of an interview.
Used in:
optional rating = 6
The rating on this interview.
Outcome outcome = 7
Required. The overall decision resulting from this interview (positive, negative, nuetral).
message
job.proto:36A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a [Company][google.cloud.talent.v4beta1.Company], which is the hiring entity responsible for the job.
Used as response type in: JobService.CreateJob, JobService.GetJob, JobService.UpdateJob
Used as field type in: , , , , , ,
string name = 1
Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar". Use of this field in job queries and API calls is preferred over the use of [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] since this value is unique.
string company = 2
Required. The resource name of the company listing the job. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".
string requisition_id = 3
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][google.cloud.talent.v4beta1.Job.name], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id]. The maximum number of allowed characters is 255.
string title = 4
Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
string description = 5
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][google.cloud.talent.v4beta1.Job.responsibilities], [qualifications][google.cloud.talent.v4beta1.Job.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.
repeated string addresses = 6
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_id][google.cloud.talent.v4beta1.Job.requisition_id]s (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same [company][google.cloud.talent.v4beta1.Job.company], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] are not allowed. If the original [requisition_id][google.cloud.talent.v4beta1.Job.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.
optional application_info = 7
Job application information.
repeated JobBenefit job_benefits = 8
The benefits included with the job.
optional compensation_info = 9
Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee.
map<string, > custom_attributes = 10
A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.
repeated DegreeType degree_types = 11
The desired education degrees for the job, such as Bachelors, Masters.
string department = 12
The department or functional area within the company with the open position. The maximum number of allowed characters is 255.
repeated EmploymentType employment_types = 13
The employment type(s) of a job, for example, [full time][google.cloud.talent.v4beta1.EmploymentType.FULL_TIME] or [part time][google.cloud.talent.v4beta1.EmploymentType.PART_TIME].
string incentives = 14
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.
string language_code = 15
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][google.cloud.talent.v4beta1.Job.description] is present, detected language code based on [Job.description][google.cloud.talent.v4beta1.Job.description] is assigned, otherwise defaults to 'en_US'.
JobLevel job_level = 16
The experience level associated with the job, such as "Entry Level".
int32 promotion_value = 17
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.
string qualifications = 18
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][google.cloud.talent.v4beta1.Job.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.
string responsibilities = 19
A description of job responsibilities. The use of this field is recommended as an alternative to using the more general [description][google.cloud.talent.v4beta1.Job.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.
PostingRegion posting_region = 20
The job [PostingRegion][google.cloud.talent.v4beta1.PostingRegion] (for example, state, country) throughout which the job is available. If this field is set, a [LocationFilter][google.cloud.talent.v4beta1.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][google.cloud.talent.v4beta1.PostingRegion.NATION] or [PostingRegion.ADMINISTRATIVE_AREA][google.cloud.talent.v4beta1.PostingRegion.ADMINISTRATIVE_AREA], setting job [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] to the same location level as this field is strongly recommended.
Visibility visibility = 21
Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to [Visibility.ACCOUNT_ONLY][google.cloud.talent.v4beta1.Visibility.ACCOUNT_ONLY] if not specified.
optional job_start_time = 22
The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
optional job_end_time = 23
The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
optional posting_publish_time = 24
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.
optional posting_expire_time = 25
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][google.cloud.talent.v4beta1.JobService.ListJobs] API, but it can be retrieved with the [GetJob][google.cloud.talent.v4beta1.JobService.GetJob] API or updated with the [UpdateJob][google.cloud.talent.v4beta1.JobService.UpdateJob] API or deleted with the [DeleteJob][google.cloud.talent.v4beta1.JobService.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][google.cloud.talent.v4beta1.Job.company], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.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][google.cloud.talent.v4beta1.Job.posting_publish_time] must be set before [posting_expire_time][google.cloud.talent.v4beta1.Job.posting_expire_time]. The purpose of this feature is to allow other objects, such as [Application][google.cloud.talent.v4beta1.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][google.cloud.talent.v4beta1.UpdateJobRequest.update_mask]. If the field masks include [job_end_time][google.cloud.talent.v4beta1.Job.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.
optional posting_create_time = 26
Output only. The timestamp when this job posting was created.
optional posting_update_time = 27
Output only. The timestamp when this job posting was last updated.
string company_display_name = 28
Output only. Display name of the company listing the job.
optional derived_info = 29
Output only. Derived details about the job posting.
optional processing_options = 30
Options for job processing.
message
job.proto:38Application related details of a job posting.
Used in:
repeated string emails = 1
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.
string instruction = 2
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.
repeated string uris = 3
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.
message
job.proto:62Derived details about the job posting.
Used in:
repeated locations = 1
Structured locations of the job, resolved from [Job.addresses][google.cloud.talent.v4beta1.Job.addresses]. [locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations] are exactly matched to [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] in the same order.
repeated JobCategory job_categories = 3
Job categories derived from [Job.title][google.cloud.talent.v4beta1.Job.title] and [Job.description][google.cloud.talent.v4beta1.Job.description].
message
job.proto:79Options for job processing.
Used in:
bool disable_street_address_resolution = 1
If set to `true`, the service does not attempt to resolve a more precise address for the job.
HtmlSanitization html_sanitization = 2
Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation isn't disabled. Defaults to [HtmlSanitization.SIMPLE_FORMATTING_ONLY][google.cloud.talent.v4beta1.HtmlSanitization.SIMPLE_FORMATTING_ONLY].
An enum that represents employee benefits included with the job.
Used in:
JOB_BENEFIT_UNSPECIFIED = 0
Default value if the type isn't specified.
CHILD_CARE = 1
The job includes access to programs that support child care, such as daycare.
DENTAL = 2
The job includes dental services covered by a dental insurance plan.
DOMESTIC_PARTNER = 3
The job offers specific benefits to domestic partners.
FLEXIBLE_HOURS = 4
The job allows for a flexible work schedule.
MEDICAL = 5
The job includes health services covered by a medical insurance plan.
LIFE_INSURANCE = 6
The job includes a life insurance plan provided by the employer or available for purchase by the employee.
PARENTAL_LEAVE = 7
The job allows for a leave of absence to a parent to care for a newborn child.
RETIREMENT_PLAN = 8
The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.
SICK_DAYS = 9
The job allows for paid time off due to illness.
VACATION = 10
The job includes paid time off for vacation.
VISION = 11
The job includes vision services covered by a vision insurance plan.
An enum that represents the categorization or primary focus of specific role. This value is different than the "industry" associated with a role, which is related to the categorization of the company listing the job.
Used in: ,
JOB_CATEGORY_UNSPECIFIED = 0
The default value if the category isn't specified.
ACCOUNTING_AND_FINANCE = 1
An accounting and finance job, such as an Accountant.
ADMINISTRATIVE_AND_OFFICE = 2
An administrative and office job, such as an Administrative Assistant.
ADVERTISING_AND_MARKETING = 3
An advertising and marketing job, such as Marketing Manager.
ANIMAL_CARE = 4
An animal care job, such as Veterinarian.
ART_FASHION_AND_DESIGN = 5
An art, fashion, or design job, such as Designer.
BUSINESS_OPERATIONS = 6
A business operations job, such as Business Operations Manager.
CLEANING_AND_FACILITIES = 7
A cleaning and facilities job, such as Custodial Staff.
COMPUTER_AND_IT = 8
A computer and IT job, such as Systems Administrator.
CONSTRUCTION = 9
A construction job, such as General Laborer.
CUSTOMER_SERVICE = 10
A customer service job, such s Cashier.
EDUCATION = 11
An education job, such as School Teacher.
ENTERTAINMENT_AND_TRAVEL = 12
An entertainment and travel job, such as Flight Attendant.
FARMING_AND_OUTDOORS = 13
A farming or outdoor job, such as Park Ranger.
HEALTHCARE = 14
A healthcare job, such as Registered Nurse.
HUMAN_RESOURCES = 15
A human resources job, such as Human Resources Director.
INSTALLATION_MAINTENANCE_AND_REPAIR = 16
An installation, maintenance, or repair job, such as Electrician.
LEGAL = 17
A legal job, such as Law Clerk.
MANAGEMENT = 18
A management job, often used in conjunction with another category, such as Store Manager.
MANUFACTURING_AND_WAREHOUSE = 19
A manufacturing or warehouse job, such as Assembly Technician.
MEDIA_COMMUNICATIONS_AND_WRITING = 20
A media, communications, or writing job, such as Media Relations.
OIL_GAS_AND_MINING = 21
An oil, gas or mining job, such as Offshore Driller.
PERSONAL_CARE_AND_SERVICES = 22
A personal care and services job, such as Hair Stylist.
PROTECTIVE_SERVICES = 23
A protective services job, such as Security Guard.
REAL_ESTATE = 24
A real estate job, such as Buyer's Agent.
RESTAURANT_AND_HOSPITALITY = 25
A restaurant and hospitality job, such as Restaurant Server.
SALES_AND_RETAIL = 26
A sales and/or retail job, such Sales Associate.
SCIENCE_AND_ENGINEERING = 27
A science and engineering job, such as Lab Technician.
SOCIAL_SERVICES_AND_NON_PROFIT = 28
A social services or non-profit job, such as Case Worker.
SPORTS_FITNESS_AND_RECREATION = 29
A sports, fitness, or recreation job, such as Personal Trainer.
TRANSPORTATION_AND_LOGISTICS = 30
A transportation or logistics job, such as Truck Driver.
message
event.proto:69An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
Used in:
JobEvent.JobEventType type = 1
Required. The type of the event (see [JobEventType][google.cloud.talent.v4beta1.JobEvent.JobEventType]).
repeated string jobs = 2
Required. The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this event. For example, if this is an [impression][google.cloud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION] event, this field contains the identifiers of all jobs shown to the job seeker. If this was a [view][google.cloud.talent.v4beta1.JobEvent.JobEventType.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".
string profile = 3
The [profile name][google.cloud.talent.v4beta1.Profile.name] associated with this client event. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
An enumeration of an event attributed to the behavior of the end user, such as a job seeker.
Used in:
JOB_EVENT_TYPE_UNSPECIFIED = 0
The event is unspecified by other provided values.
IMPRESSION = 1
The job seeker or other entity interacting with the service has had a job rendered in their view, such as in a list of search results in a compressed or clipped format. This event is typically associated with the viewing of a jobs list on a single page by a job seeker.
VIEW = 2
The job seeker, or other entity interacting with the service, has viewed the details of a job, including the full description. This event doesn't apply to the viewing a snippet of a job appearing as a part of the job search results. Viewing a snippet is associated with an [impression][google.cloud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION]).
VIEW_REDIRECT = 3
The job seeker or other entity interacting with the service performed an action to view a job and was redirected to a different website for job.
APPLICATION_START = 4
The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.
APPLICATION_FINISH = 5
The job seeker or other entity interacting with the service submitted an application for a job.
APPLICATION_QUICK_SUBMISSION = 6
The job seeker or other entity interacting with the service submitted an application for a job with a single click without entering information. If a job seeker performs this action, send only this event to the service. Do not also send [JobEventType.APPLICATION_START][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_START] or [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_FINISH] events.
APPLICATION_REDIRECT = 7
The job seeker or other entity interacting with the service performed an action to apply to a job and was redirected to a different website to complete the application.
APPLICATION_START_FROM_SEARCH = 8
The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job from the search results page without viewing the details of the job posting. If sending this event, JobEventType.VIEW event shouldn't be sent.
APPLICATION_REDIRECT_FROM_SEARCH = 9
The job seeker, or other entity interacting with the service, performs an action with a single click from the search results page to apply to a job (without viewing the details of the job posting), and is redirected to a different website to complete the application. If a candidate performs this action, send only this event to the service. Do not also send [JobEventType.APPLICATION_START][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_START], [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_FINISH] or [JobEventType.VIEW][google.cloud.talent.v4beta1.JobEvent.JobEventType.VIEW] events.
APPLICATION_COMPANY_SUBMIT = 10
This event should be used when a company submits an application on behalf of a job seeker. This event is intended for use by staffing agencies attempting to place candidates.
BOOKMARK = 11
The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.
NOTIFICATION = 12
The job seeker or other entity interacting with the service was sent a notification, such as an email alert or device notification, containing one or more jobs listings generated by the service.
HIRED = 13
The job seeker or other entity interacting with the service was employed by the hiring entity (employer). Send this event only if the job seeker was hired through an application that was initiated by a search conducted through the Cloud Talent Solution service.
SENT_CV = 14
A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.
INTERVIEW_GRANTED = 15
The entity interacting with the service (for example, the job seeker), was granted an initial interview by the hiring entity (employer). This event should only be sent if the job seeker was granted an interview as part of an application that was initiated by a search conducted through / recommendation provided by the Cloud Talent Solution service.
An enum that represents the required experience level required for the job.
Used in:
JOB_LEVEL_UNSPECIFIED = 0
The default value if the level isn't specified.
ENTRY_LEVEL = 1
Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.
EXPERIENCED = 2
Experienced individual contributors, typically with 2+ years of experience in a similar role.
MANAGER = 3
Entry- to mid-level managers responsible for managing a team of people.
DIRECTOR = 4
Senior-level managers responsible for managing teams of managers.
EXECUTIVE = 5
Executive-level managers and above, including C-level positions.
message
job_service.proto:901The result of [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] or [JobService.BatchUpdateJobs][google.cloud.talent.v4beta1.JobService.BatchUpdateJobs] APIs. It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.
repeated job_results = 1
List of job mutation results from a batch mutate operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
message
job_service.proto:903Mutation result of a job.
Used in:
optional job = 1
Here [Job][google.cloud.talent.v4beta1.Job] only contains basic information including [name][google.cloud.talent.v4beta1.Job.name], [company][google.cloud.talent.v4beta1.Job.company], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], use getJob method to retrieve detailed information of the created/updated job.
optional status = 2
The status of the job processed. This field is populated if the processing of the [job][google.cloud.talent.v4beta1.JobOperationResult.JobResult.job] fails.
message
filters.proto:38The query required to perform a search query.
Used in:
string query = 1
The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.
string query_language_code = 14
The language code of [query][google.cloud.talent.v4beta1.JobQuery.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).
repeated string companies = 2
This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar". At most 20 company filters are allowed.
repeated location_filters = 3
The location filter specifies geo-regions containing the jobs to search against. See [LocationFilter][google.cloud.talent.v4beta1.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][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.
repeated JobCategory job_categories = 4
The category filter specifies the categories of jobs to search against. See [JobCategory][google.cloud.talent.v4beta1.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.
optional commute_filter = 5
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][google.cloud.talent.v4beta1.CommuteMethod]. In this case, [location_filters][google.cloud.talent.v4beta1.JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time.
repeated string company_display_names = 6
This filter specifies the exact company [Company.display_name][google.cloud.talent.v4beta1.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.
optional compensation_filter = 7
This search filter is applied only to [Job.compensation_info][google.cloud.talent.v4beta1.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.
string custom_attribute_filter = 8
This filter specifies a structured syntax to match against the [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10`
bool disable_spell_check = 9
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.
repeated EmploymentType employment_types = 10
The employment type filter specifies the employment type of jobs to search against, such as [EmploymentType.FULL_TIME][google.cloud.talent.v4beta1.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.
repeated string language_codes = 11
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.
optional publish_time_range = 12
Jobs published within a range specified by this filter are searched against.
repeated string excluded_jobs = 13
This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed.
message
filters.proto:656Job title of the search.
Used in:
string job_title = 1
Required. The job title. For example, "Software engineer", or "Product manager".
bool negated = 2
Whether to apply negation to the filter so profiles matching the filter are excluded.
An enum that specifies the job attributes that are returned in the [MatchingJob.job][google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob.job] or [ListJobsResponse.jobs][google.cloud.talent.v4beta1.ListJobsResponse.jobs] fields.
Used in: ,
JOB_VIEW_UNSPECIFIED = 0
Default value.
JOB_VIEW_ID_ONLY = 1
A ID only view of job, with following attributes: [Job.name][google.cloud.talent.v4beta1.Job.name], [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], [Job.language_code][google.cloud.talent.v4beta1.Job.language_code].
JOB_VIEW_MINIMAL = 2
A minimal view of the job, with the following attributes: [Job.name][google.cloud.talent.v4beta1.Job.name], [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.company][google.cloud.talent.v4beta1.Job.company], [Job.DerivedInfo.locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations], [Job.language_code][google.cloud.talent.v4beta1.Job.language_code].
JOB_VIEW_SMALL = 3
A small view of the job, with the following attributes in the search results: [Job.name][google.cloud.talent.v4beta1.Job.name], [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.company][google.cloud.talent.v4beta1.Job.company], [Job.DerivedInfo.locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations], [Job.visibility][google.cloud.talent.v4beta1.Job.visibility], [Job.language_code][google.cloud.talent.v4beta1.Job.language_code], [Job.description][google.cloud.talent.v4beta1.Job.description].
JOB_VIEW_FULL = 4
All available attributes are included in the search results.
message
common.proto:46A resource that represents a location with full geographic information.
Used in: , , , ,
Location.LocationType location_type = 1
The type of a location, which corresponds to the address lines field of [google.type.PostalAddress][google.type.PostalAddress]. For example, "Downtown, Atlanta, GA, USA" has a type of [LocationType.NEIGHBORHOOD][google.cloud.talent.v4beta1.Location.LocationType.NEIGHBORHOOD], and "Kansas City, KS, USA" has a type of [LocationType.LOCALITY][google.cloud.talent.v4beta1.Location.LocationType.LOCALITY].
optional postal_address = 2
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.
optional lat_lng = 3
An object representing a latitude/longitude pair.
double radius_miles = 4
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][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.
An enum which represents the type of a location.
Used in:
LOCATION_TYPE_UNSPECIFIED = 0
Default value if the type isn't specified.
COUNTRY = 1
A country level location.
ADMINISTRATIVE_AREA = 2
A state or equivalent level location.
SUB_ADMINISTRATIVE_AREA = 3
A county or equivalent level location.
LOCALITY = 4
A city or equivalent level location.
POSTAL_CODE = 5
A postal code level location.
SUB_LOCALITY = 6
A sublocality is a subdivision of a locality, for example a city borough, ward, or arrondissement. Sublocalities are usually recognized by a local political authority. For example, Manhattan and Brooklyn are recognized as boroughs by the City of New York, and are therefore modeled as sublocalities.
SUB_LOCALITY_1 = 7
A district or equivalent level location.
SUB_LOCALITY_2 = 8
A smaller district or equivalent level display.
NEIGHBORHOOD = 9
A neighborhood level location.
STREET_ADDRESS = 10
A street address level location.
message
filters.proto:475Geographic region of the search.
Used in: ,
string address = 1
The address name, such as "Mountain View" or "Bay Area".
string region_code = 2
CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field to bias location resolution toward a specific country or territory. If this field is not set, application behavior is biased toward the United States by default. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. Note that this filter is not applicable for Profile Search related queries.
optional lat_lng = 3
The latitude and longitude of the geographic center to search from. This field is ignored if `address` is provided.
double distance_in_miles = 4
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.
LocationFilter.TelecommutePreference telecommute_preference = 5
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][google.cloud.talent.v4beta1.Job.posting_region] indicates if a job permits telecommuting. If this field is set to [TelecommutePreference.TELECOMMUTE_ALLOWED][google.cloud.talent.v4beta1.LocationFilter.TelecommutePreference.TELECOMMUTE_ALLOWED], telecommuting jobs are searched, and [address][google.cloud.talent.v4beta1.LocationFilter.address] and [lat_lng][google.cloud.talent.v4beta1.LocationFilter.lat_lng] are ignored. If not set or set to [TelecommutePreference.TELECOMMUTE_EXCLUDED][google.cloud.talent.v4beta1.LocationFilter.TelecommutePreference.TELECOMMUTE_EXCLUDED], telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. This field is only used for job search requests.
bool negated = 6
Whether to apply negation to the filter so profiles matching the filter are excluded. Currently only supported in profile search.
Specify whether to include telecommute jobs.
Used in:
TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0
Default value if the telecommute preference isn't specified.
TELECOMMUTE_EXCLUDED = 1
Exclude telecommute jobs.
TELECOMMUTE_ALLOWED = 2
Allow telecommute jobs.
The overall outcome /decision / result indicator.
Used in: ,
OUTCOME_UNSPECIFIED = 0
Default value.
POSITIVE = 1
A positive outcome / passing indicator (for example, candidate was recommended for hiring or to be moved forward in the hiring process, candidate passed a test).
NEUTRAL = 2
A neutral outcome / no clear indicator (for example, no strong reccommendation either to move forward / not move forward, neutral score).
NEGATIVE = 3
A negative outcome / failing indicator (for example, candidate was recommended to NOT move forward in the hiring process, failed a test).
OUTCOME_NOT_AVAILABLE = 4
The assessment outcome is not available or otherwise unknown (for example, candidate did not complete assessment).
message
profile.proto:804Resource that represents the patent acquired by a candidate.
Used in:
string display_name = 1
Name of the patent. Number of characters allowed is 100.
repeated string inventors = 2
A list of inventors' names. Number of characters allowed for each is 100.
string patent_status = 3
The status of the patent. Number of characters allowed is 100.
optional patent_status_date = 4
The date the last time the status of the patent was checked.
optional patent_filing_date = 5
The date that the patent was filed.
string patent_office = 6
The name of the patent office. Number of characters allowed is 100.
string patent_number = 7
The number of the patent. Number of characters allowed is 100.
string patent_description = 8
The description of the patent. Number of characters allowed is 100,000.
repeated skills_used = 9
The skills used in this patent.
message
profile.proto:350Resource that represents the name of a person.
Used in:
oneof person_name
The name of a person. It can be one of [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] or [structured_name][google.cloud.talent.v4beta1.PersonName.structured_name].
string formatted_name = 1
A string represents a person's full name. For example, "Dr. John Smith". Number of characters allowed is 100.
structured_name = 2
A person's name in a structured way (last name, first name, suffix, and so on.)
string preferred_name = 3
Preferred name for the person. This field is ignored if [structured_name][google.cloud.talent.v4beta1.PersonName.structured_name] is provided. Number of characters allowed is 100.
message
profile.proto:352Resource that represents a person's structured name.
Used in:
string given_name = 1
Given/first name. It's derived from [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] if not provided. Number of characters allowed is 100.
string preferred_name = 6
Preferred given/first name or nickname. Number of characters allowed is 100.
string middle_initial = 2
Middle initial. It's derived from [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] if not provided. Number of characters allowed is 20.
string family_name = 3
Family/last name. It's derived from [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] if not provided. Number of characters allowed is 100.
repeated string suffixes = 4
Suffixes. Number of characters allowed is 20.
repeated string prefixes = 5
Prefixes. Number of characters allowed is 20.
message
filters.proto:862Filter on person name.
Used in:
string person_name = 1
Required. The person name. For example, "John Smith". Can be any combination of [PersonName.structured_name.given_name][], [PersonName.structured_name.middle_initial][], [PersonName.structured_name.family_name][], and [PersonName.formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name].
message
profile.proto:521Resource that represents a valid URI for a personal use.
Used in:
string uri = 1
The personal URI. Number of characters allowed is 4,000.
message
profile.proto:457Resource that represents a person's telephone number.
Used in:
ContactInfoUsage usage = 1
The usage of the phone. For example, SCHOOL, WORK, PERSONAL.
Phone.PhoneType type = 2
The phone type. For example, LANDLINE, MOBILE, FAX.
string number = 3
Phone number. Any phone formats are supported and only exact matches are performed on searches. For example, if a phone number in profile is provided in the format of "(xxx)xxx-xxxx", in profile searches the same phone format has to be provided. Number of characters allowed is 20.
string when_available = 4
When this number is available. Any descriptive string is expected. Number of characters allowed is 100.
Enum that represents the type of the telephone.
Used in:
PHONE_TYPE_UNSPECIFIED = 0
Default value.
LANDLINE = 1
A landline.
MOBILE = 2
A mobile.
FAX = 3
A fax.
PAGER = 4
A pager.
TTY_OR_TDD = 5
A TTY (test telephone) or TDD (telecommunication device for the deaf).
VOICEMAIL = 6
A voicemail.
VIRTUAL = 7
A virtual telephone number is a number that can be routed to another number and managed by the user via Web, SMS, IVR, and so on. It is associated with a particular person, and may be routed to either a MOBILE or LANDLINE number. The [phone usage][google.cloud.talent.v4beta1.ContactInfoUsage] should be set to PERSONAL for these phone types. Some more information can be found here: http://en.wikipedia.org/wiki/Personal_Numbers
VOIP = 8
Voice over IP numbers. This includes TSoIP (Telephony Service over IP).
MOBILE_OR_LANDLINE = 9
In some regions (e.g. the USA), it is impossible to distinguish between fixed-line and mobile numbers by looking at the phone number itself.
An enum that represents the job posting region. In most cases, job postings don't need to specify a region. If a region is given, jobs are eligible for searches in the specified region.
Used in:
POSTING_REGION_UNSPECIFIED = 0
If the region is unspecified, the job is only returned if it matches the [LocationFilter][google.cloud.talent.v4beta1.LocationFilter].
ADMINISTRATIVE_AREA = 1
In addition to exact location matching, job posting is returned when the [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in "CA, USA", it's returned if [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] has "Mountain View". Administrative area refers to top-level administrative subdivision of this country. For example, US state, IT region, UK constituent nation and JP prefecture.
NATION = 2
In addition to exact location matching, job is returned when [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in "USA", it's returned if [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] has 'Mountain View'.
TELECOMMUTE = 3
Job allows employees to work remotely (telecommute). If locations are provided with this value, the job is considered as having a location, but telecommuting is allowed.
message
profile.proto:39A resource that represents the profile for a job candidate (also referred to as a "single-source profile").
Used as response type in: ProfileService.CreateProfile, ProfileService.GetProfile, ProfileService.UpdateProfile
Used as field type in: , , ,
string name = 1
Required during profile update. Resource name assigned to a profile by the API. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
string external_id = 2
Profile's id in client system, if available. This value is unique for each profile inside a tenant. An error is thrown if another profile with the same external_id is created. The maximum number of bytes allowed is 100.
string source = 3
The source description indicating where the profile is acquired. For example, if a candidate profile is acquired from a resume, the user can input "resume" here to indicate the source. The maximum number of bytes allowed is 100.
string uri = 4
The URI set by clients that links to this profile's client-side copy. The maximum number of bytes allowed is 4000.
string group_id = 5
The cluster id of the profile to associate with other profile(s) for the same candidate. This field should be generated by the customer. If a value is not provided, a random UUID is assigned to this field of the profile. This is used to link multiple profiles to the same candidate. For example, a client has a candidate with two profiles, where one was created recently and the other one was created 5 years ago. These two profiles may be very different. The clients can create the first profile and get a generated [group_id][google.cloud.talent.v4beta1.Profile.group_id], and assign it when the second profile is created, indicating these two profiles are referring to the same candidate.
optional is_hirable = 6
Indicates the hirable status of the candidate.
optional create_time = 7
The timestamp when the profile was first created at this source.
optional update_time = 8
The timestamp when the profile was last updated at this source.
optional candidate_update_time = 67
The timestamp when the profile was last updated as a result of a direct or indirect action by a candidate. These actions include: * Direct actions such as the candidate submitting a new resume as part of a job application to the agency, using a self-service tool such as a website to update their profile, and so on. * Indirect actions by the candidate such as uploading a resume to a job board that is collected by the agency through a feed, providing a resume to a recruiter who then uploads it into the ATS, and so on. * Updates made to the candidate's profile by the recruiter as a result of interacting with the candidate (for example adding a skill or work preference, and so on). Changes to [recruiting_notes][google.cloud.talent.v4beta1.Profile.recruiting_notes] are specifically excluded from this action type. Note: [candidate_update_time][google.cloud.talent.v4beta1.Profile.candidate_update_time] must be greater than or equal to [resume_update_time][google.cloud.talent.v4beta1.Profile.resume_update_time] or an error is thrown.
optional resume_update_time = 68
The timestamp when the candidate's resume was added or updated on the candidate's profile. Whether that resume was directly uploaded by a candidate, pulled from a 3rd party job board feed, added by a recruiter, and so on. If this field is updated, it's expected that [resume][google.cloud.talent.v4beta1.Profile.resume] is provided in the create or update calls.
optional resume = 53
The resume representing this profile.
repeated person_names = 11
The names of the candidate this profile references. Currently only one person name is supported.
repeated addresses = 12
The candidate's postal addresses. It's highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: * Provide [Address.usage][google.cloud.talent.v4beta1.Address.usage] if possible, especially if the address is PERSONAL. During a search only personal addresses are considered. If there is no such address, all addresses with unspecified usage are assumed to be personal. * Provide [Address.current][google.cloud.talent.v4beta1.Address.current] for the current address if possible. During a search, only current addresses are considered. If there is no such address, all addresses are assumed to be current. When displaying a candidate's addresses, it is sometimes desirable to limit the number of addresses shown. In these cases we recommend that you display the addresses in the following order of priority: 1. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 2. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL and [Address.current][google.cloud.talent.v4beta1.Address.current] is false or not set. 3. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 4. [Address.usage][google.cloud.talent.v4beta1.Address.usage] is CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is false or not set.
repeated email_addresses = 13
The candidate's email addresses.
repeated phone_numbers = 14
The candidate's phone number(s).
repeated personal_uris = 15
The candidate's personal URIs.
repeated additional_contact_info = 16
Available contact information besides [addresses][google.cloud.talent.v4beta1.Profile.addresses], [email_addresses][google.cloud.talent.v4beta1.Profile.email_addresses], [phone_numbers][google.cloud.talent.v4beta1.Profile.phone_numbers] and [personal_uris][google.cloud.talent.v4beta1.Profile.personal_uris]. For example, Hang-out, Skype.
repeated employment_records = 17
The employment history records of the candidate. It's highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: * Specify the start and end dates of the employment records. * List different employment types separately, no matter how minor the change is. For example, only job title is changed from "software engineer" to "senior software engineer". * Provide [EmploymentRecord.is_current][google.cloud.talent.v4beta1.EmploymentRecord.is_current] for the current employment if possible. If not, it's inferred from user inputs. The limitation for max number of employment records is 100.
repeated education_records = 18
The education history record of the candidate. It's highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: * Specify the start and end dates of the education records. * List each education type separately, no matter how minor the change is. For example, the profile contains the education experience from the same school but different degrees. * Provide [EducationRecord.is_current][google.cloud.talent.v4beta1.EducationRecord.is_current] for the current education if possible. If not, it's inferred from user inputs. The limitation for max number of education records is 100.
repeated skills = 19
The skill set of the candidate. It's highly recommended to provide as much information as possible to help improve the search quality. The limitation for max number of skills is 500.
repeated activities = 20
The individual or collaborative activities which the candidate has participated in, for example, open-source projects, class assignments that aren't listed in [employment_records][google.cloud.talent.v4beta1.Profile.employment_records]. The limitation for max number of activities is 50.
repeated publications = 21
The publications published by the candidate. The limitation for max number of publications is 50.
repeated patents = 22
The patents acquired by the candidate.
repeated certifications = 23
The certifications acquired by the candidate.
repeated string applications = 47
Output only. The resource names of the candidate's applications.
repeated string assignments = 48
Output only. The resource names of the candidate's assignments.
map<string, > custom_attributes = 26
A map of fields to hold both filterable and non-filterable custom profile attributes that aren't covered by the provided structured fields. See [CustomAttribute][google.cloud.talent.v4beta1.CustomAttribute] for more details. At most 100 filterable and at most 100 unfilterable keys are supported. If limit is exceeded, an error is thrown. Custom attributes are `unfilterable` by default. These are filterable when the `filterable` flag is set to `true`. Numeric custom attributes: each key can only map to one numeric value, otherwise an error is thrown. Client can also filter on numeric custom attributes using '>', '<' or '=' operators. String custom attributes: each key can map up to 50 string values. For filterable string value, each value has a byte size of no more than 256B. For unfilterable string values, the maximum byte size of a single key is 64B. An error is thrown for any request exceeding the limit. The maximum total byte size is 10KB.
bool processed = 27
Output only. Indicates if a summarized profile was created as part of the profile creation API call. This flag does not indicate whether a profile is searchable or not.
string keyword_snippet = 28
Output only. Keyword snippet shows how the search result is related to a search query. This is only returned in [SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProfilesResponse].
repeated availability_signals = 70
Output only. Candidate's availability signals.
repeated derived_addresses = 64
Output only. Derived locations of the profile, resolved from [Profile.addresses][google.cloud.talent.v4beta1.Profile.addresses]. [derived_addresses][google.cloud.talent.v4beta1.Profile.derived_addresses] are exactly matched to [Profile.addresses][google.cloud.talent.v4beta1.Profile.addresses] in the same order.
message
event.proto:198An event issued when a profile searcher interacts with the application that implements Cloud Talent Solution.
Used in:
ProfileEvent.ProfileEventType type = 1
Required. Type of event.
repeated string profiles = 2
Required. The [profile name(s)][google.cloud.talent.v4beta1.Profile.name] associated with this client event. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
repeated string jobs = 6
The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this client event. Leave it empty if the event isn't associated with a job. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for example, "projects/foo/tenants/bar/jobs/baz".
The enum represents types of client events for a candidate profile.
Used in:
PROFILE_EVENT_TYPE_UNSPECIFIED = 0
Default value.
IMPRESSION = 1
Send this event when a [ProfileEvent.profiles][google.cloud.talent.v4beta1.ProfileEvent.profiles] was sent as a part of a result set for a CTS API call and was rendered in the end user's UI (that is, the [ProfileEvent.recruiter][google.cloud.talent.v4beta1.ProfileEvent.recruiter]).
VIEW = 2
The VIEW event records the action of a candidate's profile being viewed by an end user. This is critical to tracking product metrics and should be sent for every profile VIEW that happens in your system, whether the event is associated with an API call (for example, a recruiter making a request for a result set and clicking on a profile) or not (a recruiter using the system to view profile details without making a request). For a VIEW events associated with API calls, the [ClientEvent.request_id][google.cloud.talent.v4beta1.ClientEvent.request_id] should be populated. If the VIEW is not associated with an API call, [request_id][google.cloud.talent.v4beta1.ClientEvent.request_id] should not be populated. This event requires a valid recruiter and one valid ID in profiles.
BOOKMARK = 3
The profile is bookmarked.
message
filters.proto:199Filters to apply when performing the search query.
Used in:
string query = 1
Keywords to match any text fields of profiles. For example, "software engineer in Palo Alto".
repeated location_filters = 2
The location filter specifies geo-regions containing the profiles to search against. One of [LocationFilter.address][google.cloud.talent.v4beta1.LocationFilter.address] or [LocationFilter.lat_lng][google.cloud.talent.v4beta1.LocationFilter.lat_lng] must be provided or an error is thrown. If both [LocationFilter.address][google.cloud.talent.v4beta1.LocationFilter.address] and [LocationFilter.lat_lng][google.cloud.talent.v4beta1.LocationFilter.lat_lng] are provided, an error is thrown. The following logic is used to determine which locations in the profile to filter against: 1. All of the profile's geocoded [Profile.addresses][google.cloud.talent.v4beta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 2. If the above set of locations is empty, all of the profile's geocoded [Profile.addresses][google.cloud.talent.v4beta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is true. 3. If the above set of locations is empty, all of the profile's geocoded [Profile.addresses][google.cloud.talent.v4beta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is PERSONAL or CONTACT_INFO_USAGE_UNSPECIFIED and [Address.current][google.cloud.talent.v4beta1.Address.current] is not set. This means that any profiles without any [Profile.addresses][google.cloud.talent.v4beta1.Profile.addresses] that match any of the above criteria will not be included in a search with location filter. Furthermore, any [Profile.addresses][google.cloud.talent.v4beta1.Profile.addresses] where [Address.usage][google.cloud.talent.v4beta1.Address.usage] is WORK or SCHOOL or where [Address.current][google.cloud.talent.v4beta1.Address.current] is false are not considered for location filter. If a location filter isn't specified, profiles fitting the other search criteria are retrieved regardless of where they're located. If [LocationFilter.negated][google.cloud.talent.v4beta1.LocationFilter.negated] is specified, the result doesn't contain profiles from that location. If [LocationFilter.address][google.cloud.talent.v4beta1.LocationFilter.address] is provided, the [LocationType][google.cloud.talent.v4beta1.Location.LocationType], center point (latitude and longitude), and radius are automatically detected by the Google Maps Geocoding API and included as well. If [LocationFilter.address][google.cloud.talent.v4beta1.LocationFilter.address] cannot be geocoded, the filter falls back to keyword search. If the detected [LocationType][google.cloud.talent.v4beta1.Location.LocationType] is [LocationType.SUB_ADMINISTRATIVE_AREA][google.cloud.talent.v4beta1.Location.LocationType.SUB_ADMINISTRATIVE_AREA], [LocationType.ADMINISTRATIVE_AREA][google.cloud.talent.v4beta1.Location.LocationType.ADMINISTRATIVE_AREA], or [LocationType.COUNTRY][google.cloud.talent.v4beta1.Location.LocationType.COUNTRY], the filter is performed against the detected location name (using exact text matching). Otherwise, the filter is performed against the detected center point and a radius of detected location radius + [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles]. If [LocationFilter.address][google.cloud.talent.v4beta1.LocationFilter.address] is provided, [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] is the additional radius on top of the radius of the location geocoded from [LocationFilter.address][google.cloud.talent.v4beta1.LocationFilter.address]. If [LocationFilter.lat_lng][google.cloud.talent.v4beta1.LocationFilter.lat_lng] is provided, [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] is the only radius that is used. [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] is 10 by default. Note that the value of [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] is 0 if it is unset, so the server does not differentiate [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] that is explicitly set to 0 and [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] that is not set. Which means that if [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] is explicitly set to 0, the server will use the default value of [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] which is 10. To work around this and effectively set [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] to 0, we recommend setting [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] to a very small decimal number (such as 0.00001). If [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] is negative, an error is thrown.
repeated job_title_filters = 3
Job title filter specifies job titles of profiles to match on. If a job title isn't specified, profiles with any titles are retrieved. If multiple values are specified, profiles are retrieved with any of the specified job titles. If [JobTitleFilter.negated][google.cloud.talent.v4beta1.JobTitleFilter.negated] is specified, the result won't contain profiles with the job titles. For example, search for profiles with a job title "Product Manager".
repeated employer_filters = 4
Employer filter specifies employers of profiles to match on. If an employer filter isn't specified, profiles with any employers are retrieved. If multiple employer filters are specified, profiles with any matching employers are retrieved. If [EmployerFilter.negated][google.cloud.talent.v4beta1.EmployerFilter.negated] is specified, the result won't contain profiles that match the employers. For example, search for profiles that have working experience at "Google LLC".
repeated education_filters = 5
Education filter specifies education of profiles to match on. If an education filter isn't specified, profiles with any education are retrieved. If multiple education filters are specified, profiles that match any education filters are retrieved. If [EducationFilter.negated][google.cloud.talent.v4beta1.EducationFilter.negated] is specified, the result won't contain profiles that match the educations. For example, search for profiles with a master degree.
repeated skill_filters = 6
Skill filter specifies skill of profiles to match on. If a skill filter isn't specified, profiles with any skills are retrieved. If multiple skill filters are specified, profiles that match any skill filters are retrieved. If [SkillFilter.negated][google.cloud.talent.v4beta1.SkillFilter.negated] is specified, the result won't contain profiles that match the skills. For example, search for profiles that have "Java" and "Python" in skill list.
repeated work_experience_filter = 7
Work experience filter specifies the total working experience of profiles to match on. If a work experience filter isn't specified, profiles with any professional experience are retrieved. If multiple work experience filters are specified, profiles that match any work experience filters are retrieved. For example, search for profiles with 10 years of work experience.
repeated time_filters = 8
Time filter specifies the create/update timestamp of the profiles to match on. For example, search for profiles created since "2018-1-1".
optional hirable_filter = 9
The hirable filter specifies the profile's hirable status to match on.
repeated application_date_filters = 10
The application date filters specify application date ranges to match on.
repeated application_outcome_notes_filters = 11
The application outcome notes filters specify the notes for the outcome of the job application.
repeated application_job_filters = 13
The application job filters specify the job applied for in the application.
string custom_attribute_filter = 15
This filter specifies a structured syntax to match against the [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes] that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. String custom attributes: supported operators are =, != where the left of the operator is a custom field key and the right of the operator is a string (surrounded by quotes) value. Numeric custom attributes: Supported operators are '>', '<' or '=' operators where the left of the operator is a custom field key and the right of the operator is a numeric value. Supported functions are LOWER(<field_name>) to perform 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"), and there can be a maximum of 50 comparisons/functions in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1))
optional candidate_availability_filter = 16
Deprecated. Use availability_filters instead. The candidate availability filter which filters based on availability signals. Signal 1: Number of days since most recent job application. See [Availability.JobApplicationAvailabilitySignal][google.cloud.talent.v4beta1.Availability.JobApplicationAvailabilitySignal] for the details of this signal. Signal 2: Number of days since last profile update. See [Availability.ProfileUpdateAvailabilitySignal][google.cloud.talent.v4beta1.Availability.ProfileUpdateAvailabilitySignal] for the details of this signal. The candidate availability filter helps a recruiter understand if a specific candidate is likely to be actively seeking new job opportunities based on an aggregated set of signals. Specifically, the intent is NOT to indicate the candidate's potential qualification / interest / close ability for a specific job.
repeated availability_filters = 18
The availability filter which filters based on [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals]. The availability filter helps a recruiter understand if a specific candidate is likely to be actively seeking new job opportunities based on an aggregated set of signals. Specifically, the intent is NOT to indicate the candidate's potential qualification / interest / close ability for a specific job. There can be at most one [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter] per [signal_type][google.cloud.talent.v4beta1.AvailabilityFilter.signal_type]. If there are multiple [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter] for a [signal_type][google.cloud.talent.v4beta1.AvailabilityFilter.signal_type], an error is thrown.
repeated person_name_filters = 17
Person name filter specifies person name of profiles to match on. If multiple person name filters are specified, profiles that match any person name filters are retrieved. For example, search for profiles of candidates with name "John Smith".
message
profile.proto:758Resource that represents a publication resource of a candidate.
Used in:
repeated string authors = 1
A list of author names. Number of characters allowed is 100.
string title = 2
The title of the publication. Number of characters allowed is 100.
string description = 3
The description of the publication. Number of characters allowed is 100,000.
string journal = 4
The journal name of the publication. Number of characters allowed is 100.
string volume = 5
Volume number. Number of characters allowed is 100.
string publisher = 6
The publisher of the journal. Number of characters allowed is 100.
optional publication_date = 7
The publication date.
string publication_type = 8
The publication type. Number of characters allowed is 100.
string isbn = 9
ISBN number. Number of characters allowed is 100.
message
common.proto:942The details of the score received for an assessment or interview.
Used in:
double overall = 1
Overall score.
double min = 2
The minimum value for the score.
double max = 3
The maximum value for the score.
double interval = 4
The steps within the score (for example, interval = 1 max = 5 min = 1 indicates that the score can be 1, 2, 3, 4, or 5)
message
common.proto:518Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.
Used in: ,
string domain = 1
Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or `false`. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique domain. The maximum number of allowed characters is 255.
string session_id = 2
Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or `false`. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique session ID. The maximum number of allowed characters is 255.
string user_id = 3
Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or `false`. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique user ID. The maximum number of allowed characters is 255.
bool allow_missing_ids = 4
Only set when any of [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] isn't available for some reason. It is highly recommended not to set this field and provide accurate [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] for the best service experience.
optional device_info = 5
The type of device used by the job seeker at the time of the call to the service.
message
common.proto:588Additional information returned to client, such as debugging information.
Used in: , , , , , ,
string request_id = 1
A unique id associated with this call. This id is logged for tracking purposes.
message
profile.proto:315Resource that represents a resume.
Used in:
string structured_resume = 1
Users can create a profile with only this field field, if [resume_type][google.cloud.talent.v4beta1.Resume.resume_type] is [HRXML][google.cloud.talent.v4beta1.Resume.ResumeType.HRXML]. For example, the API parses this field and creates a profile with all structured fields populated. [EmploymentRecord][google.cloud.talent.v4beta1.EmploymentRecord], [EducationRecord][google.cloud.talent.v4beta1.EducationRecord], and so on. An error is thrown if this field cannot be parsed. Note that the use of the functionality offered by this field to extract data from resumes is an Alpha feature and as such is not covered by any SLA.
Resume.ResumeType resume_type = 2
The format of [structured_resume][google.cloud.talent.v4beta1.Resume.structured_resume].
The format of a structured resume.
Used in:
RESUME_TYPE_UNSPECIFIED = 0
Default value.
HRXML = 1
The profile contents in HR-XML format. See http://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more information about Human Resources XML.
OTHER_RESUME_TYPE = 2
Resume type not specified.
message
job_service.proto:368The Request body of the `SearchJobs` call.
Used as request type in: JobService.SearchJobs, JobService.SearchJobsForAlert
string parent = 1
Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".
SearchJobsRequest.SearchMode search_mode = 2
Mode of a search. Defaults to [SearchMode.JOB_SEARCH][google.cloud.talent.v4beta1.SearchJobsRequest.SearchMode.JOB_SEARCH].
optional request_metadata = 3
Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as `user_id`) are provided by users, and must be unique and consistent.
optional job_query = 4
Query used to search against jobs, such as keyword, location filters, etc.
bool enable_broadening = 5
Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false.
bool require_precise_result_size = 6
Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false.
repeated histogram_queries = 7
An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of [start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name][google.cloud.talent.v4beta1.Job.company_display_name]. * employment_type: histogram by [Job.employment_types][google.cloud.talent.v4beta1.Job.employment_types], for example, "FULL_TIME", "PART_TIME". * company_size: histogram by [CompanySize][google.cloud.talent.v4beta1.CompanySize], for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the [Job.degree_types][google.cloud.talent.v4beta1.Job.degree_types], for example, "Bachelors", "Masters". * job_level: histogram by the [Job.job_level][google.cloud.talent.v4beta1.Job.job_level], for example, "Entry Level". * country: histogram by the country code of jobs, for example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the [Job.language_code][google.cloud.talent.v4beta1.Job.language_code], for example, "en-US", "fr-FR". * language: histogram by the language subtag of the [Job.language_code][google.cloud.talent.v4beta1.Job.language_code], for example, "en", "fr". * category: histogram by the [JobCategory][google.cloud.talent.v4beta1.JobCategory], for example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the [CompensationInfo.CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit] of base salary, for example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes]. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes]. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute["some-string-custom-attribute"])` * `count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"])`
JobView job_view = 8
The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB_VIEW_SMALL][google.cloud.talent.v4beta1.JobView.JOB_VIEW_SMALL] if no value is specified.
int32 offset = 9
An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if [page_token][google.cloud.talent.v4beta1.SearchJobsRequest.page_token] is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).
int32 page_size = 10
A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.
string page_token = 11
The token specifying the current offset within search results. See [SearchJobsResponse.next_page_token][google.cloud.talent.v4beta1.SearchJobsResponse.next_page_token] for an explanation of how to obtain the next set of query results.
string order_by = 12
The criteria determining how search results are sorted. Default is `"relevance desc"`. Supported options are: * `"relevance desc"`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `"posting_publish_time desc"`: By [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] descending. * `"posting_update_time desc"`: By [Job.posting_update_time][google.cloud.talent.v4beta1.Job.posting_update_time] descending. * `"title"`: By [Job.title][google.cloud.talent.v4beta1.Job.title] ascending. * `"title desc"`: By [Job.title][google.cloud.talent.v4beta1.Job.title] descending. * `"annualized_base_compensation"`: By job's [CompensationInfo.annualized_base_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_base_compensation_range] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_base_compensation desc"`: By job's [CompensationInfo.annualized_base_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_base_compensation_range] descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation"`: By job's [CompensationInfo.annualized_total_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_total_compensation_range] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation desc"`: By job's [CompensationInfo.annualized_total_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_total_compensation_range] descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"custom_ranking desc"`: By the relevance score adjusted to the [SearchJobsRequest.CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression] with weight factor assigned by [SearchJobsRequest.CustomRankingInfo.importance_level][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.importance_level] in descending order. * Location sorting: Use the special syntax to order jobs by distance:<br> `"distance_from('Hawaii')"`: Order by distance from Hawaii.<br> `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate.<br> `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by multiple locations. See details below.<br> `"distance_from('Hawaii'), distance_from(19.89, 155.5)"`: Order by multiple locations. See details below.<br> The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in [diversification_level][google.cloud.talent.v4beta1.SearchJobsRequest.diversification_level].
SearchJobsRequest.DiversificationLevel diversification_level = 13
Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to [DiversificationLevel.SIMPLE][google.cloud.talent.v4beta1.SearchJobsRequest.DiversificationLevel.SIMPLE] if no value is specified.
optional custom_ranking_info = 14
Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).
bool disable_keyword_match = 16
Controls whether to disable exact keyword match on [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.description][google.cloud.talent.v4beta1.Job.description], [Job.company_display_name][google.cloud.talent.v4beta1.Job.company_display_name], [Job.addresses][google.cloud.talent.v4beta1.Job.addresses], [Job.qualifications][google.cloud.talent.v4beta1.Job.qualifications]. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Use [Company.keyword_searchable_job_custom_attributes][google.cloud.talent.v4beta1.Company.keyword_searchable_job_custom_attributes] if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false.
message
job_service.proto:371Custom ranking information for [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest].
Used in:
CustomRankingInfo.ImportanceLevel importance_level = 1
Required. Controls over how important the score of [CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression] gets applied to job's final ranking position. An error is thrown if not specified.
string ranking_expression = 2
Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). The product of 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][google.cloud.talent.v4beta1.Job.custom_attributes] key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)
The importance level for [CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression].
Used in:
IMPORTANCE_LEVEL_UNSPECIFIED = 0
Default value if the importance level isn't specified.
NONE = 1
The given ranking expression is of None importance, existing relevance score (determined by API algorithm) dominates job's final ranking position.
LOW = 2
The given ranking expression is of Low importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).
MILD = 3
The given ranking expression is of Mild importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).
MEDIUM = 4
The given ranking expression is of Medium importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).
HIGH = 5
The given ranking expression is of High importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).
EXTREME = 6
The given ranking expression is of Extreme importance, and dominates job's final ranking position with existing relevance score (determined by API algorithm) ignored.
Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.
Used in:
DIVERSIFICATION_LEVEL_UNSPECIFIED = 0
The diversification level isn't specified.
DISABLED = 1
Disables diversification. Jobs that would normally be pushed to the last page would not have their positions altered. This may result in highly similar jobs appearing in sequence in the search results.
SIMPLE = 2
Default diversifying behavior. The result list is ordered so that highly similar results are pushed to the end of the last page of search results.
A string-represented enumeration of the job search mode. The service operate differently for different modes of service.
Used in:
SEARCH_MODE_UNSPECIFIED = 0
The mode of the search method isn't specified. The default search behavior is identical to JOB_SEARCH search behavior.
JOB_SEARCH = 1
The job search matches against all jobs, and featured jobs (jobs with promotionValue > 0) are not specially handled.
FEATURED_JOB_SEARCH = 2
The job search matches only against featured jobs (jobs with a promotionValue > 0). This method doesn't return any jobs having a promotionValue <= 0. The search results order is determined by the promotionValue (jobs with a higher promotionValue are returned higher up in the search results), with relevance being used as a tiebreaker.
message
job_service.proto:755Response for SearchJob method.
Used as response type in: JobService.SearchJobs, JobService.SearchJobsForAlert
repeated matching_jobs = 1
The Job entities that match the specified [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest].
repeated histogram_query_results = 2
The histogram results that match with specified [SearchJobsRequest.histogram_queries][google.cloud.talent.v4beta1.SearchJobsRequest.histogram_queries].
string next_page_token = 3
The token that specifies the starting position of the next page of results. This field is empty if there are no more results.
repeated location_filters = 4
The location filters that the service applied to the specified query. If any filters are lat-lng based, the [Location.location_type][google.cloud.talent.v4beta1.Location.location_type] is [Location.LocationType.LOCATION_TYPE_UNSPECIFIED][google.cloud.talent.v4beta1.Location.LocationType.LOCATION_TYPE_UNSPECIFIED].
int32 estimated_total_size = 5
An estimation of the number of jobs that match the specified query. This number isn't guaranteed to be accurate. For accurate results, see [SearchJobsRequest.require_precise_result_size][google.cloud.talent.v4beta1.SearchJobsRequest.require_precise_result_size].
int32 total_size = 6
The precise result count, which is available only if the client set [SearchJobsRequest.require_precise_result_size][google.cloud.talent.v4beta1.SearchJobsRequest.require_precise_result_size] to `true`, or if the response is the last page of results. Otherwise, the value is `-1`.
optional metadata = 7
Additional information for the API invocation, such as the request tracking id.
int32 broadened_query_jobs_count = 8
If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.
optional spell_correction = 9
The spell checking result, and correction.
message
job_service.proto:787Commute details related to this job.
Used in:
optional job_location = 1
Location used as the destination in the commute calculation.
optional travel_duration = 2
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.
message
job_service.proto:758Job entry with metadata inside [SearchJobsResponse][google.cloud.talent.v4beta1.SearchJobsResponse].
Used in:
optional job = 1
Job resource that matches the specified [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest].
string job_summary = 2
A summary of the job with core information that's displayed on the search results listing page.
string job_title_snippet = 3
Contains snippets of text from the [Job.title][google.cloud.talent.v4beta1.Job.title] field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.
string search_text_snippet = 4
Contains snippets of text from the [Job.description][google.cloud.talent.v4beta1.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.
optional commute_info = 5
Commute information which is generated based on specified [CommuteFilter][google.cloud.talent.v4beta1.CommuteFilter].
message
common.proto:903Resource that represents a skill of a candidate.
Used in: , ,
string display_name = 1
Skill display name. For example, "Java", "Python". Number of characters allowed is 100.
optional last_used_date = 2
The last time this skill was used.
SkillProficiencyLevel level = 3
Skill proficiency level which indicates how proficient the candidate is at this skill.
string context = 4
A paragraph describes context of this skill. Number of characters allowed is 100,000.
string skill_name_snippet = 5
Output only. Skill name snippet shows how the [display_name][google.cloud.talent.v4beta1.Skill.display_name] is related to a search query. It's empty if the [display_name][google.cloud.talent.v4beta1.Skill.display_name] isn't related to the search query.
message
filters.proto:667Skill filter of the search.
Used in:
string skill = 1
Required. The skill name. For example, "java", "j2ee", and so on.
bool negated = 2
Whether to apply negation to the filter so profiles matching the filter are excluded.
Enum that represents the skill proficiency level.
Used in:
SKILL_PROFICIENCY_LEVEL_UNSPECIFIED = 0
Default value.
UNSKILLED = 6
Lacks any proficiency in this skill.
FUNDAMENTAL_AWARENESS = 1
Have a common knowledge or an understanding of basic techniques and concepts.
NOVICE = 2
Have the level of experience gained in a classroom and/or experimental scenarios or as a trainee on-the-job.
INTERMEDIATE = 3
Be able to successfully complete tasks in this skill as requested. Help from an expert may be required from time to time, but can usually perform skill independently.
ADVANCED = 4
Can perform the actions associated with this skill without assistance.
EXPERT = 5
Known as an expert in this area.
message
common.proto:671Spell check result.
Used in: ,
bool corrected = 1
Indicates if the query was corrected by the spell checker.
string corrected_text = 2
Correction output consisting of the corrected keyword string.
string corrected_html = 3
Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "<b><i>...</i></b>" html tags. For example, the user input query is "software enginear", where the second word, "enginear," is incorrect. It should be "engineer". When spelling correction is enabled, this value is "software <b><i>engineer</i></b>".
message
profile_service.proto:502Profile entry with metadata inside [SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProfilesResponse].
Used in:
repeated profiles = 1
A list of profiles that are linked by [Profile.group_id][google.cloud.talent.v4beta1.Profile.group_id].
optional summary = 2
A profile summary shows the profile summary and how the profile matches the search query. In profile summary, the profiles with the same [Profile.group_id][google.cloud.talent.v4beta1.Profile.group_id] are merged together. Among profiles, same education/employment records may be slightly different but they are merged into one with best efforts. For example, in one profile the school name is "UC Berkeley" and the field study is "Computer Science" and in another one the school name is "University of California at Berkeley" and the field study is "CS". The API merges these two inputs into one and selects one value for each field. For example, the school name in summary is set to "University of California at Berkeley" and the field of study is set to "Computer Science".
message
tenant.proto:34A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups.
Used as response type in: TenantService.CreateTenant, TenantService.GetTenant, TenantService.UpdateTenant
Used as field type in: , ,
string name = 1
Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
string external_id = 2
Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.
Tenant.DataUsageType usage_type = 3
Indicates whether data owned by this tenant may be used to provide product improvements across other tenants. Defaults behavior is [DataUsageType.ISOLATED][google.cloud.talent.v4beta1.Tenant.DataUsageType.ISOLATED] if it's unset.
repeated string keyword_searchable_profile_custom_attributes = 4
A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], whose corresponding `string_values` are used in keyword searches. Profiles 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 must be surrounded by quotes.
Enum that represents how user data owned by the tenant is used.
Used in:
DATA_USAGE_TYPE_UNSPECIFIED = 0
Default value.
AGGREGATED = 1
Data owned by this tenant is used to improve search/recommendation quality across tenants.
ISOLATED = 2
Data owned by this tenant is used to improve search/recommendation quality for this tenant only.
message
filters.proto:801Filter on create timestamp or update timestamp of profiles.
Used in:
optional start_time = 1
Start timestamp, matching profiles with the start time. If this field missing, The API matches profiles with create / update timestamp before the end timestamp.
optional end_time = 2
End timestamp, matching profiles with the end time. If this field missing, The API matches profiles with create / update timestamp after the start timestamp.
TimeFilter.TimeField time_field = 3
Specifies which time field to filter profiles. Defaults to [TimeField.CREATE_TIME][google.cloud.talent.v4beta1.TimeFilter.TimeField.CREATE_TIME].
Time fields can be used in TimeFilter.
Used in:
TIME_FIELD_UNSPECIFIED = 0
Default value.
CREATE_TIME = 1
Earliest profile create time.
UPDATE_TIME = 2
Latest profile update time.
message
common.proto:37Message representing a period of time between two timestamps.
Used in: ,
optional start_time = 1
Begin of the period (inclusive).
optional end_time = 2
End of the period (exclusive).
Deprecated. All resources are only visible to the owner. An enum that represents who has view access to the resource.
Used in:
VISIBILITY_UNSPECIFIED = 0
Default value.
ACCOUNT_ONLY = 1
The resource is only visible to the GCP account who owns it.
SHARED_WITH_GOOGLE = 2
The resource is visible to the owner and may be visible to other applications and processes at Google.
SHARED_WITH_PUBLIC = 3
The resource is visible to the owner and may be visible to all other API clients.
message
filters.proto:741Work experience filter. This filter is used to search for profiles with working experience length between [min_experience][google.cloud.talent.v4beta1.WorkExperienceFilter.min_experience] and [max_experience][google.cloud.talent.v4beta1.WorkExperienceFilter.max_experience].
Used in:
optional min_experience = 1
The minimum duration of the work experience (inclusive).
optional max_experience = 2
The maximum duration of the work experience (exclusive).