Module types (0.4.0)

Version 0.4.0

• 2.14.1 (latest)
• 2.14.0
• 2.13.5
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.0
• 1.0.2
• 0.6.3
• 0.5.0
• 0.4.0
• 0.3.0

API documentation for talent_v4beta1.types module.

Classes

Activity

Resource that represents an individual or collaborative activity participated in by a candidate, for example, an open-source project, a class assignment, and so on.

Activity description. Number of characters allowed is 100,000.

The first creation date of the activity.

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.

Output only. Activity name snippet shows how the [display_nam e][google.cloud.talent.v4beta1.Activity.display_name] is related to a search query. It's empty if the [display_name][g oogle.cloud.talent.v4beta1.Activity.display_name] isn't related to the search query.

Output only. Skill used snippet shows how the corresponding [s kills_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.Activ ity.skills_used] are not related to the search query.

AdditionalContactInfo

Resource that represents contact information other than phone, email, URI and addresses.

The name of the contact method. For example, "hangout", "skype". Number of characters allowed is 100.

Address

Resource that represents a address.

The address of a person. It can be one of [unstructured_addre ss][google.cloud.talent.v4beta1.Address.unstructured_address] or [structured_address][google.cloud.talent.v4beta1.Address.s tructured_address].

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

Any

API documentation for talent_v4beta1.types.Any class.

Application

Resource that represents a job application record of a candidate.

Required. Client side application identifier, used to uniquely identify the application. The maximum number of allowed characters is 255.

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

The application date.

The application state.

If the candidate is referred by a employee.

The last update timestamp.

Outcome positiveness shows how positive the outcome is.

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.

ApplicationDateFilter

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

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

ApplicationJobFilter

Filter on the job information of Application.

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

ApplicationOutcomeNotesFilter

Outcome Notes Filter.

If true, The API excludes all candidates with any [Application .outcome_notes][google.cloud.talent.v4beta1.Application.outco me_notes] matching the outcome reason specified in the filter.

AvailabilityFilter

Filter on availability signals.

Required. Range of times to filter candidate signals by.

AvailabilitySignal

Candidate availability signal.

Timestamp of when the given availability activity last happened.

BatchCreateJobsRequest

Request to create a batch of jobs.

Required. The jobs to be created.

BatchDeleteJobsRequest

Batch delete jobs request.

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"

BatchOperationMetadata

Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].

More detailed information about operation state.

Count of failed item(s) inside an operation.

The time when the batch operation is created.

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

BatchUpdateJobsRequest

Request to update a batch of jobs.

The jobs to be updated.

BoolValue

API documentation for talent_v4beta1.types.BoolValue class.

BytesValue

API documentation for talent_v4beta1.types.BytesValue class.

CancelOperationRequest

API documentation for talent_v4beta1.types.CancelOperationRequest class.

CandidateAvailabilityFilter

Deprecated. Use AvailabilityFilter instead.

Filter on availability signals.

Certification

Resource that represents a license or certification.

Acquisition date or effective date of license or certification.

Authority of license, such as government. Number of characters allowed is 100.

ClientEvent

An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.

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

Required. The detail information of a specific event type.

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

CommuteFilter

Parameters needed for commute search.

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

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

Specifies the traffic density to use when calculating commute time.

Company

A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

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

The employer's company size.

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

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.

A URI that hosts the employer's company logo.

Output only. Derived details about the company.

CompensationFilter

Filter on job compensation type and amount.

Required. Specify desired base compensation entry's [Compe nsationInfo.CompensationUnit][google.cloud.talent.v4beta1.Comp ensationInfo.CompensationUnit].

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

CompensationInfo

Job compensation details.

Output only. Annualized base compensation range. Computed as base compensation entry's [CompensationEntry.amount][google.cl oud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] times [CompensationEntry.expected_units_per_year][google.cl oud.talent.v4beta1.CompensationInfo.CompensationEntry.expected _units_per_year]. See [CompensationEntry][google.cloud.tal ent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.

CompleteQueryRequest

Auto-complete parameters.

Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

Required. Completion result count. The maximum allowed page size is 10.

