Method: events.ingest

فهرستی از منابع Event را از Destination ارائه شده آپلود می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
فیلدها
destinations[]

object ( Destination )

مورد نیاز. لیست مقصدهایی که رویدادها را به آنها ارسال کنید.

events[]

object ( Event )

مورد نیاز. لیست رویدادها برای ارسال به مقصدهای مشخص شده. حداکثر 2000 منبع Event را می توان در یک درخواست ارسال کرد.

consent

object ( Consent )

اختیاری. درخواست رضایت در سطح درخواست برای اعمال همه کاربران در درخواست. رضایت در سطح کاربر بر رضایت سطح درخواست لغو می شود و می توان آن را در هر Event مشخص کرد.

validateOnly

boolean

اختیاری. برای اهداف آزمایشی اگر true ، درخواست تأیید می شود اما اجرا نمی شود. فقط خطاها برگردانده می شوند، نه نتایج.

encoding

enum ( Encoding )

اختیاری. برای آپلود UserData مورد نیاز است. نوع رمزگذاری شناسه های کاربر. برای شناسه های کاربر هش شده، این نوع رمزگذاری رشته هش شده است. برای شناسه های کاربر هش شده رمزگذاری شده، این نوع رمزگذاری رشته رمزگذاری شده خارجی است، اما لزوماً رشته هش شده داخلی نیست، به این معنی که رشته هش شده داخلی می تواند به روشی متفاوت از رشته رمزگذاری شده خارجی رمزگذاری شود. برای آپلودهای غیر UserData ، این قسمت نادیده گرفته می شود.

encryptionInfo

object ( EncryptionInfo )

اختیاری. اطلاعات رمزگذاری برای آپلود UserData . اگر تنظیم نشود، فرض بر این است که اطلاعات شناسایی آپلود شده هش شده است اما رمزگذاری نشده است. برای آپلودهای غیر UserData ، این قسمت نادیده گرفته می شود.

بدن پاسخگو

پاسخ از IngestEventsRequest .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "requestId": string
}
فیلدها
requestId

string

شناسه درخواستی که به صورت خودکار ایجاد شده است.

محدوده مجوز

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

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

رویداد

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

نمایندگی JSON 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
فیلدها
destinationReferences[]

string

اختیاری. رشته مرجع برای تعیین مقصد استفاده می شود. در صورت خالی بودن، رویداد به تمام destinations در درخواست ارسال می شود.

transactionId

string

مورد نیاز. شناسه منحصر به فرد این رویداد.

eventTimestamp

string ( Timestamp format)

مورد نیاز. زمانی که واقعه رخ داد.

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

lastUpdatedTimestamp

string ( Timestamp format)

اختیاری. آخرین باری که رویداد به روز شد.

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

userData

object ( UserData )

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

consent

object ( Consent )

اختیاری. اطلاعاتی در مورد اینکه آیا کاربر مرتبط انواع مختلفی از رضایت را ارائه کرده است یا خیر.

adIdentifiers

object ( AdIdentifiers )

اختیاری. شناسه ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت های آنلاین (مانند کلیک های تبلیغاتی).

currency

string

اختیاری. کد ارز مرتبط با تمام مقادیر پولی در این رویداد.

conversionValue

number

اختیاری. ارزش تبدیل مرتبط با رویداد، برای تبدیل‌های مبتنی بر ارزش.

eventSource

enum ( EventSource )

اختیاری. سیگنال محل وقوع رویداد (وب، برنامه، فروشگاه و غیره).

eventDeviceInfo

object ( DeviceInfo )

اختیاری. اطلاعات جمع آوری شده در مورد دستگاه مورد استفاده (در صورت وجود) هنگام وقوع رویداد.

cartData

object ( CartData )

اختیاری. اطلاعات مربوط به تراکنش و موارد مرتبط با رویداد.

customVariables[]

object ( CustomVariable )

اختیاری. اطلاعات اضافی جفت کلید/مقدار برای ارسال به کانتینرهای تبدیل (عمل تبدیل یا فعالیت FL).

experimentalFields[]

object ( ExperimentalField )

اختیاری. فهرستی از جفت‌های کلید/مقدار برای فیلدهای آزمایشی که ممکن است در نهایت به عنوان بخشی از API تبلیغ شوند.

userProperties

object ( UserProperties )

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

شناسه های تبلیغاتی

شناسه ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت های آنلاین (مانند کلیک های تبلیغاتی).

نمایندگی JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  }
}
فیلدها
sessionAttributes

string

اختیاری. ویژگی‌های جلسه برای اسناد و مدل‌سازی رویداد.

gclid

string

اختیاری. شناسه کلیک Google (gclid) مرتبط با این رویداد.

gbraid

string

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

wbraid

string

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

landingPageDeviceInfo

object ( DeviceInfo )

