تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
NonceRequest
classpublic
يُستخدَم NonceRequest لتخزين معلومات عن طلب الحصول على مفتاح تشفير عشوائي.
الشركة المصنِّعة
NonceRequest
new
NonceRequest()
الأدوات
WebNonceRequestInterface
الخصائص
adWillAutoPlay
(قيمة فارغة أو منطقية)
اضبط هذا الخيار على "صحيح" إذا كان سيتم تشغيل الإعلان تلقائيًا بدون انتظار تفاعل العميل. اضبط القيمة على false إذا كان الإعلان سينتظر تفاعل المستخدم قبل
تشغيله.
adWillPlayMuted
(قيمة فارغة أو منطقية)
اضبط القيمة على true إذا كان سيتم تشغيل الإعلان عندما يكون الصوت مكتومًا. اضبط هذه المَعلمة على false إذا كان سيتم تشغيل الإعلان
بدون كتم الصوت.
continuousPlayback
(قيمة فارغة أو منطقية)
اضبط القيمة على true إذا كان المشغّل ينوي تشغيل فيديوهات المحتوى باستمرار
بعد بعضها البعض مثل البث التلفزيوني أو قائمة تشغيل الفيديوهات. اضبطها على false
في حال عدم توفّر قيمة أخرى.
descriptionUrl
لضبط عنوان URL الوصفي للمحتوى الذي سيتم تشغيل الإعلان أثناءه
سيتم تجاهل أي سلسلة عنوان URL للوصف أطول من 500 حرف
واستبعادها من المفتاح المؤقت.
المَعلمة
descriptionUrl
سلسلة
المرتجعات
void
descriptionUrl
عنوان URL الوصفي للمحتوى الذي سيتم تشغيل الإعلان أثناءه
المرتجعات
string
iconsSupported
قيمة منطقية
ما إذا كان مشغّل الفيديو يتوافق مع رموز نموذج عرض إعلانات الفيديو (VAST)
nonceLengthLimit
الرقم
الحد الأقصى لطول الرمز المؤقت الذي تم إنشاؤه سيتم رفض وعد loadNonceManager
إذا كان المفتاح المؤقت أطول من هذا الحد. القيمة التلقائية هي
أكبر عدد صحيح ممكن. قد يؤدي اختيار حدّ أقصر للطول إلى
استبعاد سمات استهداف مختلفة من المفتاح المؤقت.
omidPartnerName
لضبط اسم الشريك الذي يدمج قياس OMID تتجاهل PAL أي سلسلة
اسم شريك أطول من 200 حرف وتستبعدها من
المفتاح المؤقت.
يجب أن يتطابق اسم الشريك مع الاسم المقدَّم لحزمة OM SDK لجلسة الإعلان. لمزيد من التفاصيل، يُرجى الاطّلاع على
دليل إعداد OM SDK.
يجب ضبط كل من omidPartnerName و
omidPartnerVersion لتضمين قيمة
omid_p= بنجاح في مفتاح nonce.
المَعلمة
omidPartnerName
سلسلة
المرتجعات
void
omidPartnerName
اسم الشريك الذي يدمج قياس OMID
المرتجعات
string
omidPartnerVersion
إصدار الشريك الذي يدمج قياس OMID سيتم تجاهل أي سلسلة إصدار
شريك أطول من 200 حرف واستبعادها
من المفتاح المؤقت.
يجب أن يتطابق هذا مع السلسلة المقدَّمة لحزمة تطوير البرامج OM SDK لجلسة الإعلان.
لتضمين قيمة omid_p= بنجاح في مفتاح nonce، يجب ضبط كل من
السمتَين omidPartnerVersion وomidPartnerName.
المَعلمة
omidPartnerVersion
سلسلة
المرتجعات
void
omidPartnerVersion
إصدار الشريك الذي يدمج قياس OMID
المرتجعات
string
playerType
لضبط نوع مشغّل الوسائط المقدَّم من الشريك يجب استخدام هذا الحقل لتحديد اسم
لاعب الشريك. سيتم تجاهل أي سلسلة من نوع اللاعب أطول من 200
حرف واستبعادها من المفتاح المؤقت.
المَعلمة
playerType
سلسلة
المرتجعات
void
playerType
نوع المشغّل الذي قدّمه الشريك
المرتجعات
string
playerVersion
لضبط إصدار المشغّل الذي قدّمه الشريك. يجب استخدام هذا الحقل لتحديد
إصدار مشغّل الشريك. سيتم تجاهل أي سلسلة إصدار لاعب أطول من
200 حرف واستبعادها من المفتاح المؤقت.
المَعلمة
playerVersion
سلسلة
المرتجعات
void
playerVersion
إصدار المشغّل الذي قدّمه الشريك
المرتجعات
string
ppid
لضبط المعرّف المقدَّم من الناشر سيتم تجاهل أي معرّف PPID أطول من 200 حرف
واستبعاده من المفتاح المؤقت.
المَعلمة
ppid
سلسلة
المرتجعات
void
ppid
المعرّف المقدَّم من الناشر
المرتجعات
string
sessionId
سلسلة
معرِّف الجلسة هو معرِّف عشوائي مؤقت. ويتم استخدامه حصريًا لتحديد
الحد الأقصى لعدد مرّات الظهور على أجهزة التلفزيون المتّصلة (أجهزة التلفزيون الذكية ووحدات التحكّم بالألعاب
وأجهزة الاستقبال الرقمية). يجب أن يكون معرّف الجلسة معرّفًا فريدًا عالميًا.
supportedApiFrameworks
صفيف من الأرقام غير الصفرية
صفيف من إطارات عمل واجهات برمجة التطبيقات المتوافقة يتم تحديد هذه القيم
في قائمة "إطارات عمل واجهة برمجة التطبيقات" في AdCOM 1.0.
مثال: يشير الرمز [2, 7, 9] إلى أنّ هذا المشغّل متوافق مع
VPAID 2.0 وOMID 1.0 وSIMID 1.1.
url
سلسلة
عنوان URL الذي سيتم استهداف الإعلانات عليه. تكون هذه الصفحة تلقائيًا
هي نفسها الصفحة التي ستعرض الإعلانات، ولكن يمكن ضبطها يدويًا.
تاريخ التعديل الأخير: 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."]]
