Skip to main content

کلید‌های اعلان#

در این صفحه لیست تمامی کلید‌های اعلان به همراه توضیح آن‌ها قابل مشاهده می‌باشد. قالب کلی اعلان یک دیکشنری است که کلید های زیر را درون خود نگه می‌دارد.

app_ids#

app_ids

استفاده: اجباری در همه نوع اعلان
کلید پدر: -
نوع مقدار: رشته string
توضیحات: این کلید بیانگر شناسه اپلیکیشن می‌باشد که برای همه انواع اعلان اجباری می‌باشد

data#

data

استفاده: اجباری
کلید پدر: -
نوع مقدار: دیکشنری
توضیحات: این کلید که از نوع دیکشنری می‌باشد برای نگه داری مقادیر محتوایی که قرار است در اعلان نمایش داده شوند نظیر عنوان، متن، آیکن و ... به کار می‌رود. در صورت استفاده از این کلید ، حتما باید مقدار داشته باشد.

title#

data.title

استفاده: (در صورت استفاده از کلید data) اجباری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: عنوان اعلانی که در دستگاه نمایش داده می‌شود

content#

data.content

استفاده: (در صورت استفاده از کلید data) اجباری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: متن اعلانی که در دستگاه نمایش داده می‌شود

icon#

data.icon

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: آیکن اعلانی که در دستگاه نمایش داده می‌شود
توصیه می‌شود که حتما از https برای آدرس آیکن استفاده شود

image#

data.image

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: عکس اعلانی که در دستگاه نمایش داده می‌شود.
توصیه می‌شود که حتما از https برای آدرس عکس استفاده شود

action#

data.action

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: دیکشنری
توضیحات: این کلید یک دیکشنری می‌باشد که مقادیر مربوط به اکشن اعلان نظیر باز کردن وب‌سایت و یا باز کردن یه آدرس و ... را نگه می‌دارد

action_type#

data.action.action_type

استفاده: اختیاری
کلید پدر: کلید action
نوع مقدار:
توضیحات: نوع عملکرد اعلان
مشاهده لیست تمامی عملکرد‌های اعلان

url#

data.action.url

استفاده: اختیاری
کلید پدر: کلید action
نوع مقدار:
توضیحات: مقدار یا عملکردی است که اکشن اعلان انجام می‌دهد
مشاهده لیست تمامی عملکرد‌های اعلان و url های مرتبط

buttons#

data.buttons

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: لیست
توضیحات: لیستی از button ها می باشد
هر button یک دیکشنری می‌باشد که کلید‌هایی نظیر btn_action, btn_order , ... را در برمیگیرد

[button]#

data.buttons

استفاده: اختیاری
کلید پدر: کلید buttons
نوع مقدار: دیکشنری
توضیحات:
(این کلید وجود ندارد) ، صرفا بیانگر این است که button یک دیکشنری درون کلید buttons می باشد که کلیدهایی که در ادامه توضیح داده می‌شود را نگه می‌دارد.

btn_order#

data.buttons.button.btn_order

استفاده: در صورت استفاده از button(s) این کلید اجباری می‌باشد
کلید پدر: کلید button
نوع مقدار: نوع عددی integer
توضیحات: ترتیب قرار گیری buttons در اعلان

btn_content#

data.buttons.button.btn_content

استفاده: اختیاری
کلید پدر: کلید button
نوع مقدار: رشته string
توضیحات: متن button

btn_icon#

data.buttons.button.btn_icon

استفاده: اختیاری
کلید پدر: کلید button
نوع مقدار: رشته string
توضیحات: آیکن button
مشاهده لیست آیکن‌های اعلان

btn_action#

data.buttons.button.btn_action

استفاده: اختیاری
کلید پدر: کلید button
نوع مقدار: دیکشنری
توضیحات: همانند کلید action می‌باشد و دو کلید action_type , url قبول می‌کند که مقادیر آنها را می توانید در قسمت اکشن‌های اعلان مشاهده کنید.

close_on_click#

close_on_click

استفاده: اختیاری
کلید پدر: -
نوع مقدار: بولین (true یا false)
توضیحات: باقی ماندن پیام تا کلیک کاربر