Clip Events#
Opened Clip (openedClip)#
The openedClip event is recorded when:
- A user taps on a row or grid item to open a Clip
- A user swipes up to the next Clip
- A user swipes down to the previous Clip
- A user is sent directly to a Clip via a call to openCollection
- A user is sent directly to a Clip via a deep link
- A user dismisses the last category (by pressing back) and returns to the top level collection
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
| Opened Reason | openedReason |
The action which the user took to open the Clip. | OpenedReason |
Dismissed Clip (dismissedClip)#
The dismissedClip event is recorded when a user taps on the back button in the top left to exit the Clips Player (and is at the top of the stack of Clip Categories).
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
| Dismissed Reason | dismissedReason |
The reason the Clip was dismissed. | DismissedReason |
| Clips Viewed | clipsViewed |
The total number of Clips a user has viewed since the most recent openedClip event with an openedReason of clipListTap or deepLink. |
1, 2, 3, … |
| Duration Viewed | durationViewed |
In milliseconds, the duration the user viewed the Clips player for (measured from the most recent openedClip event with an openedReason of clipListTap or deepLink). |
1200, … |
| Loops Viewed | loopsViewed |
The total number of loops (plays of an individual Clip) a user has viewed since the most recent openedClip event with an openedReason of clipListTap or deepLink. |
1, 2, 3, … |
Finished Clip (finishedClip)#
The finishedClip event is recorded at the same time as openedCategory, dismissedClip, nextClip, or previousClip is fired.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
| Duration Viewed | durationViewed |
In milliseconds, the duration the user viewed the Clips player for, measured from the most recent openedClip event with an openedReason of swipe. |
1200, … |
| Loops Viewed | loopsViewed |
The total number of loops (plays of an individual Clip) a user has viewed since the most recent openedClip event with an openedReason of swipe. |
1, 2, 3, … |
Next Clip (nextClip)#
The nextClip event is recorded when a user swipes up to go to the next Clip.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Previous Clip (previousClip)#
The previousClip event is recorded when a user swipes down to go to the previous Clip.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Completed Loop (completedLoop)#
The completedLoop event is recorded when a user completes a loop of a Clip. Note that for live Clips this event will never be fired.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Action Button Tapped (actionButtonTapped)#
The actionButtonTapped event is recorded when a user taps the action button at the bottom of a Clip.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Share Button Tapped (shareButtonTapped)#
The shareButtonTapped event is fired when a user taps the share button on a Clip.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Share Success (shareSuccess)#
The shareSuccess event is fired when a user successfully shares a Clip.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Paused Clip (pausedClip)#
The pausedClip event is recorded when a user taps on the screen whilst a Clip is playing to pause the Clip. It does not fire when a Clip is paused automatically by sharing or following an action. Note that for live Clips this event will never be fired, as pausing / resuming live Clips is not supported.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Resumed Clip (resumedClip)#
The resumedClip event is recorded when a user taps a Clip that is paused to resume playback. It does not fire when a Clip is resumed automatically, e.g. by finishing sharing a Clip. Note that for live Clips this event will never be fired, as pausing / resuming live Clips is not supported.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Liked Clip (likedClip)#
The likedClip event is recorded when a user taps the like button on a Clip previously not liked by them.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Unliked Clip (unlikedClip)#
The unlikedClip event is recorded when a user taps the like button on a Clip previously liked by them.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Content Length | contentLength |
In seconds, the total duration of the Clip. | 15, 21, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Opened Category (openedCategory)#
The openedCategory event is recorded when:
- A user taps a Category at the bottom of the Clips Player to open a new Category
- A user opens a Category by navigating back from another Category
- A user opens the Clips Player via one of
openCategorymethods.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Category ID | categoryId |
The Category ID of the category being navigated to. | 012200025, 12312452, … |
| Category Name | categoryName |
The Name of Category of the category being navigated to. | “Must See Moments”, “Rapid Replay”, … |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Dismissed Category (dismissedCategory)#
The dismissedCategory event is recorded when a user navigates back using the back button to the previous Category. This event does not fire when dismissing the top level Collection.
The event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Clip for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Category Details | categoryDetails |
A list of Category Detail objects. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Category ID | categoryId |
The Category ID of the category being dismissed. | 012200025, 12312452, … |
| Category Name | categoryName |
The Name of Category of the category being dismissed. | “Must See Moments”, “Rapid Replay”, … |
| Collection | collection |
The ID of the collection (if the Clip is being played from a collection). | live-stories, top-stories, … |
| Clip ID | clipId |
The ID of the Clip for which the event occurred. | 3241dbc1-ae7b-4b55-a236-1294f18e2584 |
| Clip Index | clipIndex |
The index of the Clip in the row or grid at the point it was selected or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). Note that this property uses 1-based indexing. | 1, 2, 3, … |
| Clip Title | clipTitle |
The Title of the Clip for which the event occurred. | "Highlights", "Tonight's Movies" |
| Clip Has Action | clipHasAction |
Whether the Clip associated with the event contains an Action. | true, false |
| Clip Action Text | clipActionText |
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text. | “Watch Now”, … |
| Clip Action URL | clipActionUrl |
If the Clip associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |