GoogleInteractiveMediaAds Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
IMAPodStreamRequest
Data object describing a stream request for a pod serving stream.
-
The custom asset key for the stream request.
Declaration
Swift
var customAssetKey: String { get }
Objective-C
@property (nonatomic, copy, readonly) NSString *_Nonnull customAssetKey;
-
Initializes a stream request instance with the given network code and custom
asset key. Uses the given ad display container to display the stream.
Declaration
Objective-C
- (nonnull instancetype)
initWithNetworkCode:(nonnull NSString *)networkCode
customAssetKey:(nonnull NSString *)customAssetKey
adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer
videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
userContext:(nullable id)userContext;
Parameters
networkCode
|
The network code for the stream.
|
customAssetKey
|
The asset key for the stream.
|
adDisplayContainer
|
The IMAAdDisplayContainer for rendering the ad UI.
|
videoDisplay
|
The IMAVideoDisplay where the stream will be played.
|
userContext
|
The user context for tracking requests (optional)
|
Return Value
The IMAPodStreamRequest instance.
-
Initializes a stream request instance with the given network code and custom
asset key. Uses the given ad display container to display the stream. Uses the picture in picture
proxy to track PIP events.
Declaration
Objective-C
- (nonnull instancetype)
initWithNetworkCode:(nonnull NSString *)networkCode
customAssetKey:(nonnull NSString *)customAssetKey
adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer
videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
pictureInPictureProxy:
(nullable IMAPictureInPictureProxy *)pictureInPictureProxy
userContext:(nullable id)userContext;
Parameters
networkCode
|
The network code for the stream.
|
customAssetKey
|
The asset key for the stream.
|
adDisplayContainer
|
The IMAAdDisplayContainer for rendering the ad UI.
|
videoDisplay
|
The IMAVideoDisplay where the stream will be played.
|
pictureInPictureProxy
|
The IMAPictureInPictureProxy for tracking PIP events.
|
userContext
|
The user context for tracking requests (optional)
|
Return Value
The IMAPodStreamRequest instance.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eIMAPodStreamRequest\u003c/code\u003e is a data object used to request a stream for content served via pods.\u003c/p\u003e\n"],["\u003cp\u003eIt requires a network code and a custom asset key to identify the stream.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eIMAAdDisplayContainer\u003c/code\u003e is used to display ads within the stream, and an \u003ccode\u003eIMAVideoDisplay\u003c/code\u003e handles the video playback.\u003c/p\u003e\n"],["\u003cp\u003eThe request can optionally include a user context for tracking and a \u003ccode\u003eIMAPictureInPictureProxy\u003c/code\u003e for picture-in-picture events.\u003c/p\u003e\n"]]],[],null,["# GoogleInteractiveMediaAds Framework Reference\n\nIMAPodStreamRequest\n===================\n\n @interface IMAPodStreamRequest : ../Classes/IMAStreamRequest.html\n\nData object describing a stream request for a pod serving stream.\n- `\n ``\n ``\n `\n\n ### [customAssetKey](#/c:objc(cs)IMAPodStreamRequest(py)customAssetKey)\n\n `\n ` \n The custom asset key for the stream request. \n\n #### Declaration\n\n Swift \n\n var customAssetKey: String { get }\n\n Objective-C \n\n @property (nonatomic, copy, readonly) NSString *_Nonnull customAssetKey;\n\n- `\n ``\n ``\n `\n\n ### [-initWithNetworkCode:customAssetKey:adDisplayContainer:videoDisplay:userContext:](#/c:objc(cs)IMAPodStreamRequest(im)initWithNetworkCode:customAssetKey:adDisplayContainer:videoDisplay:userContext:)\n\n `\n ` \n Initializes a stream request instance with the given network code and custom\n asset key. Uses the given ad display container to display the stream. \n\n #### Declaration\n\n Swift \n\n init(networkCode: String, customAssetKey: String, adDisplayContainer: ../Classes/IMAAdDisplayContainer.html, videoDisplay: any ../Protocols/IMAVideoDisplay.html, userContext: Any?)\n\n Objective-C \n\n - (nonnull instancetype)\n initWithNetworkCode:(nonnull NSString *)networkCode\n customAssetKey:(nonnull NSString *)customAssetKey\n adDisplayContainer:(nonnull ../Classes/IMAAdDisplayContainer.html *)adDisplayContainer\n videoDisplay:(nonnull id\u003c../Protocols/IMAVideoDisplay.html\u003e)videoDisplay\n userContext:(nullable id)userContext;\n\n #### Parameters\n\n |----------------------------|------------------------------------------------------|\n | ` `*networkCode*` ` | The network code for the stream. |\n | ` `*customAssetKey*` ` | The asset key for the stream. |\n | ` `*adDisplayContainer*` ` | The IMAAdDisplayContainer for rendering the ad UI. |\n | ` `*videoDisplay*` ` | The IMAVideoDisplay where the stream will be played. |\n | ` `*userContext*` ` | The user context for tracking requests (optional) |\n\n #### Return Value\n\n The IMAPodStreamRequest instance.\n- `\n ``\n ``\n `\n\n ### [-initWithNetworkCode:customAssetKey:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:](#/c:objc(cs)IMAPodStreamRequest(im)initWithNetworkCode:customAssetKey:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:)\n\n `\n ` \n Initializes a stream request instance with the given network code and custom\n asset key. Uses the given ad display container to display the stream. Uses the picture in picture\n proxy to track PIP events. \n\n #### Declaration\n\n Swift \n\n init(networkCode: String, customAssetKey: String, adDisplayContainer: ../Classes/IMAAdDisplayContainer.html, videoDisplay: any ../Protocols/IMAVideoDisplay.html, pictureInPictureProxy: ../Classes/IMAPictureInPictureProxy.html?, userContext: Any?)\n\n Objective-C \n\n - (nonnull instancetype)\n initWithNetworkCode:(nonnull NSString *)networkCode\n customAssetKey:(nonnull NSString *)customAssetKey\n adDisplayContainer:(nonnull ../Classes/IMAAdDisplayContainer.html *)adDisplayContainer\n videoDisplay:(nonnull id\u003c../Protocols/IMAVideoDisplay.html\u003e)videoDisplay\n pictureInPictureProxy:\n (nullable ../Classes/IMAPictureInPictureProxy.html *)pictureInPictureProxy\n userContext:(nullable id)userContext;\n\n #### Parameters\n\n |-------------------------------|-------------------------------------------------------|\n | ` `*networkCode*` ` | The network code for the stream. |\n | ` `*customAssetKey*` ` | The asset key for the stream. |\n | ` `*adDisplayContainer*` ` | The IMAAdDisplayContainer for rendering the ad UI. |\n | ` `*videoDisplay*` ` | The IMAVideoDisplay where the stream will be played. |\n | ` `*pictureInPictureProxy*` ` | The IMAPictureInPictureProxy for tracking PIP events. |\n | ` `*userContext*` ` | The user context for tracking requests (optional) |\n\n #### Return Value\n\n The IMAPodStreamRequest instance."]]