The scope of the completion. The defaults is [CompletionScope. PUBLIC][google.cloud.talent.v4beta1.CompleteQueryRequest.Compl etionScope.PUBLIC].

CompleteQueryResponse

Response of auto-complete query.

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

CreateApplicationRequest

The Request of the CreateApplication method.

Required. The application to be created.

CreateClientEventRequest

The report event request.

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

CreateCompanyRequest

The Request of the CreateCompany method.

Required. The company to be created.

CreateJobRequest

Create job request.

Required. The Job to be created.

CreateProfileRequest

Create profile request.

Required. The profile to be created.

CreateTenantRequest

The Request of the CreateTenant method.

Required. The tenant to be created.

CustomAttribute

Custom attribute values that are either filterable or non-filterable.

Exactly one of [string_values][google.cloud.talent.v4beta1.Cu stomAttribute.string_values] or [long_values][google.cloud.t alent.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.clo ud.talent.v4beta1.CustomAttribute.long_values] is supported.

Date

API documentation for talent_v4beta1.types.Date class.

Degree

Resource that represents a degree pursuing or acquired by a candidate.

Full Degree name. For example, "B.S.", "Master of Arts", and so on. Number of characters allowed is 100.

DeleteApplicationRequest

Request to delete a application.

DeleteCompanyRequest

Request to delete a company.

DeleteJobRequest

Delete job request.

DeleteOperationRequest

API documentation for talent_v4beta1.types.DeleteOperationRequest class.

DeleteProfileRequest

Delete profile request.

DeleteTenantRequest

Request to delete a tenant.

DeviceInfo

Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.

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

DoubleValue

API documentation for talent_v4beta1.types.DoubleValue class.

Duration

API documentation for talent_v4beta1.types.Duration class.

EducationFilter

Education filter of the search.

The field of study. This is to search against value provided in [Degree.fields_of_study][google.cloud.talent.v4beta1.Degr ee.fields_of_study]. For example "Computer Science", "Mathematics".

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

EducationRecord

Resource that represents an education record of a candidate.

The end date of the education.

The name of the school or institution. For example, "Stanford University", "UC Berkeley", and so on. Number of characters allowed is 250.

The degree information. It can be one of [degree_description] [google.cloud.talent.v4beta1.EducationRecord.degree_descripti on] or [structured_degree][google.cloud.talent.v4beta1.Educat ionRecord.structured_degree].

The structured notation of the degree.

If this education is current.

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

Email

Resource that represents a person's email address.

Email address. Number of characters allowed is 4,000.

EmployerFilter

Employer filter of the search.

Define set of [EmploymentRecord][google.cloud.talent.v4beta1.E mploymentRecord]s to search against. Defaults to [EmployerFil terMode.ALL_EMPLOYMENT_RECORDS][google.cloud.talent.v4beta1. EmployerFilter.EmployerFilterMode.ALL_EMPLOYMENT_RECORDS].

EmploymentRecord

Resource that represents an employment record of a candidate.

End date of the employment.

The division name of the employment. For example, division, department, client, and so on. Number of characters allowed is 100.

The job title of the employment. For example, "Software Engineer", "Data Scientist", and so on. Number of characters allowed is 250.

If the jobs is a supervisor position.

If this employment is current.

