Method: adEvents.ingest

فهرستی از منابع AdEvent را در گوگل آنالیتیکس آپلود می‌کند.

این ویژگی فقط برای حساب‌های کاربری موجود در یک لیست مجاز در دسترس است.

درخواست HTTP

POST https://datamanager.googleapis.com/v1/adEvents:ingest

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
فیلدها
adEvents[]

object ( AdEvent )

الزامی. الزامی (حداقل ۱ مورد). فهرستی از رویدادهای تبلیغاتی.

encryptionInfo

object ( EncryptionInfo )

اختیاری. اطلاعات مربوط به کلیدهای رمزگذاری که برای رمزگذاری داده‌ها استفاده می‌شوند.

validateOnly

boolean

اختیاری. اگر درست باشد، درخواست اعتبارسنجی می‌شود، اما اجرا نمی‌شود.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ خالی است.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager

رویداد تبلیغاتی

یک رویداد تبلیغاتی.

نمایش JSON
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "campaignId": string,
  "campaignName": string,
  "adGroupId": string,
  "adId": string,
  "adHeight": integer,
  "adWidth": integer,
  "regionCode": string,
  "source": string,
  "medium": string,
  "attributionHint": enum (AttributionHint),
  "viewabilityInfo": {
    object (ViewabilityInfo)
  },

  // Union field event_subtype_oneof can be only one of the following:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of list of possible types for union field event_subtype_oneof.

  // Union field ad_type_oneof can be only one of the following:
  "adType": enum (AdType),
  "adTypeString": string
  // End of list of possible types for union field ad_type_oneof.

  // Union field ad_format_oneof can be only one of the following:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of list of possible types for union field ad_format_oneof.

  // Union field ad_placement_oneof can be only one of the following:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of list of possible types for union field ad_placement_oneof.

  // Union field targeting_type_oneof can be only one of the following:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of list of possible types for union field targeting_type_oneof.

  // Union field platform_type_oneof can be only one of the following:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of list of possible types for union field platform_type_oneof.

  // Union field platform_oneof can be only one of the following:
  "platform": enum (Platform),
  "platformString": string
  // End of list of possible types for union field platform_oneof.
  "measurementAllowed": boolean
}
فیلدها
advertiserId

string

الزامی. شناسه تبلیغ‌کننده برای رویداد تبلیغاتی.

این باید با شناسه ارسال شده در جریان پیوند مطابقت داشته باشد.

eventType

enum ( EventType )

الزامی. نوع رویداد.

timestamp

string ( Timestamp format)

الزامی. زمان وقوع رویداد.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

eventId

string

اختیاری. شناسه‌ای که توسط تماس‌گیرنده ایجاد و مدیریت می‌شود و به طور منحصر به فرد این رویداد را مشخص می‌کند.

اگر می‌خواهید رویدادهای تبلیغاتی که در چندین درخواست گنجانده شده‌اند را حذف کنید، الزامی است. در غیر این صورت، این فیلد اختیاری است.

userData

object ( UserData )

اختیاری. چندین قطعه داده ارائه شده توسط کاربر، که نشان دهنده کاربری است که رویداد با آن مرتبط است.

می‌توان چندین نمونه از یک نوع داده (مثلاً آدرس ایمیل) ارائه داد. هرچه داده‌های بیشتری ارائه شود، احتمال یافتن تطابق بیشتر می‌شود.

deviceInfo

object ( DeviceInfo )

اختیاری. اطلاعات جمع‌آوری‌شده در مورد دستگاهی که هنگام نمایش تبلیغ استفاده شده است.

mobileDeviceId

string

اختیاری. شناسه دستگاهی که تبلیغ به آن نمایش داده شده است.

campaignId

string

الزامی. شناسه کمپین مرتبط.

campaignName

string

الزامی. نام کمپین مرتبط.

adGroupId

string

اختیاری. شناسه گروه تبلیغاتی مرتبط.

adId

string

اختیاری. شناسه تبلیغ مرتبط در گروه.

adHeight

integer

اختیاری. ارتفاع تبلیغ بر حسب پیکسل.

adWidth

integer

اختیاری. عرض تبلیغ بر حسب پیکسل.

regionCode

string

الزامی. کشور به علاوه‌ی تقسیمات کشوری بر اساس استاندارد ISO 3166-2.

source

string

الزامی. منبع پلتفرم تبلیغ، مشابه منبع گوگل آنالیتیکس.

medium

string

الزامی. رسانه‌ی تبلیغ، مشابه رسانه‌ی گوگل آنالیتیکس.

attributionHint

enum ( AttributionHint )

اختیاری. وضعیت انتساب فرض‌شده توسط شریک برای این رویداد تبلیغاتی.

این فقط به عنوان نشانه‌ای برای چگونگی انتساب فرضی شریک عمل می‌کند و نتیجه نهایی را در گزارش‌های نهایی الزامی نمی‌کند.

viewabilityInfo

object ( ViewabilityInfo )

