REST Resource: projects.locations.vodSessions

Resource: VodSession

Metadata for a VOD session. The session expires 4 hours after its creation.

JSON representation 
{
  "name": string,
  "interstitials": {
    object (Interstitials)
  },
  "playUri": string,
  "sourceUri": string,
  "adTagUri": string,
  "adTagMacroMap": {
    string: string,
    ...
  },
  "manifestOptions": {
    object (ManifestOptions)
  },
  "assetId": string,
  "adTracking": enum (AdTracking),
  "gamSettings": {
    object (GamSettings)
  },
  "vodConfig": string
}
Fields
name

string

Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}.
interstitials

object (Interstitials)

Output only. Metadata of what was stitched into the content.
playUri

string

Output only. The playback URI of the stitched content.
sourceUri

string

URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
adTagUri

string

Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
adTagMacroMap

map (key: string, value: string)

Key value pairs for ad tag macro replacement, only available for VOD sessions that do not implement Google Ad manager ad insertion. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI.

Macros are designated by square brackets, for example:

Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

Ad tag macro map: {"geoId": "123"}

Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

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

object (ManifestOptions)

Additional options that affect the output of the manifest.
assetId

string

Output only. The generated ID of the VodSession's source media.
adTracking

enum (AdTracking)

Required. Determines how the ad should be tracked.
gamSettings

object (GamSettings)

This field should be set with appropriate values if GAM is being used for ads.
vodConfig

string

The resource name of the VOD config for this session, in the form of projects/{project}/locations/{location}/vodConfigs/{id}.

Interstitials

Describes what was stitched into a VOD session's manifest.

JSON representation 
{
  "adBreaks": [
    {
      object (VodSessionAdBreak)
    }
  ],
  "sessionContent": {
    object (VodSessionContent)
  }
}
Fields
adBreaks[]

object (VodSessionAdBreak)

List of ad breaks ordered by time.
sessionContent

object (VodSessionContent)

Information related to the content of the VOD session.

VodSessionAdBreak

Metadata for an inserted ad break.

JSON representation 
{
  "progressEvents": [
    {
      object (ProgressEvent)
    }
  ],
  "ads": [
    {
      object (VodSessionAd)
    }
  ],
  "endTimeOffset": string,
  "startTimeOffset": string
}
Fields
progressEvents[]

object (ProgressEvent)

List of events that are expected to be triggered, ordered by time.
ads[]

object (VodSessionAd)

Ordered list of ads stitched into the ad break.
endTimeOffset

string (Duration format)

Ad break end time in seconds relative to the start of the VOD asset.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
startTimeOffset

string (Duration format)

Ad break start time in seconds relative to the start of the VOD asset.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

VodSessionAd

Metadata for an inserted ad in a VOD session.

JSON representation 
{
  "duration": string,
  "companionAds": {
    object (CompanionAds)
  },
  "activityEvents": [
    {
      object (Event)
    }
  ]
}
Fields
duration

string (Duration format)

Duration in seconds of the ad.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
companionAds

object (CompanionAds)

Metadata of companion ads associated with the ad.
activityEvents[]

object (Event)

The list of progress tracking events for the ad break. These can be of the following IAB types: MUTE, UNMUTE, PAUSE, CLICK, CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN, EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR, CLOSE_LINEAR, SKIP.

VodSessionContent

Metadata for the entire stitched content in a VOD session.

JSON representation 
{
  "duration": string
}
Fields
duration

string (Duration format)

The total duration in seconds of the content including the ads stitched in.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

GamSettings

Defines fields related to Google Ad Manager (GAM). This should be set if GAM is being used for ads.

JSON representation 
{
  "networkCode": string,
  "streamId": string
}
Fields
networkCode

string

Required. Ad Manager network code.
streamId

string

Required. The stream ID generated by Ad Manager.

Methods

create

 Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

get

 Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.