Output only. The job description snippet shows how the [job_d escription][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.

Empty

API documentation for talent_v4beta1.types.Empty class.

FieldMask

API documentation for talent_v4beta1.types.FieldMask class.

FloatValue

API documentation for talent_v4beta1.types.FloatValue class.

GetApplicationRequest

Request for getting a application by name.

GetCompanyRequest

Request for getting a company by name.

GetJobRequest

Get job request.

GetOperationRequest

API documentation for talent_v4beta1.types.GetOperationRequest class.

GetProfileRequest

Get profile request.

GetTenantRequest

Request for getting a tenant by name.

HistogramQuery

The histogram request.

HistogramQueryResult

Histogram result that matches HistogramQuery specified in searches.

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.

Int32Value

API documentation for talent_v4beta1.types.Int32Value class.

Int64Value

API documentation for talent_v4beta1.types.Int64Value class.

Interview

Details of an interview.

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

Job

A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

Required. The resource name of the company listing the job. The format is "projects/{project_id}/tenants/{tenant_id}/com panies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.

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 [requisit ion_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, [language _code][google.cloud.talent.v4beta1.Job.language_code] and [re quisition_id][google.cloud.talent.v4beta1.Job.requisition_id ] are not allowed. If the original [requisition_id][google.cl oud.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.

The benefits included with the job.

A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable string_values, the maximum total size of string_values across all keys is 50KB.

The department or functional area within the company with the open position. The maximum number of allowed characters is 255.

A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.

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

A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.

The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to [PostingRegion.NATION][google.cloud.talent.v4beta1.Post ingRegion.NATION] or [PostingRegion.ADMINISTRATIVE_AREA][goog le.cloud.talent.v4beta1.PostingRegion.ADMINISTRATIVE_AREA], setting job Job.addresses to the same location level as this field is strongly recommended.

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

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.

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

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

Options for job processing.

JobEvent

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

Required. The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this event. For example, if this is an [impression][google.clo ud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION] event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for example, "projects/foo/tenants/bar/jobs/baz".

JobOperationResult

The result of JobService.BatchCreateJobs or JobService.BatchUpdateJobs APIs. It's used to replace google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

JobQuery

The query required to perform a search query.

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 "proj ects/{project_id}/tenants/{tenant_id}/companies/{company_id }". For example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar". At most 20 company filters are allowed.

The category filter specifies the categories of jobs to search against. See JobCategory for more information. If a value isn't specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.

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.

This filter specifies a structured syntax to match against the [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custo m_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

The employment type filter specifies the employment type of jobs to search against, such as [EmploymentType.FULL_TIME][go ogle.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.

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

JobTitleFilter

Job title of the search.

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

LatLng

API documentation for talent_v4beta1.types.LatLng class.

ListApplicationsRequest

List applications for which the client has ACL visibility.

The starting indicator from which to return results.

ListApplicationsResponse

The List applications response object.

A token to retrieve the next page of results.

ListCompaniesRequest

List companies for which the client has ACL visibility.

The starting indicator from which to return results.

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.

ListCompaniesResponse

The List companies response object.

A token to retrieve the next page of results.

ListJobsRequest

List jobs request.

Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: - companyName (Required) - requisitionId - status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. Sample Query: - companyName = "projects/foo/tenants/bar/companies/baz" - companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1" - companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"

The 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.t alent.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.

ListJobsResponse

List jobs response.

A token to retrieve the next page of results.

ListOperationsRequest

API documentation for talent_v4beta1.types.ListOperationsRequest class.

ListOperationsResponse

API documentation for talent_v4beta1.types.ListOperationsResponse class.

ListProfilesRequest

List profiles request.

The filter string specifies the profiles to be enumerated. Supported operator: =, AND The field(s) eligible for filtering are: - externalId - groupId externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error. Sample Query: - externalId = "externalId-1"

• groupId = "groupId-1"

  The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified.

ListProfilesResponse

The List profiles response object.

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

ListTenantsRequest

List tenants for which the client has ACL visibility.

The starting indicator from which to return results.

ListTenantsResponse

The List tenants response object.

A token to retrieve the next page of results.

Location

A resource that represents a location with full geographic information.

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.

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.

LocationFilter

Geographic region of the search.

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.unico de.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. Note that this filter is not applicable for Profile Search related queries.

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

Whether to apply negation to the filter so profiles matching the filter are excluded. Currently only supported in profile search.

Money

API documentation for talent_v4beta1.types.Money class.

Operation

API documentation for talent_v4beta1.types.Operation class.

OperationInfo

API documentation for talent_v4beta1.types.OperationInfo class.

Patent

Resource that represents the patent acquired by a candidate.

A list of inventors' names. Number of characters allowed for each is 100.

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

The name of the patent office. Number of characters allowed is 100.

The description of the patent. Number of characters allowed is 100,000.

PersonName

Resource that represents the name of a person.

A string represents a person's full name. For example, "Dr. John Smith". Number of characters allowed is 100.

Preferred name for the person. This field is ignored if [struc tured_name][google.cloud.talent.v4beta1.PersonName.structured _name] is provided. Number of characters allowed is 100.

PersonNameFilter

Filter on person name.

PersonalUri

Resource that represents a valid URI for a personal use.

Phone

Resource that represents a person's telephone number.

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

When this number is available. Any descriptive string is expected. Number of characters allowed is 100.

PostalAddress

API documentation for talent_v4beta1.types.PostalAddress class.

Profile

A resource that represents the profile for a job candidate (also referred to as a "single-source profile").

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

The URI set by clients that links to this profile's client- side copy. The maximum number of bytes allowed is 4000.

Indicates the hirable status of the candidate.

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

The timestamp when the candidate's resume was added or updated on the candidate's profile. Whether that resume was directly uploaded by a candidate, pulled from a 3rd party job board feed, added by a recruiter, and so on. If this field is updated, it's expected that resume is provided in the create or update calls.

The names of the candidate this profile references. Currently only one person name is supported.

The candidate's email addresses.

The candidate's personal URIs.

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_cu rrent] for the current employment if possible. If not, it's inferred from user inputs. The limitation for max number of employment records is 100.

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.

The publications published by the candidate. The limitation for max number of publications is 50.

The certifications acquired by the candidate.

Output only. The resource names of the candidate's assignments.

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.

Output only. Candidate's availability signals.

ProfileEvent

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

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

ProfileQuery

Filters to apply when performing the search query.

The location filter specifies geo-regions containing the profiles to search against. One of [LocationFilter.address][g oogle.cloud.talent.v4beta1.LocationFilter.address] or [Locatio nFilter.lat_lng][google.cloud.talent.v4beta1.LocationFilter.l at_lng] must be provided or an error is thrown. If both [Loca tionFilter.address][google.cloud.talent.v4beta1.LocationFilter .address] and [LocationFilter.lat_lng][google.cloud.talent.v4 beta1.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.v4b eta1.Profile.addresses] where Address.usage is PERSONAL and Address.current is true. 2. If the above set of locations is empty, all of the profile's geocoded [Profile.addresses][google.cloud.talent.v4b eta1.Profile.addresses] where Address.usage is CONTACT_INFO_USAGE_UNSPECIFIED and Address.current is true. 3. If the above set of locations is empty, all of the profile's geocoded [Profile.addresses][google.cloud.talent.v4b eta1.Profile.addresses] where Address.usage is PERSONAL or CONTACT_INFO_USAGE_UNSPECIFIED and 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.address es][google.cloud.talent.v4beta1.Profile.addresses] where Address.usage is WORK or SCHOOL or where 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.v4be ta1.LocationFilter.negated] is specified, the result doesn't contain profiles from that location. If [LocationFilter.addre ss][google.cloud.talent.v4beta1.LocationFilter.address] is provided, the [LocationType][google.cloud.talent.v4beta1.Locat ion.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.c loud.talent.v4beta1.LocationFilter.address] cannot be geocoded, the filter falls back to keyword search. If the detected [LocationType][google.cloud.talent.v4beta1.Location.L ocationType] is [LocationType.SUB_ADMINISTRATIVE_AREA][googl e.cloud.talent.v4beta1.Location.LocationType.SUB_ADMINISTRATI VE_AREA], [LocationType.ADMINISTRATIVE_AREA][google.cloud.ta lent.v4beta1.Location.LocationType.ADMINISTRATIVE_AREA], or [ LocationType.COUNTRY][google.cloud.talent.v4beta1.Location.Loc ationType.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.distanc e_in_miles][google.cloud.talent.v4beta1.LocationFilter.dista nce_in_miles]. If [LocationFilter.address][google.cloud.tal ent.v4beta1.LocationFilter.address] is provided, [LocationFilt er.distance_in_miles][google.cloud.talent.v4beta1.LocationFi lter.distance_in_miles] is the additional radius on top of the radius of the location geocoded from [LocationFilter.addre ss][google.cloud.talent.v4beta1.LocationFilter.address]. If [L ocationFilter.lat_lng][google.cloud.talent.v4beta1.LocationFi lter.lat_lng] is provided, [LocationFilter.distance_in_mile s][google.cloud.talent.v4beta1.LocationFilter.distance_in_mi les] is the only radius that is used. [LocationFilter.distanc e_in_miles][google.cloud.talent.v4beta1.LocationFilter.dista nce_in_miles] is 10 by default. Note that the value of [Loca tionFilter.distance_in_miles][google.cloud.talent.v4beta1.Lo cationFilter.distance_in_miles] is 0 if it is unset, so the server does not differentiate [LocationFilter.distance_in_mi les][google.cloud.talent.v4beta1.LocationFilter.distance_in_ miles] that is explicitly set to 0 and [LocationFilter.distanc e_in_miles][google.cloud.talent.v4beta1.LocationFilter.dista nce_in_miles] that is not set. Which means that if [Location Filter.distance_in_miles][google.cloud.talent.v4beta1.Locati onFilter.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.distanc e_in_miles] which is 10. To work around this and effectively set [LocationFilter.distance_in_miles][google.cloud.talent.v 4beta1.LocationFilter.distance_in_miles] to 0, we recommend setting [LocationFilter.distance_in_miles][google.cloud.tale nt.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.distan ce_in_miles] is negative, an error is thrown.

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.Employ erFilter.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".

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.n egated][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.

Time filter specifies the create/update timestamp of the profiles to match on. For example, search for profiles created since "2018-1-1".

The application date filters specify application date ranges to match on.

The application job filters specify the job applied for in the application.

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.JobApplicationAvailabilitySigna l][google.cloud.talent.v4beta1.Availability.JobApplicationAvai labilitySignal] for the details of this signal. Signal 2: Number of days since last profile update. See [Availability.Pr ofileUpdateAvailabilitySignal][google.cloud.talent.v4beta1.Ava ilability.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.

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

Publication

Resource that represents a publication resource of a candidate.

The title of the publication. Number of characters allowed is 100.

The journal name of the publication. Number of characters allowed is 100.

The publisher of the journal. Number of characters allowed is 100.

The publication type. Number of characters allowed is 100.

Rating

The details of the score received for an assessment or interview.

The minimum value for the score.

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)

RequestMetadata

Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.

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.

Only set when any of domain, [session_id][google.cloud.talent.v4beta1.RequestMetadata.sess ion_id] and [user_id][google.cloud.talent.v4beta1.RequestMet adata.user_id] isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, [session_id][google.cloud.talent.v4beta1.RequestMetadata.sess ion_id] and [user_id][google.cloud.talent.v4beta1.RequestMet adata.user_id] for the best service experience.

ResponseMetadata

Additional information returned to client, such as debugging information.

Resume

Resource that represents a resume.

The format of [structured_resume][google.cloud.talent.v4beta1 .Resume.structured_resume].

SearchJobsRequest

The Request body of the SearchJobs call.

Mode of a search. Defaults to [SearchMode.JOB_SEARCH][google .cloud.talent.v4beta1.SearchJobsRequest.SearchMode.JOB_SEARCH ].

Query used to search against jobs, such as keyword, location filters, etc.

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.

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.

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.

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.post ing_update_time][google.cloud.talent.v4beta1.Job.posting_up date_time] descending. - "title": By Job.title ascending. - "title desc": By Job.title descending.

