با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
NonceRequest
عمومیکلاس
NonceRequest برای ذخیره اطلاعات مربوط به درخواست nonce استفاده می شود.
سازنده
NonceRequest
NonceRequest () جدید
اجرا می کند
WebNonceRequestInterface
خواص
adWillAutoPlay
(تهی یا بولی)
اگر آگهی بدون انتظار برای تعامل کاربر پخش شود، روی true تنظیم کنید. اگر آگهی قبل از پخش منتظر تعامل کاربر باشد، روی false تنظیم کنید.
adWillPlayMuted
(تهی یا بولی)
اگر تبلیغ در حالت بی صدا پخش شود، روی true تنظیم کنید. اگر آگهی بدون صدا پخش شود، روی false تنظیم کنید.
پخش مداوم
(تهی یا بولی)
اگر پخش کننده قصد دارد به طور مداوم ویدیوهای محتوا را یکی پس از دیگری مانند پخش تلویزیونی یا لیست پخش ویدیو پخش کند، روی true تنظیم کنید. در غیر این صورت روی false تنظیم کنید.
توضیحات آدرس اینترنتی
URL توضیحات محتوایی را که طی آن تبلیغ پخش می شود را تنظیم می کند. هر رشته URL توضیحاتی بیش از 500 کاراکتر نادیده گرفته می شود و از nonce حذف می شود.
پارامتر
توضیحات آدرس اینترنتی
رشته
برمی گرداند
void
توضیحات آدرس اینترنتی
نشانی اینترنتی توضیحات محتوایی که طی آن تبلیغ پخش می شود.
برمی گرداند
string
نمادها پشتیبانی می شود
بولی
آیا نمادهای VAST توسط پخش کننده ویدیو پشتیبانی می شوند یا خیر.
nonceLengthLimit
شماره
حد طول nonce ایجاد شده. اگر nonce بیشتر از این حد باشد، وعده loadNonceManager رد خواهد شد. به طور پیش فرض به بزرگترین عدد صحیح ممکن می رسد. انتخاب محدودیت طول کوتاه‌تر ممکن است باعث شود که ویژگی‌های هدف‌گیری مختلف از nonce حذف شوند.
omidPartnerName
نام شریک ادغام اندازه گیری OMID را تنظیم می کند. PAL هر رشته نام شریک بیش از 200 کاراکتر را نادیده می گیرد و آن را از nonce مستثنی می کند.
نام شریک باید با نام ارائه شده به OM SDK برای جلسه تبلیغ مطابقت داشته باشد. برای جزئیات بیشتر، به راهنمای نصب OM SDK مراجعه کنید.
شما باید omidPartnerName و omidPartnerVersion را تنظیم کنید تا با موفقیت مقدار omid_p= را در یک nonce گنجانده شود.
پارامتر
omidPartnerName
رشته
برمی گرداند
void
omidPartnerName
نام شریکی که اندازه گیری OMID را ادغام می کند.
برمی گرداند
string
omidPartnerVersion
نسخه شریک که اندازه گیری OMID را یکپارچه می کند. هر رشته نسخه شریک بیش از 200 کاراکتر نادیده گرفته می شود و از nonce حذف می شود.
این باید با رشته ارائه شده به OM SDK برای جلسه تبلیغ مطابقت داشته باشد.
برای گنجاندن موفقیت آمیز مقدار omid_p= در یک nonce، هم این omidPartnerVersion و هم omidPartnerName باید تنظیم شوند.
پارامتر
omidPartnerVersion
رشته
برمی گرداند
void
omidPartnerVersion
نسخه شریک که اندازه گیری OMID را یکپارچه می کند.
برمی گرداند
string
نوع بازیکن
نوع پخش کننده ارائه شده توسط شریک را تنظیم می کند. این باید برای تعیین نام بازیکن شریک استفاده شود. هر رشته ای از نوع پخش کننده که بیش از 200 کاراکتر داشته باشد نادیده گرفته می شود و از nonce حذف می شود.
پارامتر
نوع بازیکن
رشته
برمی گرداند
void
نوع بازیکن
شریک نوع پخش کننده را ارائه کرد.
برمی گرداند
string
بازیکن نسخه
نسخه پخش کننده ارائه شده توسط شریک را تنظیم می کند. این باید برای تعیین نسخه پخش کننده شریک استفاده شود. هر رشته نسخه پخش کننده بیشتر از 200 کاراکتر نادیده گرفته می شود و از nonce حذف می شود.
پارامتر
بازیکن نسخه
رشته
برمی گرداند
void
بازیکن نسخه
شریک نسخه پخش کننده را ارائه کرد.
برمی گرداند
string
ppid
شناسه ارائه شده ناشر را تنظیم می کند. هر PPID بیشتر از 200 کاراکتر نادیده گرفته می شود و از nonce حذف می شود.
پارامتر
ppid
رشته
برمی گرداند
void
ppid
ناشر شناسه ارائه کرد.
برمی گرداند
string
شناسه جلسه
رشته
شناسه جلسه یک شناسه تصادفی موقت است. این به طور انحصاری برای محدود کردن فرکانس در تلویزیون های متصل (تلویزیون های هوشمند، کنسول های بازی و ست تاپ باکس) استفاده می شود. شناسه جلسه باید UUID باشد.
پشتیبانی از ApiFrameworks
آرایه اعداد غیر تهی
آرایه ای از چارچوب های API پشتیبانی شده. این مقادیر در لیست AdCOM 1.0 "API Frameworks" تعریف شده اند. مثال: [2, 7, 9] نشان می دهد که این پخش کننده از VPAID 2.0، OMID 1.0 و SIMID 1.1 پشتیبانی می کند.
آدرس اینترنتی
رشته
آدرس اینترنتی که تبلیغات به آن هدف قرار خواهد گرفت. به طور پیش فرض، این همان صفحه ای است که تبلیغات را نمایش می دهد، اما ممکن است به صورت دستی تنظیم شود.
تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003e\u003ccode\u003eNonceRequest\u003c/code\u003e stores information about a request for a nonce, impacting ad targeting and measurement.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties related to ad behavior, content, player capabilities, and partner integrations like OMID.\u003c/p\u003e\n"],["\u003cp\u003ePartners should set values for \u003ccode\u003eomidPartnerName\u003c/code\u003e, \u003ccode\u003eomidPartnerVersion\u003c/code\u003e, and \u003ccode\u003esupportedApiFrameworks\u003c/code\u003e to enable proper OMID integration.\u003c/p\u003e\n"],["\u003cp\u003eProperties like \u003ccode\u003edescriptionUrl\u003c/code\u003e, \u003ccode\u003eomidPartnerName\u003c/code\u003e, and others have character limits to ensure nonce validity.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esessionId\u003c/code\u003e property is specifically used for frequency capping on connected TVs.\u003c/p\u003e\n"]]],["The `NonceRequest` class stores information for a nonce request. Key properties include: ad autoplay/muted status, continuous playback, content description URL (max 500 chars), VAST icon support, and nonce length limit. OMID partner name/version (max 200 chars each), player type/version (max 200 chars each), and publisher-provided ID (PPID, max 200 chars) can be set. A session ID, supported API frameworks, target URL, and video dimensions are also included.\n"],null,["# Class: NonceRequest\n\nNonceRequest\n============\n\nclass public\n\nThe NonceRequest is used to store information about the request for a nonce.\n\nConstructor\n-----------\n\n### NonceRequest\n\nnew\nNonceRequest()\n\nImplements\n: WebNonceRequestInterface\n\nProperties\n----------\n\n### adWillAutoPlay\n\n(null or boolean)\n\nSet to true if the ad will be auto played without waiting for user\ninteraction. Set to false if the ad will wait for user interaction before\nbeing played.\n\n### adWillPlayMuted\n\n(null or boolean)\n\nSet to true if the ad will be played while muted. Set to false if the ad\nwill play unmuted.\n\n### continuousPlayback\n\n(null or boolean)\n\nSet to true if the player intends to continuously play the content videos\none after another similar to TV broadcast or video playlist. Set to false\notherwise.\n\n### descriptionUrl\n\n\u003cbr /\u003e\n\nSets the description URL of the content during which the ad will be played.\nAny description URL string longer than 500 characters will be ignored and\nexcluded from the nonce.\n\n| #### Parameter ||\n|----------------|--------|\n| descriptionUrl | string |\n\nReturns\n\n: `void`\n\n### descriptionUrl\n\n\u003cbr /\u003e\n\nThe description URL of the content during which the ad will be played.\n\nReturns\n\n: `string`\n\n### iconsSupported\n\nboolean\n\nWhether VAST icons are supported by the video player.\n\n### nonceLengthLimit\n\nnumber\n\nThe length limit of the generated nonce. The loadNonceManager promise\nwill be rejected if the nonce is longer than this limit. Defaults to the\nlargest possible integer. Choosing a shorter length limit may cause\nvarious targeting properties to be excluded from the nonce.\n\n### omidPartnerName\n\n\u003cbr /\u003e\n\nSets the name of the partner integrating OMID measurement. PAL ignores any\npartner name string longer than 200 characters and excludes it from the\nnonce.\n\nThe partner name must match the name supplied to the OM SDK for the ad\nsession. For further details, see the\n[OM SDK Onboarding\nGuide](https://iabtechlab.com/omsdk/docs/onboarding).\n\nYou must set both `omidPartnerName` and\n`omidPartnerVersion` to successfully include the\n`omid_p=` value in a nonce.\n\n| #### Parameter ||\n|-----------------|--------|\n| omidPartnerName | string |\n\nReturns\n\n: `void`\n\n### omidPartnerName\n\n\u003cbr /\u003e\n\nThe name of the partner integrating OMID measurement.\n\nReturns\n\n: `string`\n\n### omidPartnerVersion\n\n\u003cbr /\u003e\n\nThe version of the partner integrating OMID measurement. Any partner\nversion string longer than 200 characters will be ignored and excluded\nfrom the nonce.\n\nThis must match the string supplied to the OM SDK for the ad session.\n\nTo successfully include the `omid_p=` value in a nonce, both\nthis `omidPartnerVersion` and `omidPartnerName`\nmust be set.\n\n| #### Parameter ||\n|--------------------|--------|\n| omidPartnerVersion | string |\n\nReturns\n\n: `void`\n\n### omidPartnerVersion\n\n\u003cbr /\u003e\n\nThe version of the partner integrating OMID measurement.\n\nReturns\n\n: `string`\n\n### playerType\n\n\u003cbr /\u003e\n\nSets the partner provided player type. This should be used to specify the\nname of the partner player. Any player type string longer than 200\ncharacters will be ignored and excluded from the nonce.\n\n| #### Parameter ||\n|------------|--------|\n| playerType | string |\n\nReturns\n\n: `void`\n\n### playerType\n\n\u003cbr /\u003e\n\nThe partner provided player type.\n\nReturns\n\n: `string`\n\n### playerVersion\n\n\u003cbr /\u003e\n\nSets the partner provided player version. This should be used to specify\nthe version of the partner player. Any player version string longer than\n200 characters will be ignored and excluded from the nonce.\n\n| #### Parameter ||\n|---------------|--------|\n| playerVersion | string |\n\nReturns\n\n: `void`\n\n### playerVersion\n\n\u003cbr /\u003e\n\nThe partner provided player version.\n\nReturns\n\n: `string`\n\n### ppid\n\n\u003cbr /\u003e\n\nSets the publisher provided ID. Any PPID longer than 200 characters will be\nignored and excluded from the nonce.\n\n| #### Parameter ||\n|------|--------|\n| ppid | string |\n\nReturns\n\n: `void`\n\n### ppid\n\n\u003cbr /\u003e\n\nThe publisher provided ID.\n\nReturns\n\n: `string`\n\n### sessionId\n\nstring\n\nThe session ID is a temporary random ID. It is used exclusively for\nfrequency capping on connected TVs (smart TVs, game consoles, and\nset-top-boxes). A session ID must be a UUID.\n\n### supportedApiFrameworks\n\nnon-null Array of number\n\nAn array of supported API frameworks. These values are defined\nin the AdCOM 1.0 \"API Frameworks\" list.\nExample: `[2, 7, 9]` indicates this player supports\nVPAID 2.0, OMID 1.0, and SIMID 1.1.\n\n### url\n\nstring\n\nThe URL to which the ads will be targeted. By default, this is the same\nas the page that will display the ads, but it may be manually set.\n\n### videoHeight\n\nnumber\n\nThe height of the ad video element.\n\n### videoWidth\n\nnumber\n\nThe width of the ad video element."]]
