Package client-event

A message issued when a job searcher interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of Cloud Talent Solution on a tenant site, and enables 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.

JSON representation
{
  "eventId": string,
  "eventType": enum(EventType),
  "requestId": string,
  "relatedJobNames": [
    string
  ],
  "eventTimestampMillis": string,
  "details": {
    string: string,
    ...
  }
}
Fields
eventId

string

Required.

A unique identifier, generated by the client application. This eventId is used to establish the relationship between different events.

eventType

enum(EventType)

Required.

The type of the event (see EventType).

requestId

string

Required.

A unique ID generated by the Cloud Talent Solution search service. It is contained in the search response header.

relatedJobNames[]

string

Required.

The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the job that was viewed.

eventTimestampMillis

string (int64 format)

Required.

The timestamp of the event, measured in milliseconds since the epoch.

details

map (key: string, value: string)

Optional.

Additional information about this event such as context, details, and sources.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

EventType

An enumeration of an event attributed to the behavior of the end user, such a job seeker. This enum describes the context of when an ClientEvent message is supposed to be sent.

Enums
EVENT_TYPE_UNSPECIFIED The event is unspecified by other provided values.
APPLICATION_START The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.
APPLICATION_FINISH The job seeker or other entity interacting with the service submitted an application for a job.
APPLICATION_QUICK_SUBMISSION 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 EventType.APPLICATION_START or EventType.APPLICATION_FINISH events.
APPLICATION_REDIRECT The job seeker or other entity interacting with the service performed an action to apply to a job, but was redirected to a different website to complete the application.
APPLICATION_COMPANY_SUBMIT 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.
VIEW The job seeker or other entity interacting with the service has viewed the full details, including the full description, of a job. This event does not apply to the viewing a snippet of a job that appears as a part of the job search results, which is considered an impression).
BOOKMARK The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.
IMPRESSION 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.
NOTIFICATION 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 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 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 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.
APPLICATION_START_FROM_START 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 full detail of the job posting. If sending this event, EventType.VIEW event should not be sent.
APPLICATION_REDIRECT_FROM_START 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 full detail 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 EventType.APPLICATION_START, EventType.APPLICATION_FINISH or EventType.VIEW events.
VIEW_DIRECT The job seeker or other entity interacting with the service performs a single click that takes them directly to the client's page for more information on the job posting. This event is most useful for job aggregators presenting job listings from multiple sources.