• "annualized_base_compensation": By job's [Compensati onInfo.annualized_base_compensation_range][google.cloud.tal ent.v4beta1.CompensationInfo.annualized_base_compensation_r ange] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_base_compensation desc": By job's [Compensa tionInfo.annualized_base_compensation_range][google.cloud.t alent.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 [Compensation Info.annualized_total_compensation_range][google.cloud.tale nt.v4beta1.CompensationInfo.annualized_total_compensation_r ange] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - "annualized_total_compensation desc": By job's [Compens ationInfo.annualized_total_compensation_range][google.cloud .talent.v4beta1.CompensationInfo.annualized_total_compensati on_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.rankin g_expression][google.cloud.talent.v4beta1.SearchJobsRequest.C ustomRankingInfo.ranking_expression] with weight factor assigned by [SearchJobsRequest.CustomRankingInfo.importance _level][google.cloud.talent.v4beta1.SearchJobsRequest.CustomR ankingInfo.importance_level] in descending order. - Location sorting: Use the special syntax to order jobs by distance: "distance_from('Hawaii')": Order by distance from Hawaii. "distance_from(19.89, 155.5)": Order by distance from a coordinate. "distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below. "distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below. 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.SearchJob sRequest.diversification_level].

  Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).

SearchJobsResponse

