- طلب HTTP
- نص الطلب
- نص الاستجابة
- نطاقات الأذونات
- حدث
- AdIdentifiers
- DeviceInfo
- EncryptedUserId
- EncryptionEntityType
- EncryptionSource
- EventSource
- CartData
- السلعة
- ItemParameter
- ItemCustomVariable
- CustomVariable
- ExperimentalField
- UserProperties
- CustomerType
- CustomerValueBucket
- UserProperty
- EventParameter
- EventLocation
- جرِّبه الآن
تحميل قائمة بموارد Event من Destination المقدَّم
طلب HTTP
POST https://datamanager.googleapis.com/v1/events:ingest
يستخدِم عنوان URL بنية تحويل الترميز إلى gRPC.
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "destinations": [ { object ( |
| الحقول | |
|---|---|
destinations[] |
الحقل مطلوب. قائمة الوجهات التي سيتم إرسال الأحداث إليها. |
events[] |
الحقل مطلوب. قائمة الأحداث المطلوب إرسالها إلى الوجهات المحدّدة يمكن إرسال 2,000 مرجع |
consent |
اختياريّ. موافقة على مستوى الطلب تنطبق على جميع المستخدمين في الطلب تتجاوز الموافقة على مستوى المستخدم الموافقة على مستوى الطلب، ويمكن تحديدها في كل |
validateOnly |
اختياريّ. لأغراض الاختبار إذا كانت القيمة |
encoding |
اختياريّ. هذا الحقل مطلوب لتحميل |
encryptionInfo |
اختياريّ. معلومات التشفير لعمليات التحميل في |
نص الاستجابة
ردّ من IngestEventsRequest
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "requestId": string } |
| الحقل | |
|---|---|
requestId |
المعرّف الذي يتم إنشاؤه تلقائيًا للطلب. |
نطاقات الأذونات
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/datamanager
الحدث
حدث يمثّل تفاعل المستخدِم مع موقع إلكتروني أو تطبيق خاص بأحد المعلِنين.
| تمثيل JSON |
|---|
{ "destinationReferences": [ string ], "transactionId": string, "eventTimestamp": string, "lastUpdatedTimestamp": string, "userData": { object ( |
| الحقول | |
|---|---|
destinationReferences[] |
اختياريّ. سلسلة مرجعية تُستخدَم لتحديد الوجهة. إذا كان هذا الحقل فارغًا، سيتم إرسال الحدث إلى جميع |
transactionId |
اختياريّ. المعرّف الفريد لهذا الحدث. مطلوب للأحداث التي يتم إرسالها كمصدر بيانات إضافي للإحالات الناجحة التي تحقّقها علامة التتبُّع. |
eventTimestamp |
الحقل مطلوب. الوقت الذي وقع فيه الحدث يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
lastUpdatedTimestamp |
اختياريّ. يشير هذا الحقل إلى تاريخ آخر تعديل للحدث. يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
userData |
اختياريّ. أجزاء من البيانات المقدَّمة من المستخدِم، وتمثّل المستخدِم المرتبط بالحدث. |
consent |
اختياريّ. معلومات عمّا إذا كان المستخدم المرتبط قد قدّم أنواعًا مختلفة من الموافقة. |
adIdentifiers |
اختياريّ. المعرّفات والمعلومات الأخرى المستخدَمة لمطابقة حدث الإحالة الناجحة مع النشاط الآخر على الإنترنت (مثل النقرات على الإعلانات) |
currency |
اختياريّ. رمز العملة المرتبط بجميع القيم النقدية ضِمن هذا الحدث. |
eventSource |
اختياريّ. إشارة إلى مكان وقوع الحدث (على الويب أو في التطبيق أو داخل المتجر أو غير ذلك) |
eventDeviceInfo |
اختياريّ. معلومات يتم جمعها عن الجهاز المستخدَم (إن وُجد) عند وقوع الحدث |
cartData |
اختياريّ. معلومات عن المعاملة والسلع المرتبطة بالحدث |
customVariables[] |
اختياريّ. معلومات إضافية عن أزواج المفاتيح/القيم لإرسالها إلى حاويات الإحالات الناجحة (إجراء الإحالة الناجحة أو نشاط Floodlight). |
experimentalFields[] |
اختياريّ. قائمة بأزواج المفتاح/القيمة للحقول التجريبية التي قد تتم ترقيتها في النهاية لتصبح جزءًا من واجهة برمجة التطبيقات. |
userProperties |
اختياريّ. معلومات يقدّمها المعلِن عن المستخدِم في وقت وقوع الحدث. |
eventName |
اختياريّ. اسم الحدث مطلوب لأحداث "إحصاءات Google 4". |
clientId |
اختياريّ. معرّف فريد لمثيل المستخدم لعميل تطبيقات الويب في مصدر بيانات من موقع إلكتروني هذا على "إحصاءات Google 4". |
userId |
اختياريّ. معرّف فريد للمستخدِم، كما يحدّده المعلِن. |
additionalEventParameters[] |
اختياريّ. مجموعة من أي مَعلمات أحداث سيتم تضمينها في الحدث ولم يتم تحديدها من قبل باستخدام حقول منظَّمة أخرى |
thirdPartyUserData |
اختياريّ. هو النوع نفسه من البيانات المقدَّمة في userData، ولكن يتم وضع علامة صريحة عليها للإشارة إلى أنّها مقدَّمة من جهة خارجية وليست بيانات معلِن تابع للطرف الأول. |
eventLocation |
اختياريّ. معلومات تم جمعها عن الموقع الجغرافي للمستخدم عند وقوع هذا الحدث. |
appInstanceId |
اختياريّ. معرّف فريد لمثيل المستخدم من عميل تطبيق لتدفّق تطبيق GA4 هذا |
conversionValue |
اختياريّ. قيمة الإحالة الناجحة المرتبطة بالحدث، وذلك للإحالات الناجحة المستندة إلى القيمة |
conversionCount |
اختياريّ. كمية الإحالة الناجحة المرتبطة بالحدث، وذلك للإحالات الناجحة المستندة إلى العدّ |
AdIdentifiers
المعرّفات والمعلومات الأخرى المستخدَمة لمطابقة حدث الإحالة الناجحة مع النشاط الآخر على الإنترنت (مثل النقرات على الإعلانات)
| تمثيل JSON |
|---|
{ "sessionAttributes": string, "gclid": string, "gbraid": string, "wbraid": string, "landingPageDeviceInfo": { object ( |
| الحقول | |
|---|---|
sessionAttributes |
اختياريّ. سمات الجلسة لتحديد مصدر الأحداث ووضع نماذج لها |
gclid |
اختياريّ. معرّف النقرة من Google (gclid) المرتبط بهذا الحدث. |
gbraid |
اختياريّ. معرّف النقرة للنقرات المرتبطة بأحداث التطبيق والتي تأتي من أجهزة iOS بدءًا من الإصدار 14 من نظام التشغيل iOS |
wbraid |
اختياريّ. معرّف النقرة للنقرات المرتبطة بالأحداث على الموقع الإلكتروني والتي تأتي من أجهزة iOS بدءًا من الإصدار 14 من نظام التشغيل iOS |
landingPageDeviceInfo |
اختياريّ. المعلومات التي يتم جمعها عن الجهاز المستخدَم (إن وُجد) عند الوصول إلى موقع المعلِن الإلكتروني بعد التفاعل مع الإعلان |
mobileDeviceId |
اختياريّ. المعرّف الإعلاني على الأجهزة الجوّالة سيكون هذا المعرّف هو معرّف المعلِنين (IDFA) على iOS أو المعرّف الإعلاني (AdID) على Android أو معرّفات المعلِنين على المنصات الأخرى. |
dclid |
اختياريّ. معرّف النقرة على الإعلان الصوري المرتبط بهذا الحدث. |
impressionId |
اختياريّ. تمثّل هذه السمة معرّف مرّة الظهور المرتبط بهذا الحدث. |
matchId |
اختياريّ. حقل رقم تعريف المطابقة المستخدَم لربط هذا الحدث بحدث سابق |
encryptedUserIds[] |
اختياريّ. أي عدد من أرقام تعريف المستخدمين المشفرة |
DeviceInfo
معلومات عن الجهاز المستخدَم (إن وُجد) عند وقوع الحدث
| تمثيل JSON |
|---|
{ "userAgent": string, "ipAddress": string, "category": string, "languageCode": string, "screenHeight": integer, "screenWidth": integer, "operatingSystem": string, "operatingSystemVersion": string, "model": string, "brand": string, "browser": string, "browserVersion": string } |
| الحقول | |
|---|---|
userAgent |
اختياريّ. سلسلة وكيل المستخدم للجهاز في السياق المحدّد |
ipAddress |
اختياريّ. عنوان IP للجهاز في السياق المحدّد ملاحظة: لا تتيح "إعلانات Google" مطابقة عناوين IP للمستخدِمين النهائيين في المنطقة الاقتصادية الأوروبية أو المملكة المتحدة أو سويسرا. أضِف منطقًا لاستبعاد مشاركة عناوين IP من المستخدِمين في هذه المناطق بشكلٍ مشروط، وتأكَّد من تزويد المستخدِمين بمعلومات واضحة وشاملة حول البيانات التي تجمعها على مواقعك الإلكترونية وتطبيقاتك والمواقع الأخرى، والحصول على موافقتهم حيثما يقتضي القانون أو أي سياسات سارية من Google. اطّلِع على صفحة لمحة عن عمليات استيراد الإحالات الناجحة غير الإلكترونية لمزيد من التفاصيل. |
category |
اختياريّ. فئة الجهاز على سبيل المثال، "كمبيوتر مكتبي" أو "جهاز لوحي" أو "جهاز جوّال" أو "تلفزيون ذكي". |
languageCode |
اختياريّ. اللغة التي يستخدمها الجهاز بتنسيق ISO 639-1 |
screenHeight |
اختياريّ. تمثّل هذه السمة ارتفاع الشاشة بالبكسل. |
screenWidth |
اختياريّ. تمثّل هذه السمة عرض الشاشة بالبكسل. |
operatingSystem |
اختياريّ. نظام التشغيل أو النظام الأساسي للجهاز |
operatingSystemVersion |
اختياريّ. إصدار نظام التشغيل أو النظام الأساسي |
model |
اختياريّ. طراز الجهاز |
brand |
اختياريّ. تمثّل هذه السمة العلامة التجارية للجهاز. |
browser |
اختياريّ. تمثّل هذه السمة العلامة التجارية للمتصفّح أو نوعه. |
browserVersion |
اختياريّ. إصدار المتصفّح |
EncryptedUserId
معرّف مستخدم يتم إصداره لاستخدامه في تحديد المصدر. يجب ملء جميع الحقول في حال استخدام هذا الخيار.
| تمثيل JSON |
|---|
{ "encryptedId": string, "entityType": enum ( |
| الحقول | |
|---|---|
encryptedId |
الحقل مطلوب. المعرّف المشفّر الأبجدي الرقمي |
entityType |
الحقل مطلوب. نوع كيان التشفير. يجب أن يتطابق ذلك مع إعدادات التشفير لعرض الإعلانات أو "نقل البيانات". |
entityId |
الحقل مطلوب. رقم تعريف جهة التشفير يجب أن يتطابق ذلك مع إعدادات التشفير لعرض الإعلانات أو "نقل البيانات". |
source |
الحقل مطلوب. توضّح هذه السمة ما إذا كان قد تم تلقّي ملف تعريف الارتباط المشفّر من عرض الإعلانات (وحدة الماكرو %m) أو من "نقل البيانات". |
EncryptionEntityType
نوع كيان التشفير.
| عمليات التعداد | |
|---|---|
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED |
نوع كيان التشفير غير محدَّد. |
CAMPAIGN_MANAGER_ACCOUNT |
حساب على "مدير الحملة 360" |
CAMPAIGN_MANAGER_ADVERTISER |
معلِن في "مدير الحملة 360" |
DISPLAY_VIDEO_PARTNER |
شريك "مساحة العرض والفيديو 360" |
DISPLAY_VIDEO_ADVERTISER |
مُعلِن على "مساحة العرض والفيديو 360" |
GOOGLE_ADS_CUSTOMER |
عميل "إعلانات Google" |
GOOGLE_AD_MANAGER_NETWORK_CODE |
معرِّف شبكة "إدارة إعلانات Google" |
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"، قدِّم رمز قسيمة واحدًا فقط. تتجاهل "إحصاءات Google" رموز القسائم الإضافية. |
العنصر
تمثّل هذه السمة سلعة في سلّة التسوّق مرتبطة بالحدث.
| تمثيل 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[] |
اختياريّ. سلسلة مرجعية تُستخدَم لتحديد |
المتغيّر المخصّص
متغيّر مخصّص للإحالات الناجحة من الإعلانات
| تمثيل 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 |
Unspecified CustomerType. يجب عدم استخدامها مطلقًا. |
NEW |
العميل جديد بالنسبة إلى المعلِن. |
RETURNING |
يعود العميل إلى المعلِن. |
REENGAGED |
تفاعل العميل مجددًا مع المعلِن. |
CustomerValueBucket
قيمة العميل التي يحدّدها المعلِن
| عمليات التعداد | |
|---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED |
Unspecified CustomerValueBucket. يجب عدم استخدامها مطلقًا. |
LOW |
العميل ذو قيمة منخفضة. |
MEDIUM |
العميل متوسط القيمة. |
HIGH |
العميل بارز. |
UserProperty
مجموعة من أي خصائص مستخدم إضافية للمستخدم المرتبط بهذا الحدث.
| تمثيل JSON |
|---|
{ "propertyName": string, "value": string } |
| الحقول | |
|---|---|
propertyName |
الحقل مطلوب. اسم خاصيّة المستخدِم المطلوب استخدامها |
value |
الحقل مطلوب. تمثّل هذه السلسلة قيمة خاصية المستخدم التي سيتم استخدامها. |
EventParameter
مَعلمة خاصة بالحدث لأحداث "إحصاءات Google 4".
| تمثيل 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 حيث وقع الحدث. |