REST Resource: projects.locations.liveConfigs

Resource: LiveConfig

Metadata for used to register live configs.

JSON representation 
{
  "name": string,
  "sourceUri": string,
  "adTagUri": string,
  "gamLiveConfig": {
    object (GamLiveConfig)
  },
  "state": enum (State),
  "adTracking": enum (AdTracking),
  "defaultSlate": string,
  "stitchingPolicy": enum (StitchingPolicy),
  "prefetchConfig": {
    object (PrefetchConfig)
  },
  "sourceFetchOptions": {
    object (FetchOptions)
  }
}
Fields
name

string

Output only. The resource name of the live config, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.
sourceUri

string

Required. Source URI for the live stream manifest.
adTagUri

string

The default ad tag associated with this live stream config.
gamLiveConfig

object (GamLiveConfig)

Additional metadata used to register a live stream with Google Ad Manager (GAM)
state

enum (State)

Output only. State of the live config.
adTracking

enum (AdTracking)

Required. Determines how the ads are tracked.
defaultSlate

string

This must refer to a slate in the same project. If Google Ad Manager (GAM) is used for ads, this string sets the value of slateCreativeId in https://developers.google.com/ad-manager/api/reference/v202211/LiveStreamEventService.LiveStreamEvent#slateCreativeId
stitchingPolicy

enum (StitchingPolicy)

Defines the stitcher behavior in case an ad does not align exactly with the ad break boundaries. If not specified, the default is CUT_CURRENT.
prefetchConfig

object (PrefetchConfig)

The configuration for prefetching ads.
sourceFetchOptions

object (FetchOptions)

Options for fetching source manifests and segments.

GamLiveConfig

Metadata used to register a live stream with Google Ad Manager (GAM)

JSON representation 
{
  "networkCode": string,
  "assetKey": string,
  "customAssetKey": string
}
Fields
networkCode

string

Required. Ad Manager network code to associate with the live config.
assetKey

string

Output only. The asset key identifier generated for the live config.
customAssetKey

string

Output only. The custom asset key identifier generated for the live config.

State

State of the live config.

Enums
STATE_UNSPECIFIED State is not specified.
CREATING Live config is being created.
READY Live config is ready for use.
DELETING Live config is queued up for deletion.

StitchingPolicy

Defines the ad stitching behavior in case the ad duration does not align exactly with the ad break boundaries. If not specified, the default is CUT_CURRENT.

Enums
STITCHING_POLICY_UNSPECIFIED Stitching policy is not specified.
CUT_CURRENT Cuts an ad short and returns to content in the middle of the ad.
COMPLETE_AD Finishes stitching the current ad before returning to content.

PrefetchConfig

The configuration for prefetch ads.

JSON representation 
{
  "enabled": boolean,
  "initialAdRequestDuration": string
}
Fields
enabled

boolean

Required. Indicates whether the option to prefetch ad requests is enabled.
initialAdRequestDuration

string (Duration format)

The duration in seconds of the part of the break to be prefetched. This field is only relevant if prefetch is enabled. You should set this duration to as long as possible to increase the benefits of prefetching, but not longer than the shortest ad break expected. For example, for a live event with 30s and 60s ad breaks, the initial duration should be set to 30s.

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

Methods

create

 Registers the live config with the provided unique ID in the specified region.

delete

 Deletes the specified live config.

get

 Returns the specified live config managed by the Video Stitcher service.

list

 Lists all live configs managed by the Video Stitcher that belong to the specified project and region.

patch

 Updates the specified LiveConfig.