Response for SearchJob method.

The histogram results that match with specified [SearchJobsReq uest.histogram_queries][google.cloud.talent.v4beta1.SearchJob sRequest.histogram_queries].

The location filters that the service applied to the specified query. If any filters are lat-lng based, the [Location.locatio n_type][google.cloud.talent.v4beta1.Location.location_type] is [Location.LocationType.LOCATION_TYPE_UNSPECIFIED][google. cloud.talent.v4beta1.Location.LocationType.LOCATION_TYPE_UNS PECIFIED].

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.

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.

SearchProfilesRequest

The request body of the SearchProfiles call.

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.

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.

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.Search ProfilesRequest.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.

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.v 4beta1.Profile.create_time] in descending order (recently created profiles first). - "first_name": Sort by [PersonN ame.PersonStructuredName.given_name][google.cloud.talent.v4be ta1.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.PersonStructure dName.family_name][google.cloud.talent.v4beta1.PersonName.Per sonStructuredName.family_name] in ascending order. - "last_name desc": Sort by [PersonName.PersonStructuredName .family_name][google.cloud.talent.v4beta1.PersonName.PersonSt ructuredName.family_name] in ascending order.

A list of expressions specifies histogram requests against matching profiles for [SearchProfilesRequest][google.cloud.tal ent.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.Applicatio nDateFilter] for more details. - application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See [ApplicationOutcomeNotesFilter][google.clo ud.talent.v4beta1.ApplicationOutcomeNotesFilter] for more details. - application_job_title: The application job title specifies the job applied for in the application. See [A pplicationJobFilter][google.cloud.talent.v4beta1.ApplicationJo bFilter] 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")])

  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.

