REST Resource: projects.locations.liveSessions

Resource: LiveSession

Metadata for a live session. The session expires 5 minutes after the client stops fetching the session's playlists.

JSON representation 
{
  "name": string,
  "playUri": string,
  "adTagMacros": {
    string: string,
    ...
  },
  "manifestOptions": {
    object (ManifestOptions)
  },
  "gamSettings": {
    object (GamSettings)
  },
  "liveConfig": string,
  "adTracking": enum (AdTracking)
}
Fields
name

string

Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}.
playUri

string

Output only. The URI to play the live session's ad-stitched stream.
adTagMacros

map (key: string, value: string)

Key value pairs for ad tag macro replacement, only available for live 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 macros: {"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.
gamSettings

object (GamSettings)

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

string

Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.
adTracking

enum (AdTracking)

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

GamSettings

Defines fields related to Google Ad Manager (GAM).

JSON representation 
{
  "streamId": string,
  "targetingParameters": {
    string: string,
    ...
  }
}
Fields
streamId

string

Required. The stream ID generated by Ad Manager. This must be set if GAM is being used for ads and the session uses client-side ad tracking.
targetingParameters

map (key: string, value: string)

Targeting parameters to send to Ad Manager to generate a stream ID. This should only be set if the session uses server-side ad tracking.

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

Methods

create

 Creates a new live session.

get

 Returns the details for the specified live session.