מפתח ה-API של בקשת השידור. ההגדרה מתבצעת דרך
ממשק המשתמש של DFP Admin והיא מסופקת לבעל האתר כדי לפתוח את התוכן שלו.
הוא מאמת את האפליקציות שמנסות לגשת לתוכן.
authToken
מחרוזת
טוקן ההרשאה של בקשת הסטרימינג. משמש במקום מפתח ה-API לאישור תוכן מחמיר יותר. בעל התוכן הדיגיטלי יכול לשלוט בהרשאות של כל אחד מזרמי התוכן על סמך הטוקן הזה.
פורמט
StreamFormat שאינו null
פורמט הסטרימינג לבקשה. אפשר להזין את ערכי המחרוזת הבאים:
hls (ברירת מחדל)
dash
networkCode
מחרוזת
קוד הרשת של בעל התוכן הדיגיטלי ששולח את הבקשה הזו להצגת סטרימינג. קודים של רשת נדרשים לבקשות לסטרימינג של מודעות פוד (PodStreamRequest או PodVodStreamRequest) ולבקשות לסטרימינג של תפירת מודעות בענן (VideoStitcherLiveStreamRequest או VideoStitcherVodStreamRequest). הם אופציונליים אבל מומלצים לבקשות לסטרימינג של מודעות פוד מלא (LiveStreamRequest או VODStreamRequest). הקוד משמש להחלת ההגדרות שנבחרו בממשק המשתמש של Ad Manager, כמו הפעלת מודעות מוגבלות פרוגרמטיות. בנוסף, הוא משמש לאיתור ולהפעלת הסטרימינג ב-Pod serving וב-Cloud stitching. במאמר הזה מוסבר איך למצוא את קוד הרשת.
אובייקט הגדרות למיפוי ספקי אימות למצבי גישה של OMID.
כתובות ה-URL של סקריפטים לאימות מותאמות באופן פנימי לביטויים רגולריים שסופקו על ידי הספק כדי להגיע למפתח OmidVerificationVendor. לאחר מכן, IMA מחפש את מצב הגישה של הספק הנתון באמצעות האובייקט הזה.
אם כתובות URL של סקריפטים לא מפנות לספק מוכר, או אם האובייקט הזה לא כולל את הערך של OmidVerificationVendor, IMA ישתמש במצב הגישה שצוין עבור OmidVerificationVendor.OTHER. אם לא מסופק הערך OmidVerificationVendor.OTHER, ייעשה שימוש במצב גישה מוגבלת.
streamActivityMonitorId
מחרוזת
המזהה שמשמש לניפוי באגים של מקור הנתונים באמצעות הכלי לניהול שידור (SAM).
הכלי הזה מאפשר לבעלי אפליקציות למצוא בקלות יומן סטרימינג בכלי למעקב אחרי פעילות סטרימינג.
[null,null,["עדכון אחרון: 2025-08-21 (שעון UTC)."],[[["\u003cp\u003e\u003ccode\u003eStreamRequest\u003c/code\u003e is a class used for defining the properties of a stream request, including authorization, format, and ad parameters.\u003c/p\u003e\n"],["\u003cp\u003eIt allows publishers to control content access through an API key or a more restrictive authorization token.\u003c/p\u003e\n"],["\u003cp\u003eStream format can be specified as either \u003ccode\u003ehls\u003c/code\u003e (default) or \u003ccode\u003edash\u003c/code\u003e, and ad tag parameters can be customized to target specific audiences.\u003c/p\u003e\n"],["\u003cp\u003eNetwork code is recommended for applying Ad Manager settings and is required for certain stream request types.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eomidAccessModeRules\u003c/code\u003e allows publishers to configure Open Measurement Interface Definition (OMID) access modes for verification vendors.\u003c/p\u003e\n"]]],[],null,["# Class: StreamRequest\n\nStreamRequest\n=============\n\nclass public\n\nA class for specifying properties of the stream request.\n\nProperties\n----------\n\n### adTagParameters\n\n(null or non-null Object with string properties)\n\nYou can override a limited set of ad tag parameters on your stream\nrequest. Values added must be strings.\n[Supply targeting parameters to your stream](//support.google.com/dfp_premium/answer/7320899) provides more information.\nYou can use the `dai-ot` and `dai-ov` parameters\nfor stream variant preference.\nSee [Override Stream Variant Parameters](//support.google.com/dfp_premium/answer/7320898) for more information.\n\n### apiKey\n\nstring\n\nThe stream request API key. It's configured through the\n[DFP Admin UI](//support.google.com/dfp_premium/answer/6381445) and provided to the publisher to unlock their content.\nIt verifies the applications that are attempting to access the content.\n\n### authToken\n\nstring\n\nThe stream request authorization token. Used in place of the API key\nfor stricter content authorization. The publisher can control individual\ncontent streams authorizations based on this token.\n\n### format\n\nnon-null StreamFormat\n\nThe stream format to request. Accepts the following string values:\n\n- `hls` (default)\n- `dash`\n\n| Note: Values must be lowercase.\n\n### networkCode\n\nstring\n\nThe network code for the publisher making this stream request. Network\ncodes are required for Pod serving stream requests (PodStreamRequest or\nPodVodStreamRequest) and Cloud stitching stream requests\n(VideoStitcherLiveStreamRequest or VideoStitcherVodStreamRequest) and\nare optional but recommended for Full service stream requests\n(LiveStreamRequest or VODStreamRequest). The code is used to apply\nsettings selected in the Ad Manager UI such as programmatic limited\nads enablement. For Pod serving and Cloud stitching it is also used to\nlocate and play the stream. To find the network code, see [this article](//support.google.com/admanager/answer/7674889).\n\n### omidAccessModeRules\n\nnon-null Object with non-null [OmidAccessMode](/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/global#OmidAccessMode) properties\n\nSettings object for mapping verification vendors to OMID Access Modes.\nVerification script URLs are internally matched against vendor provided\nregular expressions to resolve to an OmidVerificationVendor key. IMA then\nlooks up the access mode for the given vendor using this object.\n\nFor script URLs that don't resolve to a known vendor, or if the\nresolved OmidVerificationVendor is not provided in this object, IMA will\nuse the access mode provided for OmidVerificationVendor.OTHER. If\nOmidVerificationVendor.OTHER is not provided, then the LIMITED access\nmode will be used.\n\n### streamActivityMonitorId\n\nstring\n\nThe ID to be used to debug the stream with the stream activity monitor.\nThis is used to provide a convenient way to allow publishers to find a\nstream log in the stream activity monitor tool."]]