اختیاری. اطلاعات جمع‌آوری‌شده درباره دستگاه مورد استفاده (در صورت وجود) در زمان ورود به سایت آگهی‌دهنده پس از تعامل با آگهی.

اطلاعات دستگاه

اطلاعات مربوط به دستگاه مورد استفاده (در صورت وجود) هنگام وقوع رویداد.

نمایندگی JSON 
{
  "userAgent": string,
  "ipAddress": string
}
فیلدها
userAgent

string

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

ipAddress

string

اختیاری. آدرس IP دستگاه برای زمینه داده شده.

توجه: Google Ads از تطبیق آدرس IP برای کاربران نهایی در منطقه اقتصادی اروپا (EEA)، بریتانیا (بریتانیا)، یا سوئیس (CH) پشتیبانی نمی‌کند. منطقی را برای حذف مشروط نشانی‌های IP از کاربران این مناطق اضافه کنید و اطمینان حاصل کنید که اطلاعات واضح و جامعی را درباره داده‌هایی که در سایت‌ها، برنامه‌ها و سایر دارایی‌های خود جمع‌آوری می‌کنید در اختیار کاربران قرار می‌دهید و در مواردی که طبق قانون یا هر خط‌مشی‌های قابل‌اجرای Google لازم است رضایت دریافت کنید. برای جزئیات بیشتر به صفحه درباره واردات تبدیل آفلاین مراجعه کنید.

منبع رویداد

منبع رویداد.

Enums
EVENT_SOURCE_UNSPECIFIED منبع رویداد نامشخص هرگز نباید استفاده شود.
WEB این رویداد از یک مرورگر وب ایجاد شد.
APP این رویداد از یک برنامه ایجاد شده است.
IN_STORE این رویداد از یک معامله در فروشگاه ایجاد شد.
PHONE این رویداد از یک تماس تلفنی ایجاد شد.
OTHER این رویداد از منابع دیگر تولید شده است.

CartData

داده‌های سبد خرید مرتبط با رویداد.

نمایندگی JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ]
}
فیلدها
merchantId

string

اختیاری. شناسه Merchant Center مرتبط با موارد.

merchantFeedLabel

string

اختیاری. برچسب فید Merchant Center مرتبط با فید موارد.

merchantFeedLanguageCode

string

اختیاری. کد زبان در ISO 639-1 مرتبط با فید Merchant Center اقلام. جایی که موارد شما آپلود می شوند.

transactionDiscount

number

اختیاری. مجموع کلیه تخفیف های مرتبط با معامله.

items[]

object ( Item )

اختیاری. لیست موارد مرتبط با رویداد.

مورد

نشان دهنده یک مورد در سبد خرید مرتبط با رویداد است.

نمایندگی JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number
}
فیلدها
merchantProductId

string

اختیاری. شناسه محصول در حساب Merchant Center.

quantity

string ( int64 format)

اختیاری. تعداد این مورد مرتبط با رویداد.

unitPrice

number

اختیاری. قیمت واحد بدون احتساب مالیات، حمل و نقل و هر گونه تخفیف در سطح تراکنش.

CustomVariable

متغیر سفارشی برای تبدیل تبلیغات.

نمایندگی JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
فیلدها
variable

string

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

value

string

اختیاری. مقدار ذخیره شده برای متغیر سفارشی.

destinationReferences[]

string

اختیاری. رشته مرجع برای تعیین اینکه متغیر سفارشی باید به کدام یک از Event.destination_references ارسال شود استفاده می شود. اگر خالی باشد، از Event.destination_references استفاده خواهد شد.

میدان تجربی

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

نمایندگی JSON 
{
  "field": string,
  "value": string
}
فیلدها
field

string

اختیاری. نام فیلد مورد استفاده

value

string

اختیاری. مقدار فیلدی که باید تنظیم شود.

ویژگی های کاربر

اطلاعات ارزیابی شده توسط تبلیغ کننده در مورد کاربر در زمان وقوع رویداد. برای جزئیات بیشتر به https://support.google.com/google-ads/answer/14007601 مراجعه کنید.

نمایندگی JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket)
}
فیلدها
customerType

enum ( CustomerType )

اختیاری. نوع مشتری مرتبط با رویداد.

customerValueBucket

enum ( CustomerValueBucket )

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

نوع مشتری

نوع مشتری مرتبط با رویداد.

Enums
CUSTOMER_TYPE_UNSPECIFIED نوع مشتری نامشخص هرگز نباید استفاده شود.
NEW مشتری تازه وارد تبلیغ کننده است.
RETURNING مشتری به سمت تبلیغ کننده باز می گردد.
REENGAGED مشتری دوباره با تبلیغ کننده ارتباط برقرار کرده است.

CustomerValueBucket

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

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket نامشخص. هرگز نباید استفاده شود.
LOW مشتری کم ارزش است.
MEDIUM مشتری ارزش متوسطی دارد.
HIGH مشتری ارزش بالایی دارد.