SearchProfilesResponse

Response of SearchProfiles method.

The spell checking result, and correction.

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

The profile entities that match the specified [SearchProfilesR equest][google.cloud.talent.v4beta1.SearchProfilesRequest].

Skill

Resource that represents a skill of a candidate.

The last time this skill was used.

A paragraph describes context of this skill. Number of characters allowed is 100,000.

SkillFilter

Skill filter of the search.

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

SpellingCorrection

Spell check result.

Correction output consisting of the corrected keyword string.

Status

API documentation for talent_v4beta1.types.Status class.

StringValue

API documentation for talent_v4beta1.types.StringValue class.

SummarizedProfile

Profile entry with metadata inside SearchProfilesResponse.

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

Tenant

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

Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.

A list of keys of filterable [Profile.custom_attributes][goog le.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.

TimeFilter

Filter on create timestamp or update timestamp of profiles.

End timestamp, matching profiles with the end time. If this field missing, The API matches profiles with create / update timestamp after the start timestamp.

TimeOfDay

API documentation for talent_v4beta1.types.TimeOfDay class.

Timestamp

API documentation for talent_v4beta1.types.Timestamp class.

TimestampRange

Message representing a period of time between two timestamps.

End of the period (exclusive).

UInt32Value

API documentation for talent_v4beta1.types.UInt32Value class.

UInt64Value

API documentation for talent_v4beta1.types.UInt64Value class.

UpdateApplicationRequest

Request for updating a specified application.

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateApplicationReques t.update_mask] is provided, only the specified fields in [app lication][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 are supported.

UpdateCompanyRequest

Request for updating a specified company.

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateCompanyRequest.up date_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 are supported.

UpdateJobRequest

Update job request.

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateJobRequest.update _mask] is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

UpdateProfileRequest

Update profile request

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

UpdateTenantRequest

Request for updating a specified tenant.

Strongly recommended for the best service experience. If [upd ate_mask][google.cloud.talent.v4beta1.UpdateTenantRequest.upd ate_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 are supported.

WaitOperationRequest

API documentation for talent_v4beta1.types.WaitOperationRequest class.

WorkExperienceFilter

Work 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].

The maximum duration of the work experience (exclusive).