Class: Google::Cloud::Talent::V4beta1::ProfileEvent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/talent/v4beta1/event.rb

Overview

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

Defined Under Namespace

Modules: ProfileEventType

Instance Attribute Summary collapse

Instance Attribute Details

#jobs ⇒ ::Array<::String>

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

Returns:

  • (::Array<::String>) —

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/talent/v4beta1/event.rb', line 200

class ProfileEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The enum represents types of client events for a candidate profile.
  module ProfileEventType
    # Default value.
    PROFILE_EVENT_TYPE_UNSPECIFIED = 0

    # Send this event when a {::Google::Cloud::Talent::V4beta1::ProfileEvent#profiles 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]).
    IMPRESSION = 1

    # 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
    # {::Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent.request_id} should be populated.  If the VIEW is not
    # associated with an API call, {::Google::Cloud::Talent::V4beta1::ClientEvent#request_id request_id} should
    # not be populated.
    #
    # This event requires a valid recruiter and one valid ID in profiles.
    VIEW = 2

    # The profile is bookmarked.
    BOOKMARK = 3
  end
end

#profiles ⇒ ::Array<::String>

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

Returns:

  • (::Array<::String>) —

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/talent/v4beta1/event.rb', line 200

class ProfileEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The enum represents types of client events for a candidate profile.
  module ProfileEventType
    # Default value.
    PROFILE_EVENT_TYPE_UNSPECIFIED = 0

    # Send this event when a {::Google::Cloud::Talent::V4beta1::ProfileEvent#profiles 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]).
    IMPRESSION = 1

    # 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
    # {::Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent.request_id} should be populated.  If the VIEW is not
    # associated with an API call, {::Google::Cloud::Talent::V4beta1::ClientEvent#request_id request_id} should
    # not be populated.
    #
    # This event requires a valid recruiter and one valid ID in profiles.
    VIEW = 2

    # The profile is bookmarked.
    BOOKMARK = 3
  end
end

#type ⇒ ::Google::Cloud::Talent::V4beta1::ProfileEvent::ProfileEventType

Returns Required. Type of event.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'proto_docs/google/cloud/talent/v4beta1/event.rb', line 200

class ProfileEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The enum represents types of client events for a candidate profile.
  module ProfileEventType
    # Default value.
    PROFILE_EVENT_TYPE_UNSPECIFIED = 0

    # Send this event when a {::Google::Cloud::Talent::V4beta1::ProfileEvent#profiles 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]).
    IMPRESSION = 1

    # 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
    # {::Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent.request_id} should be populated.  If the VIEW is not
    # associated with an API call, {::Google::Cloud::Talent::V4beta1::ClientEvent#request_id request_id} should
    # not be populated.
    #
    # This event requires a valid recruiter and one valid ID in profiles.
    VIEW = 2

    # The profile is bookmarked.
    BOOKMARK = 3
  end
end