الزامی. جزئیات میزان بازدید تبلیغ ارائه شده.

فیلد متحد event_subtype_oneof . اختیاری. طبقه‌بندی اضافی در مورد نوع رویداد تبلیغ.

یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته می‌شود. در صورت امکان، enum ترجیح داده می‌شود. event_subtype_oneof فقط می‌تواند یکی از موارد زیر باشد:

eventSubtype

enum ( EventSubtype )

مقدار شمارشی برای زیرنوع رویداد.

eventSubtypeString

string

مقدار رشته‌ای برای زیرنوع رویداد.

فیلد ad_type_oneof اختیاری. نوع تبلیغ ارائه شده.

یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته می‌شود. در صورت امکان، enum ترجیح داده می‌شود. ad_type_oneof فقط می‌تواند یکی از موارد زیر باشد:

adType

enum ( AdType )

مقدار شمارشی برای نوع تبلیغ.

adTypeString

string

مقدار رشته‌ای برای نوع تبلیغ.

فیلد واحد ad_format_oneof . اختیاری. نوع تبلیغ ارائه شده.

یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته می‌شود. در صورت امکان، enum ترجیح داده می‌شود. ad_format_oneof فقط می‌تواند یکی از موارد زیر باشد:

adFormat

enum ( AdFormat )

مقدار شمارشی برای قالب تبلیغ.

adFormatString

string

مقدار رشته‌ای برای قالب تبلیغ.

فیلد ad_placement_oneof اختیاری. محل قرارگیری تبلیغ نمایش داده شده.

یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته می‌شود. در صورت امکان، enum ترجیح داده می‌شود. ad_placement_oneof فقط می‌تواند یکی از موارد زیر باشد:

adPlacement

enum ( AdPlacement )

مقدار شمارشی برای قرار دادن تبلیغ.

adPlacementString

string

مقدار رشته‌ای برای قرار دادن تبلیغ.

فیلد targeting_type_oneof یونیون. اختیاری. نوع هدف‌گیری مورد استفاده برای نمایش تبلیغ.

یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته می‌شود. در صورت امکان، enum ترجیح داده می‌شود. targeting_type_oneof فقط می‌تواند یکی از موارد زیر باشد:

targetingType

enum ( TargetingType )

مقدار شمارشی برای نوع هدف‌گیری.

targetingTypeString

string

مقدار رشته‌ای برای نوع هدف‌گیری.

فیلد اتحادیه platform_type_oneof . اختیاری. نوع پلتفرمی که تبلیغ در آن نمایش داده شده است.

یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته می‌شود. در صورت امکان، enum ترجیح داده می‌شود. platform_type_oneof فقط می‌تواند یکی از موارد زیر باشد:

platformType

enum ( PlatformType )

مقدار شمارشی برای نوع پلتفرم.

platformTypeString

string

مقدار رشته‌ای برای نوع پلتفرم.

فیلد اتحادیه platform_oneof . اختیاری. جزئیات بیشتر پلتفرمی که تبلیغ در آن نمایش داده شده است.

یک رشته خام برای مدیریت مقادیری غیر از enumهای خالص پذیرفته می‌شود. در صورت امکان، enum ترجیح داده می‌شود. platform_oneof فقط می‌تواند یکی از موارد زیر باشد:

platform

enum ( Platform )

مقدار شمارشی برای پلتفرم.

platformString

string

مقدار رشته‌ای برای پلتفرم.

measurementAllowed

boolean

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

نوع رویداد

نوع رویداد.

انوم‌ها
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_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_HEADER قرار دادن سربرگ.
AD_PLACEMENT_HOME قرار دادن در منزل.
AD_PLACEMENT_IN_CONTENT جایگذاری درون محتوا.
AD_PLACEMENT_PROMOTED جایگاه ارتقا یافته.
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": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
فیلدها
viewType

enum ( ViewType )

الزامی. نوع رویداد.

viewablePercent

integer

اختیاری. درصد عددی (0-100) از پیکسل‌هایی که قابل مشاهده بودند.

viewableDuration

string ( Duration format)

اختیاری. مدت زمانی که تبلیغ قابل مشاهده بوده است.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

mediaSkippable

boolean

اختیاری. اینکه آیا رسانه تبلیغاتی قابل رد شدن بود یا خیر.

mediaQuartile

enum ( MediaQuartile )

اختیاری. تعداد رسانه‌هایی که به صورت چارک‌های گسسته پخش شده‌اند.

mediaDuration

string ( Duration format)

اختیاری. مدت زمان رسانه تبلیغاتی.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

mediaVolumePercent

integer

اختیاری. درصد عددی (0-100) از میزان صدای پخش رسانه.

playbackDuration

string ( Duration format)

اختیاری. مدت زمان پخش رسانه تبلیغاتی، صرف نظر از اینکه قابل مشاهده بوده یا خیر.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

نوع نمایش

نوع رویداد.

انوم‌ها
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 کامل.