- درخواست اچتیتیپی
- بدنه درخواست
- متن پاسخ
- دامنههای مجوز
- رویداد
- AdIdentifiers
- EncryptedUserId
- EncryptionEntityType
- EncryptionSource
- EventSource
- CartData
- مورد
- ItemParameter
- ItemCustomVariable
- CustomVariable
- ExperimentalField
- UserProperties
- CustomerType
- CustomerValueBucket
- UserProperty
- EventParameter
- EventLocation
- CallInfo
- امتحان کنید!
فهرستی از منابع Event را از Destination ارائهشده بارگذاری میکند.
درخواست HTTP
POST https://datamanager.googleapis.com/v1/events:ingest
نشانی وب از نحو تراتبدیل gRPC استفاده میکند.
متن درخواست
بدنه درخواست حاوی دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "destinations": [ { object ( |
| فیلدها | |
|---|---|
destinations[] |
الزامی. فهرست مقصدهایی که رویدادها به آنها ارسال میشود. |
events[] |
الزامی. فهرست رویدادها برای ارسال به مقصدهای مشخصشده. حداکثر ۲۰۰۰ منبع |
consent |
اختیاری. رضایت در سطح درخواست برای اعمال شدن به همه کاربران در درخواست. رضایت در سطح کاربر بر رضایت در سطح درخواست اولویت دارد و میتواند در هر |
validateOnly |
اختیاری. برای اهداف آزمایشی. اگر |
encoding |
اختیاری. باید برای بارگذاری |
encryptionInfo |
اختیاری. اطلاعات رمزگذاری برای بارگذاریهای |
بدنه پاسخ
پاسخ از IngestEventsRequest.
درصورت موفقیتآمیز بودن، بدنه پاسخ حاوی دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{
"requestId": string,
"fieldWarnings": [
{
object ( |
| فیلدها | |
|---|---|
requestId |
شناسه خودکار تولیدشده درخواست. |
fieldWarnings[] |
هشدارهای دقیق در سطح ردیف با مسیرهای فیلد. |
دامنههای مجوز
به گستره OAuth زیر نیاز دارد:
https://www.googleapis.com/auth/datamanager
رویداد
رویدادی که نشاندهنده تعامل کاربر با وبسایت یا برنامه تبلیغکننده است.
| نمایش JSON |
|---|
{ "destinationReferences": [ string ], "transactionId": string, "eventTimestamp": string, "lastUpdatedTimestamp": string, "userData": { object ( |
| فیلدها | |
|---|---|
destinationReferences[] |
اختیاری. رشته مرجع مورداستفاده برای تعیین مقصد. اگر خالی باشد، رویداد به همه |
transactionId |
اختیاری. شناسه یکتا برای این رویداد. برای رویدادهایی که بهعنوان منبع داده اضافی برای تبدیلهای برچسب ارسال میشوند لازم است. |
eventTimestamp |
الزامی. زمانی که رویداد رخ داده است. از RFC 3339 استفاده میکند، که در آن خروجی تولیدشده همیشه Z-نرمالسازی میشود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: |
lastUpdatedTimestamp |
اختیاری. آخرین باری که رویداد بهروزرسانی شده است. از RFC 3339 استفاده میکند، که در آن خروجی تولیدشده همیشه Z-نرمالسازی میشود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: |
userData |
اختیاری. بخشهایی از دادههای ارائهشده توسط کاربر که نشاندهنده کاربری است که رویداد با او مرتبط است. |
consent |
اختیاری. اطلاعاتی درباره اینکه آیا کاربر منسوب انواع مختلف رضایت را ارائه کرده است یا نه. |
adIdentifiers |
اختیاری. شناسهها و اطلاعات دیگری که برای مطابقت دادن رویداد تبدیل با دیگر فعالیتهای آنلاین (مثل کلیکهای آگهی) استفاده میشود. |
currency |
اختیاری. کد ارز مرتبط با همه مقادیر پولی در این رویداد. |
eventSource |
اختیاری. نشانهای برای جایی که رویداد اتفاق افتاده است (وب، برنامه، درون فروشگاه، و غیره). |
eventDeviceInfo |
اختیاری. اطلاعات جمعآوریشده درباره دستگاهی که هنگام وقوع رویداد استفاده میشده است (درصورت وجود). |
cartData |
اختیاری. اطلاعات مربوط به تراکنش و موارد مرتبط با رویداد. |
customVariables[] |
اختیاری. اطلاعات جفت کلید/مقدار اضافی برای ارسال به محفظههای تبدیل (کنش تبدیل یا فعالیت FL). |
experimentalFields[] |
اختیاری. فهرستی از جفتهای کلید/مقدار برای فیلدهای آزمایشی که ممکن است درنهایت بهعنوان بخشی از API ارتقا یابند. |
userProperties |
اختیاری. اطلاعات ارزیابیشده توسط تبلیغکننده درباره کاربر در زمان وقوع رویداد. |
eventName |
اختیاری. نام رویداد. برای رویدادهای GA4 الزامی است. |
clientId |
اختیاری. شناسهای یکتا برای نمونه کاربر کارخواه وب برای این جریان داده وب GA4. |
userId |
اختیاری. شناسه یکتای کاربر، همانطور که تبلیغکننده تعریف کرده است. |
additionalEventParameters[] |
اختیاری. مجموعهای از هرگونه پارامترهای رویداد که باید در رویداد گنجانده شود و قبلاً بااستفاده از فیلدهای ساختاریافته دیگر مشخص نشده است. |
thirdPartyUserData |
اختیاری. همان نوع داده ارائهشده در userData، اما بهطور صریح بهعنوان داده ارائهشده توسط شخص ثالث و نه داده آگهیدهنده طرف اول پرچمگذاری شده است. |
eventLocation |
اختیاری. اطلاعات جمعآوریشده درباره مکان کاربر هنگام وقوع این رویداد. |
appInstanceId |
اختیاری. شناسه یکتا برای نمونه کاربر از کارخواه برنامه برای این جاریسازی برنامه GA4. |
callInfo |
اختیاری. اطلاعات جمعآوریشده درباره تماس (درصورت وجود) که منجر به این رویداد شده است. |
conversionValue |
اختیاری. مقدار تبدیل مرتبط با رویداد، برای تبدیلهای مبتنی بر مقدار. |
conversionCount |
اختیاری. تعداد تبدیل مرتبط با رویداد، برای تبدیلهای مبتنی بر شمارش. |
AdIdentifiers
شناسهها و اطلاعات دیگری که برای مطابقت دادن رویداد تبدیل با دیگر فعالیتهای آنلاین (مثل کلیکهای آگهی) استفاده میشود.
| نمایش JSON |
|---|
{ "sessionAttributes": string, "gclid": string, "gbraid": string, "wbraid": string, "landingPageDeviceInfo": { object ( |
| فیلدها | |
|---|---|
sessionAttributes |
اختیاری. شاخصههای جلسه برای اسناد و مدلسازی رویداد. |
gclid |
اختیاری. شناسه کلیک Google (gclid) مرتبط با این رویداد. |
gbraid |
اختیاری. شناسه کلیک برای کلیکهای مرتبط با رویدادهای برنامه که از دستگاههای iOS با iOS14 یا بالاتر نشأت میگیرند. |
wbraid |
اختیاری. شناسه کلیک برای کلیکهای مرتبط با رویدادهای وب که از دستگاههای iOS با iOS14 یا بالاتر نشئت میگیرند. |
landingPageDeviceInfo |
اختیاری. اطلاعات جمعآوریشده درباره دستگاهی که در زمان ورود به سایت تبلیغکننده پساز تعامل با آگهی استفاده میشود (درصورت وجود). |
mobileDeviceId |
اختیاری. شناسه تلفن همراه برای تبلیغکنندگان. این شناسه میتواند IDFA در iOS، AdID در Android، یا شناسههای پلاتفرمهای دیگر برای تبلیغکنندگان باشد. |
dclid |
اختیاری. شناسه کلیک نمایش مرتبط با این رویداد. |
impressionId |
اختیاری. شناسه ظهور مرتبط با این رویداد. |
matchId |
اختیاری. فیلد شناسه مطابقت که برای پیوستن این رویداد به رویداد قبلی استفاده میشود. |
encryptedUserIds[] |
اختیاری. هر تعداد شناسه کاربر رمزگذاریشده. |
ppid |
اختیاری. شناسه یکتا برای کاربر اصالتسنجیشده (واردشده به سیستم)، طبق تعریف ناشر. |
visitorPpid |
اختیاری. شناسه یکتا برای کاربر تأییدنشده (کاربری که به سیستم وارد نشده است)، همانطور که توسط ناشر تعریف شده است. |
leadId |
اختیاری. شناسه تولیدشده توسط Google که هنگام ارسال فرم مشتری بالقوه توسط کاربر صادر میشود. |
EncryptedUserId
شناسه کاربری صادرشده برای استفاده در اسناد. اگر از این استفاده شود، همه فیلدها الزامی است.
| نمایش JSON |
|---|
{ "encryptedId": string, "entityType": enum ( |
| فیلدها | |
|---|---|
encryptedId |
الزامی. شناسه رمزگذاریشده الفباعددی. |
entityType |
الزامی. نوع نهاد رمزگذاری. این باید با پیکربندی رمزگذاری برای ارائه آگهی یا انتقال داده مطابقت داشته باشد. |
entityId |
الزامی. شناسه نهاد رمزگذاری. این باید با پیکربندی رمزگذاری برای ارائه آگهی یا انتقال داده مطابقت داشته باشد. |
source |
الزامی. توضیح میدهد که آیا کوکی رمزگذاریشده از آگهی ارائهشده (ماکرو %m) دریافت شده است یا از «انتقال داده». |
EncryptionEntityType
نوع نهاد رمزگذاری.
| شمارشیها | |
|---|---|
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED |
نوع نهاد رمزگذاری نامشخص است. |
CAMPAIGN_MANAGER_ACCOUNT |
حساب Campaign Manager 360. |
CAMPAIGN_MANAGER_ADVERTISER |
تبلیغکننده Campaign Manager 360. |
DISPLAY_VIDEO_PARTNER |
شریک Display & Video 360. |
DISPLAY_VIDEO_ADVERTISER |
آگهیدهنده Display & Video 360. |
GOOGLE_ADS_CUSTOMER |
مشتری Google Ads. |
GOOGLE_AD_MANAGER_NETWORK_CODE |
کد شبکه Google Ad Manager. |
EncryptionSource
منبع رمزگذاری.
| شمارشیها | |
|---|---|
ENCRYPTION_SOURCE_UNSPECIFIED |
منبع رمزگذاری نامشخص. |
AD_SERVING |
منبع رمزگذاری ارائه آگهی. |
DATA_TRANSFER |
منبع رمزگذاری انتقال داده. |
EventSource
منبع رویداد.
| شمارشیها | |
|---|---|
EVENT_SOURCE_UNSPECIFIED |
EventSource نامشخص. هرگز نباید استفاده شود. |
WEB |
این رویداد از مرورگر وب تولید شده است. |
APP |
این رویداد از یک برنامه تولید شده است. |
IN_STORE |
رویداد از تراکنش درونفروشگاهی تولید شده است. |
PHONE |
رویداد از تماس تلفنی ایجاد شده است. |
MESSAGE |
این رویداد از پیامی تولید شده است. |
OTHER |
این رویداد از منابع دیگری تولید شده است. |
CartData
دادههای سبد خرید مرتبط با رویداد.
| نمایش JSON |
|---|
{
"merchantId": string,
"merchantFeedLabel": string,
"merchantFeedLanguageCode": string,
"transactionDiscount": number,
"items": [
{
object ( |
| فیلدها | |
|---|---|
merchantId |
اختیاری. شناسه Merchant Center مرتبط با موارد. |
merchantFeedLabel |
اختیاری. برچسب فید Merchant Center مرتبط با فید موارد. |
merchantFeedLanguageCode |
اختیاری. کد زبان در ISO 639-1 مرتبط با فید Merchant Center مواردی که موارد شما در آن بارگذاری شده است. |
transactionDiscount |
اختیاری. مجموع همه تخفیفهای منسوب به تراکنش. |
items[] |
اختیاری. فهرست موارد مرتبط با رویداد. |
couponCodes[] |
اختیاری. فهرست کدهای کوپنی که به سبد خرید اعمال شده است. کدهای کوپن سطح سبد خرید و سطح کالا مستقل هستند. اگر رویداد برای مقصد Google Analytics است، فقط یک کد تخفیف ارائه دهید. Google Analytics کدهای تخفیف اضافی را نادیده میگیرد. |
مورد
نشاندهنده موردی در سبد خرید مرتبط با رویداد است.
| نمایش JSON |
|---|
{ "merchantProductId": string, "quantity": string, "unitPrice": number, "itemId": string, "additionalItemParameters": [ { object ( |
| فیلدها | |
|---|---|
merchantProductId |
اختیاری. شناسه محصول در حساب Merchant Center. |
quantity |
اختیاری. تعداد این مورد مرتبط با رویداد. |
unitPrice |
اختیاری. قیمت واحد بدون احتساب مالیات، هزینه ارسال، و هرگونه تخفیف در سطح تراکنش. |
itemId |
اختیاری. شناسه یکتا برای ارجاع به مورد. |
additionalItemParameters[] |
اختیاری. مجموعهای از هرگونه پارامترهای رویداد مربوط به یک مورد که باید در رویداد گنجانده شود و قبلاً بااستفاده از فیلدهای ساختاریافته دیگر مشخص نشده است. |
merchantId |
اختیاری. شناسه Merchant Center مرتبط با مورد. برای رویدادهای «فروش فروشگاهی»، این مقدار تنظیمشده در سطح سبد خرید را لغو میکند. این فیلد برای رویدادهای دیگر نادیده گرفته میشود. |
merchantFeedLabel |
اختیاری. برچسب فید Merchant Center. اگر هنوز از کشورها استفاده میشود، میتوان بهجای آن از کد کشور ۲ حرفی در ISO-3166-1 alpha-2 استفاده کرد. برای رویدادهای «فروش فروشگاهی»، این مقدار تنظیمشده در سطح سبد خرید را لغو میکند. این فیلد برای رویدادهای دیگر نادیده گرفته میشود. |
merchantFeedLanguageCode |
اختیاری. کد زبان در ISO 639-1 مرتبط با جارزن Merchant Center که موارد شما در آن بارگذاری شده است. |
customVariables[] |
اختیاری. اطلاعات جفت کلید/مقدار اضافی برای ارسال به محفظههای تبدیل (کنش تبدیل یا فعالیت Floodlight)، هنگام ردیابی تبدیلهای هر مورد. |
conversionValue |
اختیاری. مقدار تبدیل مرتبط با این مورد در رویداد، برای مواردی که مقدار تبدیل برای هر مورد متفاوت است. |
ItemParameter
مجموعهای از هرگونه پارامترهای رویداد مربوط به یک مورد که باید در رویداد گنجانده شود و قبلاً بااستفاده از فیلدهای ساختاریافته دیگر مشخص نشده است.
| نمایش JSON |
|---|
{ "parameterName": string, "value": string } |
| فیلدها | |
|---|---|
parameterName |
الزامی. نام پارامتر موردنظر برای استفاده. |
value |
الزامی. نمایش رشتهای مقدار پارامتر برای تنظیم. |
ItemCustomVariable
متغیر سفارشی سطح مورد برای تبدیلهای آگهی.
| نمایش JSON |
|---|
{ "variable": string, "value": string, "destinationReferences": [ string ] } |
| فیلدها | |
|---|---|
variable |
اختیاری. نام متغیر سفارشی برای تنظیم. اگر متغیر برای مقصد ارائهشده پیدا نشود، نادیده گرفته خواهد شد. |
value |
اختیاری. مقداری که باید برای متغیر سفارشی ذخیره شود. |
destinationReferences[] |
اختیاری. رشته مرجع استفادهشده برای تعیین اینکه متغیر سفارشی باید به کدامیک از |
CustomVariable
متغیر سفارشی برای تبدیلهای آگهی.
| نمایش JSON |
|---|
{ "variable": string, "value": string, "destinationReferences": [ string ] } |
| فیلدها | |
|---|---|
variable |
اختیاری. نام متغیر سفارشی برای تنظیم. اگر متغیر برای مقصد ارائهشده پیدا نشود، نادیده گرفته خواهد شد. |
value |
اختیاری. مقداری که باید برای متغیر سفارشی ذخیره شود. |
destinationReferences[] |
اختیاری. رشته مرجع استفادهشده برای تعیین اینکه متغیر سفارشی باید به کدامیک از |
ExperimentalField
فیلد آزمایشی که فیلدهای غیررسمی را نشان میدهد.
| نمایش JSON |
|---|
{ "field": string, "value": string } |
| فیلدها | |
|---|---|
field |
اختیاری. نام فیلدی که باید استفاده شود. |
value |
اختیاری. مقداری که فیلد باید روی آن تنظیم شود. |
UserProperties
اطلاعات ارزیابیشده توسط تبلیغکننده درباره کاربر در زمان وقوع رویداد. برای جزئیات بیشتر، https://support.google.com/google-ads/answer/14007601 را ببینید.
| نمایش JSON |
|---|
{ "customerType": enum ( |
| فیلدها | |
|---|---|
customerType |
اختیاری. نوع مشتری مرتبط با رویداد. |
customerValueBucket |
اختیاری. ارزش مشتری که تبلیغکننده ارزیابی کرده است. |
additionalUserProperties[] |
اختیاری. دستهای از هرگونه مشخصه کاربر اضافی برای کاربر مرتبط با این رویداد. |
CustomerType
نوع مشتری مرتبط با رویداد.
| شمارشیها | |
|---|---|
CUSTOMER_TYPE_UNSPECIFIED |
CustomerType نامشخص است. هرگز نباید استفاده شود. |
NEW |
مشتری برای تبلیغکننده جدید است. |
RETURNING |
مشتری به آگهیدهنده برمیگردد. |
REENGAGED |
مشتری دوباره با تبلیغکننده تعامل برقرار کرده است. |
CustomerValueBucket
ارزش مشتری که تبلیغکننده ارزیابی کرده است.
| شمارشیها | |
|---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED |
CustomerValueBucket نامشخص. هرگز نباید استفاده شود. |
LOW |
مشتری ارزش پایینی دارد. |
MEDIUM |
مشتری ارزش متوسطی دارد. |
HIGH |
مشتری ارزشمند است. |
UserProperty
دستهای از هرگونه مشخصه کاربر اضافی برای کاربر مرتبط با این رویداد.
| نمایش JSON |
|---|
{ "propertyName": string, "value": string } |
| فیلدها | |
|---|---|
propertyName |
الزامی. نام مشخصه کاربر برای استفاده. |
value |
الزامی. نمایش رشتهای مقدار مشخصه کاربر برای استفاده. |
EventParameter
پارامتر رویداد برای رویدادهای GA4.
| نمایش JSON |
|---|
{ "parameterName": string, "value": string } |
| فیلدها | |
|---|---|
parameterName |
الزامی. نام پارامتر موردنظر برای استفاده. |
value |
الزامی. نمایش رشتهای مقدار پارامتر برای تنظیم. |
EventLocation
مکانی که رویداد در آن اتفاق افتاده است.
| نمایش JSON |
|---|
{ "storeId": string, "city": string, "subdivisionCode": string, "regionCode": string, "subcontinentCode": string, "continentCode": string } |
| فیلدها | |
|---|---|
storeId |
اختیاری. برای «فروش فروشگاهی» لازم است. شناسهای که نشاندهنده فروشگاه فیزیکیای است که رویداد در آن اتفاق افتاده است. |
city |
اختیاری. نام شهری که رویداد در آن رخ داده است. |
subdivisionCode |
اختیاری. کد بخش ISO 3166-2 که رویداد در آن رخ داده است. |
regionCode |
اختیاری. کد منطقه CLDR دورقمی نشانی کاربر. |
subcontinentCode |
اختیاری. کد شبهقاره در قالب UN M49 که رویداد در آن رخ داده است. |
continentCode |
اختیاری. کد قاره در قالب UN M49 که رویداد در آن رخ داده است. |
CallInfo
اطلاعات جمعآوریشده درباره تماس (درصورت وجود) که منجر به این رویداد شده است.
| نمایش JSON |
|---|
{ "startTimestamp": string } |
| فیلدها | |
|---|---|
startTimestamp |
الزامی. زمانی که تماس تلفنی شروع شد و به این رویداد منجر شد. از RFC 3339 استفاده میکند، که در آن خروجی تولیدشده همیشه Z-نرمالسازی میشود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: |