- طلب HTTP
- نص الطلب
- نص الاستجابة
- نطاقات الأذونات
- الحدث
- AdIdentifiers
- EncryptedUserId
- EncryptionEntityType
- EncryptionSource
- EventSource
- CartData
- Item
- ItemParameter
- ItemCustomVariable
- CustomVariable
- ExperimentalField
- UserProperties
- CustomerType
- CustomerValueBucket
- UserProperty
- EventParameter
- EventLocation
- CallInfo
- جرِّبه الآن
يتم تحميل قائمة بموارد Event من Destination المقدَّم.
طلب HTTP
POST https://datamanager.googleapis.com/v1/events:ingest
يستخدِم عنوان URL بنية تحويل الترميز إلى gRPC.
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "destinations": [ { object ( |
| الحقول | |
|---|---|
destinations[] |
الحقل مطلوب. قائمة الوجهات التي سيتم إرسال الأحداث إليها |
events[] |
الحقل مطلوب. قائمة الأحداث المطلوب إرسالها إلى الوجهات المحدّدة يمكن إرسال 2000 مورد من النوع |
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 في النهاية ويستخدم الأرقام الجزئية 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 |
اختيارية: معرّف فريد لنسخة المستخدم من عميل تطبيق لمصدر بيانات تطبيق "إحصاءات Google 4" هذا |
callInfo |
اختيارية: المعلومات التي تم جمعها عن المكالمة (إن توفّرت) والتي أدّت إلى هذا الحدث |
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[] |
اختيارية: أي عدد من أرقام تعريف المستخدمين المشفّرة |
ppid |
اختيارية: معرّف فريد لمستخدم تمت مصادقته (سجّل الدخول)، على النحو الذي يحدّده الناشر. |
visitorPpid |
اختيارية: معرّف فريد لمستخدم لم تتم مصادقته (مستخدم لم يسجّل الدخول)، على النحو الذي يحدّده الناشر. |
leadId |
اختيارية: معرّف من إنشاء Google يتم إصداره عندما يرسل المستخدم نموذج عملاء محتملين |
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[] |
اختيارية: سلسلة مرجعية تُستخدَم لتحديد أيّ من |
المتغيّر المخصّص
متغيّر مخصّص للإحالات الناجحة في "إعلانات Google"
| تمثيل 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 |
نوع العميل غير محدّد. يجب عدم استخدامها مطلقًا. |
NEW |
العميل جديد بالنسبة إلى المعلِن. |
RETURNING |
يعود العميل إلى المعلِن. |
REENGAGED |
أعاد العميل التفاعل مع المعلِن. |
CustomerValueBucket
القيمة التي يقيّمها المعلِن للعميل
| عمليات التعداد | |
|---|---|
CUSTOMER_VALUE_BUCKET_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 حيث وقع الحدث |
CallInfo
المعلومات التي تم جمعها عن المكالمة (إن توفّرت) والتي أدّت إلى هذا الحدث
| تمثيل JSON |
|---|
{ "startTimestamp": string } |
| الحقول | |
|---|---|
startTimestamp |
الحقل مطلوب. وقت بدء المكالمة الهاتفية التي أدّت إلى هذا الحدث يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |