با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
StreamRequest
عمومیکلاس
کلاسی برای مشخص کردن خصوصیات درخواست جریان.
سازنده
StreamRequest
New StreamRequest()
خواص
adTagParameters
(اشیاء تهی یا غیر تهی با خصوصیات رشته)
می‌توانید مجموعه محدودی از پارامترهای برچسب آگهی را در درخواست جریان خود لغو کنید. مقادیر اضافه شده باید رشته ای باشند. ارائه پارامترهای هدفمند به جریان شما اطلاعات بیشتری را ارائه می دهد. می‌توانید از پارامترهای dai-ot و dai-ov برای ترجیح نوع جریان استفاده کنید. برای اطلاعات بیشتر به لغو پارامترهای متغیر جریان مراجعه کنید.
apiKey
رشته
کلید API درخواست جریان. از طریق رابط کاربری مدیریت DFP پیکربندی شده و در اختیار ناشر قرار می‌گیرد تا قفل محتوای خود را باز کند. برنامه هایی را که سعی در دسترسی به محتوا دارند تأیید می کند.
authToken
رشته
نشانه مجوز درخواست جریان. به جای کلید API برای مجوز دقیق تر محتوا استفاده می شود. ناشر می‌تواند مجوزهای تک تک جریان‌های محتوا را بر اساس این نشانه کنترل کند.
قالب جریان برای درخواست. مقادیر رشته زیر را می پذیرد:
hls (پیش‌فرض)
dash
. اگر یک رشته نامعتبر ارائه شود، از مقدار پیش فرض استفاده می شود.
کد شبکه
رشته
کد شبکه برای ناشر درخواست کننده این جریان. کدهای شبکه برای درخواست‌های پخش جریانی سرویس Pod (PodStreamRequest یا PodVodStreamRequest) و درخواست‌های پخش جریانی Cloud stitching (VideoStitcherLiveStreamRequest یا VideoStitcherVodStreamRequest) مورد نیاز هستند و اختیاری هستند اما برای درخواست‌های پخش جریانی خدمات کامل (LiveStreamStreamest) توصیه می‌شوند. این کد برای اعمال تنظیمات انتخاب شده در رابط کاربری Ad Manager مانند فعال کردن تبلیغات محدود برنامه‌ریزی شده استفاده می‌شود. برای سرویس Pod و دوخت ابری نیز برای مکان یابی و پخش جریان استفاده می شود. برای یافتن کد شبکه، این مقاله را ببینید.
senderCanSkip
بولی
این که آیا فرستنده(ها) یک UI پرش CAF را به کاربر نهایی نمایش می دهند یا نه. برای فعال کردن تبلیغات قابل پرش استفاده می شود.
streamActivityMonitorId
رشته
شناسه مورد استفاده برای رفع اشکال جریان با نظارت بر فعالیت جریان. این برای ارائه یک روش راحت برای اجازه دادن به ناشران برای یافتن گزارش جریان در ابزار نظارت بر فعالیت جریان استفاده می‌شود.
تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003e\u003ccode\u003eStreamRequest\u003c/code\u003e class defines properties for requesting ad-integrated streams.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes \u003ccode\u003eapiKey\u003c/code\u003e or \u003ccode\u003eauthToken\u003c/code\u003e for content authorization and access control.\u003c/p\u003e\n"],["\u003cp\u003ePublishers can customize ad parameters, stream format (\u003ccode\u003ehls\u003c/code\u003e or \u003ccode\u003edash\u003c/code\u003e), and consent settings.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003enetworkCode\u003c/code\u003e is crucial for Pod/Cloud stitching requests & applying Ad Manager settings.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esenderCanSkip\u003c/code\u003e enables skippable ads and \u003ccode\u003estreamActivityMonitorId\u003c/code\u003e aids in stream debugging.\u003c/p\u003e\n"]]],["The `StreamRequest` class defines stream properties, including: `adTagParameters` for overriding ad tag settings, `apiKey` and `authToken` for content access authorization, and `consentSettings` for regulatory compliance. The `format` property specifies the stream type (`hls` or `dash`). `networkCode` is for publisher network identification, with requirements depending on the stream type. `senderCanSkip` enables skippable ads, and `streamActivityMonitorId` is used for debugging through stream activity monitoring.\n"],null,["# Class: StreamRequest\n\nStreamRequest\n=============\n\nclass public\n\nA class for specifying properties of the stream request.\n\nConstructor\n-----------\n\n### StreamRequest\n\nnew\nStreamRequest()\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 for stream variant\npreference.\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### consentSettings\n\n(null or non-null [ConsentSettings](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/ConsentSettings))\n\nSettings related to regulations and consent.\n\n### format\n\nstring\n\nThe stream format to request. Accepts the following string values:\n\n- `hls` (default)\n- `dash`\n\n. If an invalid string is provided, the default value will be used. 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### senderCanSkip\n\nboolean\n\nWhether or not the sender(s) display a CAF skip UI to the end user.\nUsed to enable skippable ads.\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."]]
