App User-Agent
في إطار جهودنا الأوسع لمكافحة المحتوى غير المرغوب فيه، طوّرنا مواصفات موحّدة لعنوان User-Agent الذي يرسله منتج إحصاءات أو إعلانات نيابةً عن مستخدم تطبيق. يمكن استخلاص User-Agent للتطبيق من الرمز البرمجي الأصلي للالتزام بالمواصفات التالية:
name version (os_and_version; locale; device; build; Proxy)
في ما يلي تعريف لهذه الحقول:
| مكوّنات وكيل المستخدم | |
|---|---|
| name | اسم منتج الإحصاءات أو الإعلانات ( يُرجى العِلم أنّه في حال إنشاء وكيل المستخدم على جهة العميل، يجب أن يكون Android// Specified by API consumer. iOS// Specified by API consumer. |
| version | إصدار منتج الإحصاءات أو الإعلانات
( Android// Specified by API consumer. iOS// Specified by API consumer. |
| os_and_version | نظام التشغيل وإصدار نظام التشغيل اللذان يعمل عليهما التطبيق ( AndroidString osAndVersion =
"Android " + Build.VERSION.RELEASE;iOSUIDevice *uid = [UIDevice currentDevice]; NSString *osAndVersion = [NSString stringWithFormat:@"%@ %@", [uid systemName], [uid systemVersion]]; |
| locale | تمثّل هذه السمة علامة لغة IETF للجهاز، باستخدام رمز اللغة ورمز البلد المكوّنَين من حرفين والمفصولَين بشرطة سفلية.
( AndroidString locale = Locale.getDefault(); iOSNSString *locale = [[NSLocale currentLocale] localeIdentifier] |
| device | اسم الجهاز الفعلي الذي يتم تشغيل منتج الإحصاءات/الإعلانات عليه
( AndroidString device = Build.MODEL; iOS@import Darwin.sys.sysctl; NSString *device(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname("hw.machine", buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding]; } |
| build | "Build/" متبوعًا برقم إصدار نظام التشغيل
( AndroidString build = "Build/" + Build.ID; iOS@import Darwin.sys.sysctl; NSString *build(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname("kern.osversion", buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding]; } |
يجب تضمين ; Proxy في نهاية سلسلة User-Agent للتطبيق فقط عند إنشاء سلسلة User-Agent للتطبيق من جهة الخادم. إذا تم إنشاء وكيل المستخدم للتطبيق بالكامل من جهة العميل، استبعِد ; Proxy. وبالتالي، قد تكون سلسلة وكيل المستخدم للتطبيق كما يلي:
- نظام تشغيل Android:
AdMob/7.10.1 (Android 6.0; en_US; SM-G900F; Build/MMB29M; Proxy) - نظام تشغيل iOS:
AdMob/7.10.1 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
دليل طلبات تتبُّع الإحالات الناجحة
الغرض من طلبات تتبُّع الإحالات الناجحة هو إعلام "إعلانات Google" بحدث في التطبيق يجب تتبُّعه كإحالة ناجحة و/أو استخدامه لملء قائمة تجديد النشاط التسويقي، واسترداد البيانات الوصفية التي تصف أي نقرة سبقت الحدث.
يتم إجراء جميع طلبات البيانات من واجهة برمجة التطبيقات إلى النطاق www.googleadservices.com. طلبات الإحالة الناجحة هي طلبات POST عبر HTTPS على المسار التالي:
/pagead/conversion/app/version
سيتضمّن طلب الإحالة الناجحة العادي للتطبيق المَعلمات التالية لواجهة برمجة التطبيقات App Conversion API الإصدار 1.1.
| طلب تتبُّع الإحالات الناجحة | |
|---|---|
dev_token |
مطلوب الموقع الجغرافي: طلب البحث الرمز المميز الثابت والفريد للمطوِّر الذي يتم إصداره لمستهلك واجهة برمجة التطبيقات. Z_eErE4DkvcKjDM1OVE4c4 |
link_id |
مطلوب الموقع الجغرافي: طلب البحث معرّف الربط الذي يربط الرمز المميز للمطوّر الخاص بمستهلك واجهة برمجة التطبيقات بتطبيق معيّن. 31FF8D67E5BB5DD5029DCC2734C2F884 |
app_event_type |
مطلوب الموقع الجغرافي: طلب البحث اسم حدث التطبيق الذي وقع. هذا الحقل هو تعداد، ولن يقبل إلا القيم التالية: • first_open • session_start • in_app_purchase • view_item_list • view_item • view_search_results • add_to_cart • ecommerce_purchase • custom يجب دائمًا إرسال الحدث |
app_event_name |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث اسم أي حدث مخصّص للتطبيق غير مقبول في الحقل level_achieved Level Achieved يجب ألا يحتوي هذا الحقل على أي من القيم المحجوزة لـ |
app_event_data |
اختياري الموقع الجغرافي: الجسم أرسِل أي بيانات إضافية عن الأحداث كعنصر JSON بسيط يربط المفاتيح بالسلاسل والقيم. وتكون القيم المقبولة هي سلاسل ومجموعات منها. {"level": 5, "attempts": 20} |
odm_info |
مطلوب عند استخدام "قياس الإحالات الناجحة المتكامل" على أجهزة iOS الموقع الجغرافي: طلب البحث قيمة مَعلمة طلب البحث XYZr_AB8C-_zGtKjUhqtzPLeQ8lbJB5dADVR0tpZ9f-28sN5qN9GTZ_FztjL0OL FzgxUJDhZr8w6lwGxAwPcxSwR5orjWepZiVP7sRRoCiaHerR-1TP17eJKtazgeSg _CVEs13LllDTfrhVM8uWISqlg8dXobsLzmj8C7WrOlktHA5P_E23 |
id_type |
مطلوب نوع المعرّف الذي تم تمريره في الحقل Androidadvertisingid appsetid iOSidfa idfv |
rdid |
مطلوب الموقع الجغرافي: طلب البحث سلسلة معرّف فريد عالمي (UUID) صالحة تمثّل رقم تعريف الجهاز الأولي f10e1de2-e237-4f50-b6aa-843c45cc63d6 في حال عدم توفّر معرّف الجهاز، مثل معرّف الجهاز من مستخدم لم يوافق على ATT، اضبطه على صفر. 00000000-0000-0000-0000-000000000000 |
ctry_c |
مطلوب الموقع الجغرافي: طلب البحث رمز البلد المكوّن من حرفَين وفقًا لمعايير ISO للإشارة إلى البلد الذي نشأ منه الإحالة الناجحة. هذا الحقل مطلوب لتفعيل قياس الإحالات الناجحة للتطبيق على مستوى غير المستخدم على نظامَي التشغيل iOS وAndroid. US, IN |
eea |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث نطاق المنطقة الاقتصادية الأوروبية
|
ad_personalization |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث علامات الإعلانات المخصّصة
|
ad_user_data |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث علامة الموافقة على استخدام بيانات المستخدم لأغراض إعلانية
|
lat |
مطلوب الموقع الجغرافي: طلب البحث حالة "تقييد تتبُّع الإعلانات" للجهاز.
|
app_version |
مطلوب الموقع الجغرافي: طلب البحث الإصدار الحالي من التطبيق، ويجب أن يكون موحّدًا على النحو التالي. AndroidpackageManager.getPackageInfo(packageName(), PackageManager.GET_META_DATA).versionName iOS[[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleShortVersionString"] 1.2.4 |
os_version |
مطلوب الموقع الجغرافي: طلب البحث الإصدار الحالي من نظام التشغيل المضيف للتطبيق يجب توحيد هذا التنسيق على النحو التالي. Androidandroid.os.Build.VERSION.RELEASE iOS[[UIDevice currentDevice] systemVersion] |
sdk_version |
مطلوب الموقع الجغرافي: طلب البحث إصدار حزمة تطوير البرامج (SDK) التي قاست الحدث. بما أنّ هذا المعرّف يُستخدم بشكل أساسي في تصحيح الأخطاء، يجب أن يعكس نسخة الإصدار تمامًا كما هي منشورة مع إصدارات حزمة تطوير البرامج (SDK). إذا كان التطبيق لا يستخدم حزمة SDK، يُرجى إدخال القيمة نفسها التي تم إدخالها في 1.9.5r6 |
timestamp |
مطلوب الموقع الجغرافي: طلب البحث الطابع الزمني لنظام التشغيل UNIX الذي حدث فيه حدث الإحالة الناجحة، بالثواني مع دقة الميكروثانية 1432681913.123456 |
fot |
مطلوب الموقع الجغرافي: طلب البحث الطابع الزمني لنظام التشغيل UNIX من 1432681913.123456 |
value |
اختياري الموقع الجغرافي: طلب البحث القيمة النقدية للحدث، إن وُجدت. يجب دائمًا تنسيق هذا الحقل كقيمة نقطة عائمة قابلة للقراءة آليًا باستخدام علامة عشرية لفصل الجزء الصحيح عن الجزء الكسري من القيمة. 1.99 |
currency_code |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث تمثّل هذه السمة رمز العملة بالتنسيق ISO 4217 الخاص بالمَعلمة USD |
gclid |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث قيمة مَعلمة طلب البحث Cj0KEQjw0dy4BRCuuL_e5M |
market_referrer_gclid |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث تمثّل هذه السمة قيمة مَعلمة طلب البحث BX3QojHp4mY5MrJtFM_d1u |
gclid_only_request |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث معرّف تحديد المصدر المستند إلى 1 |
gbraid |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث قيمة ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O |
app_open_source |
مطلوبة بموجب شروط معيّنة الموقع الجغرافي: طلب البحث قيمة لتحديد الرابط لصفحة معيّنة في التطبيق من خلال النقرة على الإعلان أو جلسات التطبيق المجانية ad_click or organic |
User-Agent |
مطلوب الموقع: العنوان وكيل مستخدم التطبيق كما هو محدّد في القسم السابق AdMob/7.10.1 (Android 6.0; en_US; SM-G900F; Build/MMB29M) |
X-Forwarded-For |
مطلوب الموقع: العنوان عنوان IPv4 أو IPv6 العام للجهاز الذي تم قياس الحدث عليه 216.58.194.174 |
يجب إرسال جميع الطلبات عبر HTTPS. سيتم رفض طلبات Ping التي يتم تلقّيها عبر HTTP.
يُرجى العِلم أنّه إذا كان نص الطلب فارغًا (في الحالات التي لا يتم فيها تمرير أي بيانات أحداث منسّقة في حمولة app_event_data)، يتطلّب الخادم أن يتم ضبط عنوان Content-Length: 0 بشكل صريح في طلبك.
ترميز بيانات الأحداث
بالنسبة إلى مَعلمة النص الأساسي app_event_data، يُرجى استخدام الاصطلاحات التالية
لأنواع البيانات الأساسية:
Float
- استخدام النقطة كفاصل عشري بغض النظر عن لغة التطبيق
- استخدِم دقة عشرية من رقمَين لتمثيل القيم النقدية، مثل 2.99.
- لا تستخدِم الترميز الأسي، مثل 2E+9
- لا تستخدِم حرف الفاصلة للفصل بين مجموعات الأرقام، مثل 1,000,000
- أمثلة صالحة:
-0.52.991000000.123
عدد صحيح
- يجب إرسال قيم أعداد صحيحة فقط بدون أرقام عشرية
- لا تستخدِم حرف الفاصلة للفصل بين مجموعات الأرقام، مثل 1,000,000
- أمثلة صالحة:
1000-110
التاريخ
- تنسيق التاريخ: yyyy-mm-dd
-
yyyy= السنة بتنسيق من أربعة أرقام، مثل 2016 -
mm= شهر مكوّن من رقمَين، مثل 09 لسبتمبر -
dd= يوم من رقمين، مثل 23 لليوم الثالث والعشرين من الشهر
-
- يجب دائمًا إرسال عدد الأرقام المحدّد أعلاه، مثلاً، إذا أردت إرسال قيمة dd لليوم الخامس من الشهر، أرسِل
05. - أمثلة صالحة:
"2016-09-23""1990-12-31"
- تنسيق التاريخ: yyyy-mm-dd
الطابع الزمني
- تنسيق الوقت: الطابع الزمني Unix/Epoch بالثواني المحدّد في المنطقة الزمنية UTC بدقة الميكروثانية
- أمثلة صالحة:
1478713087for Wed, 09 Nov 2016 17:38:07 GMT1073513982.123000ليوم الأربعاء 07 كانون الثاني (يناير) 2004 الساعة 22:19:42.123 بتوقيت غرينتش
المصفوفات
- إرسال مصفوفات من القيم الأساسية فقط (سلاسل وأرقام وقيم منطقية)
- أمثلة صالحة:
[123, 456, 789]["abc"]
طلبات نموذجية
في ما يلي مثال على طلب غير مكتمل باستخدام حزمة تطوير البرامج (SDK) الخاصة بميزة "القياس على الجهاز فقط باستخدام بيانات الأحداث" لميزة "قياس الإحالات الناجحة المتكامل":
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=first_open
&odm_info=abcdEfadGdaf
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfv
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8في ما يلي مثال على طلب غير مكتمل بدون استخدام حزمة تطوير البرامج (SDK) الخاصة بميزة "القياس على الجهاز فقط: بيانات الأحداث" من أجل ميزة "قياس الإحالات الناجحة المتكامل":
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=first_open
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfv
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8في ما يلي مثال على طلب ما بعد التثبيت باستخدام حزمة تطوير البرامج (SDK) الخاصة بميزة "القياس على الجهاز فقط: بيانات الأحداث" من أجل ميزة "قياس الإحالات الناجحة المدمجة":
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=first_open
&odm_info=abcdEfadGdaf
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfv
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&&fot=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8في ما يلي مثال على طلب فتح التطبيق لأول مرة بدون حزمة تطوير البرامج (SDK) الخاصة بميزة "القياس على الجهاز فقط: بيانات الأحداث":
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=first_open
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfv
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8في ما يلي مثال على طلب غير مكتمل لإحالة ناجحة غير حتمية على Android في ACAPI الإصدار 1.1:
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=first_open
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=appsetid
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&ctry_c=IN
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (android 11; en-GB; RMX2040; Build/_; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8في ما يلي مثال على طلب صالح لتتبُّع الإحالات الناجحة يتضمّن نوع حدث غير مخصّص ومعلومات الإيرادات:
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=in_app_purchase
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfa
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&value=1.99
¤cy_code=USD
&market_referrer_gclid=BX3QojHp4mY5MrJtFM_d1u
&gclid=Cj0KEQjw0dy4BRCuuL_e5M
&gclid_only_request=0
&gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8{"app_event_data":{"item_id":["Crayons","Markers"]}}في ما يلي مثال على طلب صالح لتتبُّع الإحالات الناجحة يتضمّن نوع حدث غير مخصّص ومعلومات الإيرادات مع معرّف الجهاز المرتبط بالإعلانات (advertisingid) غير متوفّر:
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=in_app_purchase
&rdid=00000000-0000-0000-0000-000000000000
&id_type=advertisingid
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=1
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&value=1.99
¤cy_code=USD
&market_referrer_gclid=BX3QojHp4mY5MrJtFM_d1u
&gclid=Cj0KEQjw0dy4BRCuuL_e5M
&gclid_only_request=1
&gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; Android,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8{"app_event_data":{"item_id":["Crayons","Markers"]}}في ما يلي مثال على طلب بدء جلسة صالح:
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=session_start
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfa
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&gclid=Cj0KEQjw0dy4BRCuuL_e5M
&gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8في ما يلي مثال على طلب إعادة تحديد مصدر بدء الجلسة صالح لجلسة بدأت من رابط لصفحة معيّنة example://product/123?gclid=Cj0KEQjw0dy4BRCuuL_e5M:
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=session_start
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfa
&eea=0
&ad_personalization=1
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&gclid=Cj0KEQjw0dy4BRCuuL_e5M
&gbraid=ChEI8IixhgYQrufHkIjz3YWRARIzALev_G_O
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8في ما يلي مثال على طلب صالح لتتبُّع الإحالات الناجحة لمستخدم في المنطقة الاقتصادية الأوروبية تمّت الموافقة فيه على استخدام بيانات المستخدم في الإعلانات ورفض تخصيص الإعلانات:
POST /pagead/conversion/app/1.1
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=in_app_purchase
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfa
&eea=1
&ad_personalization=0
&ad_user_data=1
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&value=1.99
¤cy_code=USD
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8دليل الردود على طلبات تتبُّع الإحالات الناجحة
تتّبع استجابة تتبُّع الإحالات الناجحة التنسيق التالي:
{
"ad_events": [<ad event objects>],
"errors": [<error strings>],
"attributed": true|false
}
قد تكون كلّ من مصفوفتَي ad_events وerrors فارغة.
نتوقّع أن تكون الأخطاء عبارة عن رموز أخطاء قابلة للقراءة آليًا، مثل invalid_timestamp.
رموز الخطأ
invalid_timestamp: لم يتضمّن الطلب طابعًا زمنيًا صالحًا.
eea_missing_or_invalid: لم يتم ضبط الحقل "eea" في الطلب أو كان غير صالح.
ad_user_data_missing: لم يتم ضبط حقل الطلب "ad_user_data". حقل "ad_user_data" مطلوب لجميع طلبات منطقة السوق المحدّدة التي تندرج ضمن النطاق.
ad_user_data_invalid: كانت قيمة الطلب "ad_user_data" غير صالحة. حقل "ad_user_data" مطلوب لجميع طلبات منطقة السوق المحدّدة التي تندرج ضمن النطاق.
ad_personalization_missing_or_invalid: لم يتضمّن الطلب الحقل "ad_personalization" أو كان غير صالح. حقل "ad_personalization" مطلوب لجميع طلبات مناطق السوق المحدّدة التي تسري عليها اللائحة.
أحداث الإعلانات هي العناصر الأساسية لتحديد مصدر التثبيت في التطبيق، وستتضمّن الخصائص التالية.
ملاحظات مهمة بشأن سلوك الاستجابة الذي يعتمد على موافقة المستخدم:
إذا كانت الإحالة الناجحة تتضمّن موافقة على بيانات المستخدمين في الإعلانات وكان المستخدم قد منح موافقة على الاستخدام المتعدّد
في إعدادات المستخدم على Google، ستستجيب "إعلانات Google" بنقرة واحدة أخيرة
على جميع منصّات CPS التابعة لها. إذا لم يوافق المستخدم على استخدام الموافقة على مستوى منتجات متعدّدة ضمن إعدادات المستخدم على Google، ستستجيب "إعلانات Google" بعدّة نقرات أخيرة، وذلك على أساس كلّ نقرة لكلّ تكلفة.
إذا كانت الإحالة الناجحة تتضمّن خدمات CPS معيّنة في الموافقة على الاستخدام المشترك التي يختارها المستخدم
ولكن لا تتضمّن خدمات أخرى، ستردّ "إعلانات Google" بنقرة أخيرة واحدة على مستوى
خدمات CPS التي تم منحها الموافقة على الاستخدام المشترك، ولكن بنقرات أخيرة متعدّدة، على مستوى كل خدمة CPS
على حدة، بالنسبة إلى خدمات CPS التي لم يتم منحها الموافقة على الاستخدام المشترك.
| ردّ بشأن تتبُّع الإحالات الناجحة | |
|---|---|
ad_event_id |
متاح دائمًا سلسلة يعمل Q2owS0VRancwZHk0QlJDdXVMX2U1TQ |
conversion_metric |
متاح دائمًا سلسلة مقياس الإحالة الناجحة المستخدَم لتحديد المصدر. سنوفّر في البداية مقياسًا واحدًا للإحالات الناجحة. conversion |
timestamp |
متاح دائمًا الرقم الطابع الزمني لنظام التشغيل UNIX الذي وقع فيه الحدث الإعلاني، بالثواني مع دقة الميكروثانية يجب استخدام هذه القيمة لتحديد المصدر بالاستناد إلى النقرة الأخيرة. 1432681913.123456 |
campaign_type |
متاح دائمًا سلسلة سيحدّد هذا الحقل نوع الحملة التي أدّت إلى ظهور حدث الإعلان. في ما يلي القيم المحتمَلة. ACI ACE ACPre Search Display Video Shopping Hotel Performance_Max Other ACI هو اختصار لـ "حملة التطبيقات لجذب عمليات التثبيت". ACE هو اختصار لـ "حملات التطبيقات لجذب المستخدمين الحاليين". |
campaign_id |
متاح دائمًا الرقم رقم تعريف الحملة الرقمي للحملة التي أدّت إلى الحدث الإعلاني. هذه القيمة مضمونة بأنّها فريدة. 123456789 |
campaign_name |
متاح دائمًا سلسلة تمثّل هذه السمة اسم الحملة الذي حدّده المعلِن للحملة التي أدّت إلى إنشاء حدث الإعلان. لا يُضمن أن تكون هذه القيمة فريدة. Occasional Gamers (Video) |
ad_type |
متاح دائمًا سلسلة نوع الإعلان الذي أدّى إلى حدث الإعلان. يمكن استخدام هذه القيمة للتمييز بين أنواع المستودع المختلفة على النحو التالي. الترويج لتطبيقClickToDownload AppDeepLink AppDeepLinkContinue Unknown |
external_customer_id |
متاح دائمًا الرقم تمثّل هذه السمة معرّف المعلِن الخاص بالمعلِن الذي يملك الحملة التي أدّت إلى ظهور الحدث الإعلاني. يمكن استخدام هذه القيمة للتمييز بين حسابات "إعلانات Google". 123456789 |
location |
متاح دائمًا الرقم رمز معرّف الموقع الجغرافي لحدث الإعلان. راجِع مرجع واجهة برمجة التطبيقات Google Ads لتفسير رموز المواقع الجغرافية. |
network_type |
متاح دائمًا سلسلة سيحدّد هذا الحقل شبكة الإعلانات على "إعلانات Google" التي وقع عليها الحدث الإعلاني. في ما يلي القيم المحتمَلة. Search Display YouTube GoogleTv cross-network |
network_subtype |
ستكون القيمة سلسلة سيحدّد هذا الحقل "النوع الفرعي" لشبكة الإعلانات على "إعلانات Google" التي وقع عليها حدث الإعلان. تختلف القيم المحتملة حسب نوع الشبكة الأساسي. بحث"بحث Google" العاديGoogleSearch SearchPartners الشبكة الإعلانيةالناشرون على الويب على الأجهزة الجوّالةmGDN Google AdMob YouTubeشبكة "فيديوهات YouTube"YouTubeVideos YouTubeSearch VideoPartners GoogleTvشبكة فيديوهات GoogleTVGoogleTvVideos الشبكة المتقاطعة"حملات الأداء الأفضل" على شبكات متعددةcross-network |
video_id |
يتم توفيرها فقط عندما تكون قيمة سلسلة معرّف فيديو على YouTube المرتبط بحدث الإعلان. dQw4w9WgXcQ |
keyword |
يتم توفيرها فقط عندما تكون قيمة سلسلة كلمة البحث الرئيسية المرتبطة بحدث الإعلان. +food +delivery |
match_type |
يتم توفيرها فقط عندما تكون قيمة سلسلة نوع المطابقة لكلمات البحث الرئيسية تامةe p b |
placement |
يتم توفيرها فقط عندما تكون قيمة سلسلة موضع الإعلان المرتبط بحدث الإعلان. mobileapp::1-343200656 |
ad_group_id |
يتم توفيرها فقط عندما لا تكون قيمة الرقم رقم التعريف الرقمي للمجموعة الإعلانية التي أدّت إلى الحدث الإعلاني. هذه القيمة مضمونة بأنّها فريدة. 123456789 |
ad_group_name |
يتم توفيرها فقط عندما تكون قيمة سلسلة اسم المجموعة الإعلانية التي حدّدها المعلِن والتي أنتجت حدث الإعلان. لا يُضمن أن تكون هذه القيمة فريدة. My App AdGroup |
asset_group_id |
يتم توفيرها فقط عندما تكون قيمة الرقم رقم التعريف الرقمي لمجموعة مواد العرض التي أدّت إلى ظهور الحدث الإعلاني. هذه القيمة فريدة. 123456789 |
creative_id |
يتم توفيرها فقط عندما تكون قيمة الرقم رقم التعريف الرقمي لوحدة الإعلان الإبداعية التي أنتجت الحدث الإعلاني. هذه القيمة مضمونة بأنّها فريدة. 123456789 |
interaction_type |
سيكون هذا الحقل دائمًا هو "التفاعل". سلسلة |
is_deterministic |
توضّح هذه السمة ما إذا كانت طريقة تحديد المصدر قطعية أم لا. منطقي true, false |
device_model |
طراز الجهاز الذي أدّى إلى إنشاء حدث الإعلان. سلسلة sm-s936w, sm-3936w |
os_version |
إصدار نظام التشغيل الرئيسي الذي أدّى إلى إنشاء حدث الإعلان. سلسلة 14, 12 |
country |
رمز البلد المكوّن من حرفين والذي أدّى إلى إنشاء حدث الإعلان. سلسلة CA, US |
city |
المدينة التي تم فيها تسجيل حدث الإعلان. سلسلة san jose, london |
region |
الولاية أو المقاطعة التي تم فيها إنشاء حدث الإعلان. سلسلة california, british columbia |
أمثلة على الردود
في ما يلي مثال على ردّ لإحالة ناجحة محدّدة:
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "engagement",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"network_type": null,
"network_subtype": null,
"ad_group_id": null,
"ad_group_name": null,
"asset_group_id": null,
"is_deterministic": true,
"timestamp": 1234567.898765
}],
"errors": [],
"attributed": true
}في ما يلي مثال على استجابة لإحالة ناجحة غير حتمية على نظام التشغيل iOS:
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "engagement",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"network_type": null,
"network_subtype": null,
"ad_group_id": null,
"ad_group_name": null,
"asset_group_id": null,
"is_deterministic": false,
},
"device_info": {
"device_model": "iphone12,3",
"os_version": "14"
},
"timestamp": 1432681918.123456
}],
"errors": [],
"attributed": true
}في ما يلي مثال على استجابة لإحالة ناجحة غير قطعية في Android:
{
"ad_events": [
{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "click",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"network_type": null,
"network_subtype": null,
"ad_group_id": null,
"ad_group_name": null,
"asset_group_id": null,
"is_deterministic": false,
"geo_info": {
"city": "san jose",
"country": "US",
"region": "california"
},
"device_info": {
"device_model": "sm-s926u",
"os_version": "14"
},
"timestamp": 1432681918.123456
},
],
"errors": [],
"warnings": []
}في ما يلي مثال على ردّ لإحالة ناجحة على iOS أو Android تم تحديد مصدرها من خلال gbraid:
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "engagement",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"interaction_type": "engagement",
"network_type": "NULL",
"asset_group_id": null,
"is_deterministic": true,
"timestamp": 0.000000
}],
"errors": [],
"attributed": true,
"warnings": [],
}في ما يلي مثال على ردّ تتبُّع الإحالات الناجحة عندما يتضمّن الطلب أخطاء:
{
"ad_events": [],
"errors": ["INVALID_CURRENCY_CODE"],
"attributed": false
}في ما يلي مثال على ردّ سلبي من نظام تتبُّع الإحالات الناجحة:
{
"ad_events": [],
"errors": [],
"attributed": false
}سيتم عرض ردّ على تتبُّع الإحالات الناجحة لجميع طلبات تتبُّع الإحالات الناجحة.
في ما يلي مثال على ردّ إيجابي بشأن تتبُّع الإحالات الناجحة لمستخدم من خارج المنطقة الاقتصادية الأوروبية في "حملة تطبيقات عامة":
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "engagement",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "Search",
"network_subtype": "GoogleSearch",
"video_id": null,
"keyword": null,
"match_type": null,
"placement": null,
"ad_group_id": null,
"ad_group_name": "",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
}],
"errors": [],
"attributed": true,
"warnings": []
}في ما يلي مثال على ردّ إيجابي لتتبُّع الإحالات الناجحة لمستخدم من خارج المنطقة الاقتصادية الأوروبية في "حملة على شبكة البحث":
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "engagement",
"campaign_type": "Search",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "Search",
"network_subtype": "GoogleSearch",
"video_id": null,
"keyword": "+space +birds",
"match_type": "b",
"placement": null,
"ad_group_id": 123456789,
"ad_group_name": "My App AdGroup",
"asset_group_id": null,
"creative_id": 123456789,
"timestamp": 1432681913.123456
}],
"errors": [],
"attributed": true,
"warnings": []
}في ما يلي مثال على استجابة إيجابية لتتبُّع الإحالات الناجحة لمستخدم من خارج المنطقة الاقتصادية الأوروبية في "حملة على الشبكة الإعلانية":
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "engagement",
"campaign_type": "Display",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "Display",
"network_subtype": "mGDN",
"video_id": null,
"keyword": null,
"match_type": null,
"placement": "mobile-app::2-343200656",
"ad_group_id": 123456789,
"ad_group_name": "My App AdGroup",
"asset_group_id": null,
"creative_id": 123456789,
"timestamp": 1432681913.123456
}],
"errors": [],
"attributed": true,
"warnings": []
}في ما يلي مثال على استجابة إيجابية لتتبُّع الإحالات الناجحة لمستخدم من خارج المنطقة الاقتصادية الأوروبية في حملة على YouTube:
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "engagement",
"campaign_type": "Video",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "YouTube",
"network_subtype": "YouTubeVideos",
"video_id": "dQw4w9WgXcQ",
"keyword": null,
"match_type": null,
"placement": null,
"ad_group_id": 123456789,
"ad_group_name": "My App AdGroup",
"asset_group_id": null,
"creative_id": 123456789,
"timestamp": 1432681913.123456
}],
"errors": [],
"attributed": true,
"warnings": []
}في ما يلي مثال على استجابة تتبُّع الإحالات الناجحة التي تم تحديد مصدرها، حيث يتم تحديد مصدر الإحالة الناجحة على أنّه تفاعلات مع إعلانات على Play وعلى "شبكة البحث"، ولكن تم رفض الموافقة على الاستخدام المشترك بين منصتَي Play و"شبكة البحث" بموجب البندين 5(2)(ب) و5(2)(ج) من "سياسات المنصات المرتبطة":
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "click",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "Display",
"network_subtype": "",
"video_id": null,
"keyword": null,
"match_type": null,
"placement": null,
"ad_group_id": null,
"ad_group_name": "",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
},
{
"ad_event_id": "I8YUwWqxvOyqcwOcqBAkYZBMaOONSd",
"conversion_metric": "conversion",
"interaction_type": "click",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "Search",
"network_subtype": "",
"video_id": null,
"keyword": null,
"match_type": null,
"placement": null,
"ad_group_id": null,
"ad_group_name": "",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
}
],
"errors": [],
"warnings": [],
"attributed": true
}مثال على استجابة تتبُّع الإحالات الناجحة التي تم تحديد مصدرها، حيث يتم تحديد مصدر الإحالة الناجحة على أنّه تفاعلات مع إعلانات على Play وإعلانات على شبكة البحث، ويتم قبول الموافقة على الاستخدام المشترك بموجب البندين 5(2)(ب) و5(2)(ج) بين منصّتَي Play وشبكة البحث اللتين تستخدمان نظام الدفع لكلّ ألف ظهور، يشبه سلوك الإحالة الناجحة الحالي:
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "click",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "Display",
"network_subtype": "",
"video_id": null,
"keyword": null,
"match_type": null,
"placement": null,
"ad_group_id": null,
"ad_group_name": "",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
}
],
"errors": [],
"warnings": [],
"attributed": true
}في ما يلي مثال على ردّ لتتبُّع الإحالات الناجحة مع تحديد المصدر، حيث يتم تحديد مصدر الإحالة الناجحة على أنّه تفاعلات مع إعلانات على Play و"شبكة البحث" وYouTube، ويتم قبول الموافقة على الاستخدام المشترك بموجب البندين 5(2)(ب) و5(2)(ج) بين "وحدات معالجة الإشارات" في Play و"شبكة البحث"، ولكن يتم رفضها لوحدة معالجة الإشارات في YouTube:
{
"ad_events": [{
"ad_event_id": "Q2owS0VRancwZHk0QlJDdXVMX2U1TQ",
"conversion_metric": "conversion",
"interaction_type": "click",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "Display",
"network_subtype": "",
"video_id": null,
"keyword": null,
"match_type": null,
"placement": null,
"ad_group_id": null,
"ad_group_name": "",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
},
{
"ad_event_id": "I8YUwWqxvOyqcwOcqBAkYZBMaOONSd",
"conversion_metric": "conversion",
"interaction_type": "click",
"campaign_type": "ACI",
"campaign_id": 123456789,
"campaign_name": "My App Campaign",
"ad_type": "ClickToDownload",
"external_customer_id": 123456789,
"location": 21144,
"network_type": "YouTube",
"network_subtype": "YouTubeVideos",
"video_id": null,
"keyword": null,
"match_type": null,
"placement": null,
"ad_group_id": null,
"ad_group_name": "",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
}
],
"errors": [],
"warnings": [],
"attributed": true
}طلب الإحالة على جميع الشبكات
عندما تردّ "إعلانات Google" بشكل إيجابي على طلب تتبُّع الإحالات الناجحة، على مستهلك واجهة برمجة التطبيقات إبلاغ "إعلانات Google" بقرار تحديد المصدر على مستوى شبكات متعدّدة بعد تحديد النقرة الأخيرة.
يكون طلب تحديد المصدر على مستوى شبكات متعدّدة مطابقًا لطلب تتبُّع الإحالات الناجحة الأصلي، ولكن مع مسار طلب على النحو التالي:
/pagead/conversion/app/1.1/cross_network
وإضافة مَعلمتَين مطلوبتَين:
| طلب الإحالة على جميع الشبكات | |
|---|---|
ad_event_id |
مطلوب الموقع الجغرافي: طلب البحث المعرّف |
attributed |
مطلوب الموقع الجغرافي: طلب البحث تُستخدَم لتحديد ما إذا كانت "إعلانات Google" قد تلقّت نسبة مساهمة في الإحالة الناجحة من خلال مستهلك واجهة برمجة التطبيقات. إما |
في ما يلي مثال على طلب صالح للإحالة على جميع الشبكات:
POST /pagead/conversion/app/1.1/cross_network
?dev_token=Z_eErE4DkvcKjDM1OVE4c4
&link_id=31FF8D67E5BB5DD5029DCC2734C2F884
&app_event_type=custom
&app_event_name=level_achieved
&rdid=0F7AB11F-DA50-498E-B225-21AC1977A85D
&id_type=idfa
&lat=0
&app_version=1.2.4
&os_version=9.3.2
&sdk_version=1.9.5r6
×tamp=1432681913.123456
&value=1.99
¤cy_code=USD
&ad_event_id=Q2owS0VRancwZHk0QlJDdXVMX2U1TQ
&attributed=1
Host: www.googleadservices.com
User-Agent: MyAnalyticsCompany/1.0.0 (iOS 10.0.2; en_US; iPhone9,1; Build/13D15; Proxy)
X-Forwarded-For: 216.58.194.174
Content-Type: application/json; charset=utf-8سيتلقّى طلب تحديد المصدر الصالح على مستوى شبكات متعدّدة دائمًا استجابة عامة برمز الحالة 200 بدون نص الاستجابة.