- درخواست HTTP
- درخواست بدنه
- بدنه پاسخ
- دامنههای مجوز
- رویداد تبلیغاتی
- نوع رویداد
- زیرنوع رویداد
- نوع تبلیغ
- قالب آگهی
- جایگذاری تبلیغات
- نوع هدفگیری
- نوع پلتفرم
- پلتفرم
- انتسابهینت
- اطلاعات قابلیت مشاهده
- نوع نمایش
- مدیاکوارتیل
- امتحانش کن!
فهرستی از منابع AdEvent را در گوگل آنالیتیکس آپلود میکند.
این ویژگی فقط برای حسابهای کاربری موجود در یک لیست مجاز در دسترس است.
درخواست HTTP
POST https://datamanager.googleapis.com/v1/adEvents:ingest
این URL از سینتکس Transcoding در gRPC استفاده میکند.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "adEvents": [ { object ( |
| فیلدها | |
|---|---|
adEvents[] | الزامی. الزامی (حداقل ۱ مورد). فهرستی از رویدادهای تبلیغاتی. |
encryptionInfo | اختیاری. اطلاعات مربوط به کلیدهای رمزگذاری که برای رمزگذاری دادهها استفاده میشوند. |
validateOnly | اختیاری. اگر درست باشد، درخواست اعتبارسنجی میشود، اما اجرا نمیشود. |
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ خالی است.
دامنههای مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/datamanager
رویداد تبلیغاتی
یک رویداد تبلیغاتی.
| نمایش JSON |
|---|
{ "advertiserId": string, "eventType": enum ( |
| فیلدها | |
|---|---|
advertiserId | الزامی. شناسه تبلیغکننده برای رویداد تبلیغاتی. این باید با شناسه ارسال شده در جریان پیوند مطابقت داشته باشد. |
eventType | الزامی. نوع رویداد. |
timestamp | الزامی. زمان وقوع رویداد. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
eventId | اختیاری. شناسهای که توسط تماسگیرنده ایجاد و مدیریت میشود و به طور منحصر به فرد این رویداد را مشخص میکند. اگر میخواهید رویدادهای تبلیغاتی که در چندین درخواست گنجانده شدهاند را حذف کنید، الزامی است. در غیر این صورت، این فیلد اختیاری است. |
userData | اختیاری. چندین قطعه داده ارائه شده توسط کاربر، که نشان دهنده کاربری است که رویداد با آن مرتبط است. میتوان چندین نمونه از یک نوع داده (مثلاً آدرس ایمیل) ارائه داد. هرچه دادههای بیشتری ارائه شود، احتمال یافتن تطابق بیشتر میشود. |
deviceInfo | اختیاری. اطلاعات جمعآوریشده در مورد دستگاهی که هنگام نمایش تبلیغ استفاده شده است. |
mobileDeviceId | اختیاری. شناسه دستگاهی که تبلیغ به آن نمایش داده شده است. |
campaignId | الزامی. شناسه کمپین مرتبط. |
campaignName | الزامی. نام کمپین مرتبط. |
adGroupId | اختیاری. شناسه گروه تبلیغاتی مرتبط. |
adId | اختیاری. شناسه تبلیغ مرتبط در گروه. |
adHeight | اختیاری. ارتفاع تبلیغ بر حسب پیکسل. |
adWidth | اختیاری. عرض تبلیغ بر حسب پیکسل. |
regionCode | الزامی. کشور به علاوهی تقسیمات کشوری بر اساس استاندارد ISO 3166-2. |
source | الزامی. منبع پلتفرم تبلیغ، مشابه منبع گوگل آنالیتیکس. |
medium | الزامی. رسانهی تبلیغ، مشابه رسانهی گوگل آنالیتیکس. |
attributionHint | اختیاری. وضعیت انتساب فرضشده توسط شریک برای این رویداد تبلیغاتی. این فقط به عنوان نشانهای برای چگونگی انتساب فرضی شریک عمل میکند و نتیجه نهایی را در گزارشهای نهایی الزامی نمیکند. |
viewabilityInfo | الزامی. جزئیات میزان بازدید تبلیغ ارائه شده. |
فیلد متحد یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته میشود. در صورت امکان، enum ترجیح داده میشود. | |
eventSubtype | مقدار شمارشی برای زیرنوع رویداد. |
eventSubtypeString | مقدار رشتهای برای زیرنوع رویداد. |
فیلد یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته میشود. در صورت امکان، enum ترجیح داده میشود. | |
adType | مقدار شمارشی برای نوع تبلیغ. |
adTypeString | مقدار رشتهای برای نوع تبلیغ. |
فیلد واحد یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته میشود. در صورت امکان، enum ترجیح داده میشود. | |
adFormat | مقدار شمارشی برای قالب تبلیغ. |
adFormatString | مقدار رشتهای برای قالب تبلیغ. |
فیلد یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته میشود. در صورت امکان، enum ترجیح داده میشود. | |
adPlacement | مقدار شمارشی برای قرار دادن تبلیغ. |
adPlacementString | مقدار رشتهای برای قرار دادن تبلیغ. |
فیلد یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته میشود. در صورت امکان، enum ترجیح داده میشود. | |
targetingType | مقدار شمارشی برای نوع هدفگیری. |
targetingTypeString | مقدار رشتهای برای نوع هدفگیری. |
فیلد اتحادیه یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته میشود. در صورت امکان، enum ترجیح داده میشود. | |
platformType | مقدار شمارشی برای نوع پلتفرم. |
platformTypeString | مقدار رشتهای برای نوع پلتفرم. |
فیلد اتحادیه یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته میشود. در صورت امکان، enum ترجیح داده میشود. | |
platform | مقدار شمارشی برای پلتفرم. |
platformString | مقدار رشتهای برای پلتفرم. |
measurementAllowed | اختیاری. نشان میدهد که آیا ردیف مجاز به استفاده برای اهداف اندازهگیری است، طبق قوانین حفظ حریم خصوصی مربوطه در حوزه قضایی منطقهای. |
نوع رویداد
نوع رویداد.
| انومها | |
|---|---|
EVENT_TYPE_UNSPECIFIED | نوع رویداد نامشخص |
EVENT_TYPE_VIEW | مشاهده رویداد. |
EVENT_TYPE_CLICK | روی رویداد کلیک کنید. |
زیرنوع رویداد
طبقهبندی اضافی در مورد نوع رویداد تبلیغاتی.
| انومها | |
|---|---|
EVENT_SUBTYPE_UNSPECIFIED | زیرگروه رویداد نامشخص. |
EVENT_SUBTYPE_IMPRESSION | رویداد تأثیرگذاری. |
EVENT_SUBTYPE_ENGAGED_VIEW | رویداد بازدید تعاملی. |
EVENT_SUBTYPE_ONSITE_CLICK | رویداد کلیک در محل. |
EVENT_SUBTYPE_OUTBOUND_CLICK | رویداد کلیک خروجی |
نوع تبلیغ
نوع تبلیغ ارائه شده.
| انومها | |
|---|---|
AD_TYPE_UNSPECIFIED | نوع تبلیغ نامشخص |
AD_TYPE_DISPLAY | نمایش تبلیغ. |
AD_TYPE_TEXT | تبلیغ متنی. |
AD_TYPE_IMAGE | تبلیغ تصویری. |
AD_TYPE_RICH_MEDIA | تبلیغ رسانهای غنی. |
AD_TYPE_HTML | تبلیغ HTML. |
AD_TYPE_AUDIO | تبلیغ صوتی. |
AD_TYPE_VIDEO | تبلیغ ویدیویی. |
قالب آگهی
قالب تبلیغ ارائه شده.
| انومها | |
|---|---|
AD_FORMAT_UNSPECIFIED | قالب تبلیغ نامشخص. |
AD_FORMAT_AR | تبلیغ AR. |
AD_FORMAT_AUDIO | تبلیغ صوتی. |
AD_FORMAT_BANNER | بنر تبلیغاتی. |
AD_FORMAT_BUMPER | تبلیغ روی سپر ماشین. |
AD_FORMAT_CAROUSEL | تبلیغ چرخ و فلکی. |
AD_FORMAT_COLLECTION | آگهی کلکسیون. |
AD_FORMAT_IMAGE | تبلیغ تصویری. |
AD_FORMAT_INTERACTIVE | تبلیغ تعاملی. |
AD_FORMAT_INTERSTITIAL | تبلیغ بینابینی. |
AD_FORMAT_IN_FEED | تبلیغ درون فید. |
AD_FORMAT_IN_STREAM | تبلیغ درون استریم. |
AD_FORMAT_IN_STREAM_SKIPPABLE | تبلیغ قابل رد شدن در حین پخش زنده. |
AD_FORMAT_IN_STREAM_NON_SKIPPABLE | تبلیغ غیرقابل رد شدن در حین پخش زنده. |
AD_FORMAT_NATIVE | تبلیغ بومی. |
AD_FORMAT_SHORTS | تبلیغ شلوارک. |
AD_FORMAT_STORY | تبلیغ داستانی. |
AD_FORMAT_SPONSORED | تبلیغ حمایتشده. |
AD_FORMAT_VIDEO | تبلیغ ویدیویی. |
جایگذاری تبلیغات
محل قرارگیری تبلیغ ارائه شده.
| انومها | |
|---|---|
AD_PLACEMENT_UNSPECIFIED | محل قرارگیری تبلیغات نامشخص. |
AD_PLACEMENT_DISCOVER | جایگاه را کشف کنید. |
AD_PLACEMENT_FEED | قرار دادن خوراک. |
AD_PLACEMENT_FOOTER | قرار دادن پاورقی. |
AD_PLACEMENT_HEADER | قرار دادن سربرگ. |
AD_PLACEMENT_HOME | قرار دادن در منزل. |
AD_PLACEMENT_IN_CONTENT | جایگذاری درون محتوا. |
AD_PLACEMENT_PROMOTED | جایگاه ارتقا یافته. |
AD_PLACEMENT_SEARCH | جستجوی مکان قرارگیری. |
AD_PLACEMENT_STORY | قرار دادن داستان. |
نوع هدفگیری
نوع هدفگیری مورد استفاده برای نمایش تبلیغ.
| انومها | |
|---|---|
TARGETING_TYPE_UNSPECIFIED | نوع هدفگیری نامشخص. |
TARGETING_TYPE_AUDIENCE | هدفگیری مخاطبان. |
TARGETING_TYPE_CONTEXTUAL | هدفگذاری زمینهای. |
TARGETING_TYPE_DEMOGRAPHIC | هدفگذاری جمعیتی. |
TARGETING_TYPE_DEVICE | هدفگیری دستگاه. |
TARGETING_TYPE_GEO | هدفگیری جغرافیایی |
TARGETING_TYPE_INTEREST | هدفگذاری علایق. |
TARGETING_TYPE_PURCHASE_INTENT | هدفگذاری قصد خرید. |
TARGETING_TYPE_REMARKETING | هدفگذاری بازاریابی مجدد. |
نوع پلتفرم
نوع پلتفرمی که تبلیغ در آن ارائه شده است.
| انومها | |
|---|---|
PLATFORM_TYPE_UNSPECIFIED | نوع پلتفرم مشخص نشده است. |
PLATFORM_TYPE_MOBILE | پلتفرم موبایل. |
PLATFORM_TYPE_DESKTOP | پلتفرم دسکتاپ. |
PLATFORM_TYPE_CTV | پلتفرم سی تی وی |
PLATFORM_TYPE_PHONE | پلتفرم گوشی. |
PLATFORM_TYPE_TABLET | پلتفرم تبلت. |
پلتفرم
جزئیات بیشتر پلتفرمی که تبلیغ در آن نمایش داده شده است.
| انومها | |
|---|---|
PLATFORM_UNSPECIFIED | پلتفرم نامشخص. |
PLATFORM_IOS | پلتفرم iOS. |
PLATFORM_ANDROID | پلتفرم اندروید. |
PLATFORM_WEB | پلتفرم وب. |
انتسابهینت
وضعیت انتساب فرضشده توسط شریک برای این رویداد تبلیغاتی.
| انومها | |
|---|---|
ATTRIBUTION_HINT_UNSPECIFIED | وضعیت انتساب نامشخص. |
ATTRIBUTION_HINT_CONVERTED | وضعیت تبدیل شده. |
ATTRIBUTION_HINT_NOT_CONVERTED | وضعیت تبدیل نشده. |
اطلاعات قابلیت مشاهده
جزئیات مربوط به میزان بازدید تبلیغ ارائه شده.
| نمایش JSON |
|---|
{ "viewType": enum ( |
| فیلدها | |
|---|---|
viewType | الزامی. نوع رویداد. |
viewablePercent | اختیاری. درصد عددی (0-100) از پیکسلهایی که قابل مشاهده بودند. |
viewableDuration | اختیاری. مدت زمانی که تبلیغ قابل مشاهده بوده است. مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' |
mediaSkippable | اختیاری. اینکه آیا رسانه تبلیغاتی قابل رد شدن بود یا خیر. |
mediaQuartile | اختیاری. تعداد رسانههایی که به صورت چارکهای گسسته پخش شدهاند. |
mediaDuration | اختیاری. مدت زمان رسانه تبلیغاتی. مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' |
mediaVolumePercent | اختیاری. درصد عددی (0-100) از میزان صدای پخش رسانه. |
playbackDuration | اختیاری. مدت زمان پخش رسانه تبلیغاتی، صرف نظر از اینکه قابل مشاهده بوده یا خیر. مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' |
نوع نمایش
نوع رویداد.
| انومها | |
|---|---|
VIEW_TYPE_UNSPECIFIED | نوع نمایش نامشخص. |
VIEW_TYPE_MRC_VIEWED | MRC مشاهده شد. |
VIEW_TYPE_MRC_RENDERED | MRC ارائه داد. |
مدیاکوارتیل
میزان رسانههایی که به صورت چارکهای گسسته پخش شدهاند.
| انومها | |
|---|---|
MEDIA_QUARTILE_UNSPECIFIED | چارک رسانهای نامشخص. |
MEDIA_QUARTILE_START | شروع کنید. |
MEDIA_QUARTILE_FIRST_QUARTILE | چارک اول. |
MEDIA_QUARTILE_MIDPOINT | نقطه میانی |
MEDIA_QUARTILE_THIRD_QUARTILE | چارک سوم. |
MEDIA_QUARTILE_COMPLETE | کامل. |