@@ -925,82 +925,21 @@ class ProfileEventType(enum.IntEnum):
925925
926926 Attributes:
927927 PROFILE_EVENT_TYPE_UNSPECIFIED (int): Default value.
928- IMPRESSION (int): Send this event when a ``ProfileEvent.profiles`` meets all of the
929- following criteria:
930-
931- - Was sent as a part of a result set for a CTS API call.
932- - Was rendered in the end user's UI (that is, the
933- ``ProfileEvent.recruiter``).
934- - That UI rendering was displayed in the end user's viewport for >=3
935- seconds.
936-
937- In other words, send this event when the end user of the CTS service
938- actually saw a resulting profile in their viewport.
939-
940- To understand how to use this event, consider an example:
941-
942- - The customer's UI for interacting with CTS result sets is accessed by
943- the end user through a web browser.
944- - The UI calls for a page size of 15 candidates (that is, 15 candidates
945- are rendered on each page of results).
946- - However, the UI design calls for only 5 candidates to be shown at any
947- given time in the viewport (that is, the end user can only see 5
948- results at any given time and needs to scroll up or down to view all
949- 15 results).
950-
951- To render each page of results, the customer will send a request to CTS
952- with a page size = 15.
953-
954- - User loads page #1 of results.
955- - User scrolls down to expose results #1 - #5 and dwells on this view
956- for 30 seconds.
957- - Send an IMPRESSION event for result 1, 2, 3, 4, 5.
958- - User scrolls down a bit, exposing results #2 - #6 in the viewport and
959- dwells on this view for 5 minutes.
960- - Send an IMPRESSION event for result 6.
961- - User scrolls to the bottom of the page, with results #7 - #15 shown
962- in the viewport for ~5 seconds each.
963- - Specifically, NO IMPRESSION events are sent for result 7, 8, 9, 10,
964- 11, 12, 13, 14, 15.
965- - User clicks to the next page and loads page #2 of results.
966- - Within 2 seconds, user scrolls to expose results #20 - #24 in the
967- viewport and dwells on this view for 20 mins.
968- - Send an IMPRESSION event for result 20, 21, 22, 23, 24
969- - User closes their browser window.
970- VIEW (int): The VIEW event allows CTS to understand if a candidate's profile was
971- viewed by an end user (that is, recruiter) of the system for >=3
972- seconds. This is critical to tracking product metrics and should be sent
973- for every profile VIEW that happens in the customer's system.
974-
975- VIEW events should be sent whether an end user views a candidate's
976- profile as a result of seeing that profile in the result set of a CTS
977- API request or whether the end user views the profile for some other
978- reason (that is, clicks to the candidate's profile in the ATS, and so
979- on).
980-
981- For a VIEW that happens as a result of seeing the profile in a CTS API
982- request's result set, the ``ClientEvent.request_id`` should be
983- populated. If the VIEW happens for some other reason, the ``request_id``
984- should not be populated.
928+ IMPRESSION (int): Send this event when a ``ProfileEvent.profiles`` was sent as a part of a
929+ result set for a CTS API call and was rendered in the end user's UI
930+ (that is, the ``ProfileEvent.recruiter``).
931+ VIEW (int): The VIEW event records the action of a candidate's profile being viewed
932+ by an end user. This is critical to tracking product metrics and should
933+ be sent for every profile VIEW that happens in your system, whether the
934+ event is associated with an API call (for example, a recruiter making a
935+ request for a result set and clicking on a profile) or not (a recruiter
936+ using the system to view profile details without making a request).
937+
938+ For a VIEW events associated with API calls, the
939+ ``ClientEvent.request_id`` should be populated. If the VIEW is not
940+ associated with an API call, ``request_id`` should not be populated.
985941
986942 This event requires a valid recruiter and one valid ID in profiles.
987-
988- To understand how to use this event, consider 2 examples in which a VIEW
989- event should be sent:
990-
991- - End user makes a request to the CTS API for a result set.
992-
993- - Results for the request are shown to the end user.
994-
995- - End user clicks on one of the candidates that are shown as part of
996- the results.
997-
998- - A VIEW event with the ``ClientEvent.request_id`` of the API call in
999- the first step of this example is sent.
1000-
1001- - End user browses to a candidate's profile in the ATS.
1002-
1003- - A VIEW event without a ``ClientEvent.request_id`` is sent.
1004943 BOOKMARK (int): The profile is bookmarked.
1005944 """
1006945
0 commit comments