نماینده کاربر برنامه
بهعنوان بخشی از تلاشهای گستردهتر ما برای مبارزه با هرزنامه، مشخصات استانداردشدهای برای سرایند «عامل کاربر» که محصول تجزیهوتحلیل/تبلیغات ازطرف کاربر برنامه ارسال میکند توسعه دادهایم. «عامل کاربر» برنامه میتواند از کد بومی استخراج شود تا از مشخصات زیر پیروی کند:
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 را در انتهای «عامل کاربر» برنامه هنگام ساختن
«عامل کاربر» برنامه در سمت سرور اضافه کنید. اگر «عامل کاربر» برنامه کاملاً در سمت
کاربر ساخته شده است، ; 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 Ads را از رویداد برنامهای که باید بهعنوان تبدیل پیگیری شود و/یا برای تکمیل فهرست بازاریابی مجدد استفاده شود مطلع کند و فرادادهای را که هر کلیک پیشاز رویداد را توصیف میکند بازیابی کند.
همه فراخوانیهای API به دامنه www.googleadservices.com انجام میشود. درخواستهای تبدیل
درخواستهای POST ازطریق HTTPS در مسیر زیر است:
/pagead/conversion/app/version
درخواست تبدیل برنامه استاندارد شامل پارامترهای زیر برای «میانای برنامهسازی کاربردی تبدیل برنامه نسخه ۱.۱» خواهد بود.
| درخواست «ردیابی تبدیل» | |
|---|---|
dev_token |
الزامی مکان: پُرسمان کد توسعهدهنده یکتا و ثابتی که برای مصرفکننده «میانای برنامهسازی کاربردی» صادر شده است. Z_eErE4DkvcKjDM1OVE4c4 |
link_id |
الزامی مکان: پُرسمان شناسه پیوند که نشان توسعهدهنده مصرفکننده API را به یک برنامه خاص پیوند میدهد. 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 |
الزامی مکان: پُرسمان نسخه کیت توسعه نرمافزار که رویداد را اندازهگیری کرده است. ازآنجاییکه این نسخه عمدتاً برای اشکالزدایی استفاده میشود، باید نسخه انتشار را دقیقاً همانگونه که با انتشار کیت توسعه نرمافزار شما منتشر میشود منعکس کند. اگر برنامه از کیت توسعه نرمافزار استفاده نمیکند، لطفاً همان مقدار را بهعنوان 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 ارسال شوند. پیامهای پینگ دریافتی ازطریق HTTP رد خواهند شد.
لطفاً توجه داشته باشید که اگر بدنه درخواست خالی باشد (در مواردی که هیچ داده رویداد غنیای در بار app_event_data منتقل نمیشود)، سرور ما لازم میداند که سرصفحه Content-Length: 0 را در درخواستتان بهطور صریح تنظیم کنید.
کدبندی دادههای رویداد
برای پارامتر بدنه app_event_data، لطفاً از قراردادهای زیر برای انواع دادههای ابتدایی استفاده کنید:
شناور
- استفاده از نویسه نقطه بهعنوان جداکننده اعشار مستقل از بومیسازی برنامه
- از دقت اعشاری دورقمی برای نشان دادن مقادیر پولی استفاده کنید. برای نمونه ۲٫۹۹
- از نماد نمایی، مثلاً 2E+9، استفاده نکنید
- برای جدا کردن گروههای رقم، از نویسه ویرگول استفاده نکنید، برای نمونه ۱٬۰۰۰٬۰۰۰
- نمونههای معتبر:
-0.52.991000000.123
عدد صحیح
- فقط مقادیر صحیح بدون رقم اعشار ارسال کنید
- از نویسه ویرگول برای جدا کردن گروههای رقم استفاده نکنید، برای نمونه ۱٬۰۰۰٬۰۰۰
- نمونههای معتبر:
1000-110
تاریخ
- قالب تاریخ: yyyy-mm-dd
-
yyyy= سال چهار رقمی، برای نمونه ۲۰۱۶ -
mm= ماه دو رقمی، برای نمونه ۰۹ برای سپتامبر -
dd= روز دو رقمی، برای نمونه ۲۳ برای بیستوسوم ماه
-
- همیشه تعداد ارقام مشخصشده در بالا را ارسال کنید، برای مثال اگر مقدار dd را برای پنجمین روز ماه ارسال میکنید،
05را ارسال کنید. - نمونههای معتبر:
"2016-09-23""1990-12-31"
- قالب تاریخ: yyyy-mm-dd
مهر زمان
- قالب زمان: مُهر زمان Unix/Epoch در ثانیه که در منطقه زمانی ساعت هماهنگ جهانی با دقت میکروثانیه تعریف شده است
- نمونههای معتبر:
1478713087برای چهارشنبه، ۹ نوامبر ۲۰۱۶، ۱۷:۳۸:۰۷ به وقت گرینویچ1073513982.123000برای چهارشنبه، ۷ ژانویه ۲۰۰۴، ساعت ۲۲:۱۹:۴۲.۱۲۳ به وقت گرینویچ
آرایهها
- فقط آرایههای مقادیر اولیه (رشتهها، اعداد، و مقادیر بولی) را ارسال کنید
- نمونههای معتبر:
[123, 456, 789]["abc"]
درخواستهای نمونه
نمونهای از درخواست اولین باز کردن با «سنجش در دستگاه: دادههای رویداد کیت توسعه نرمافزار برای سنجش تبدیل یکپارچه» بهاینصورت است:
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نمونهای از درخواست اولین باز کردن بدون «سنجش در دستگاه: کیت توسعه نرمافزار دادههای رویداد برای سنجش تبدیل یکپارچه» بهاینصورت است:
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نمونهای از درخواست پساز نصب با «سنجش در دستگاه: کیت توسعه نرمافزار داده رویداد برای سنجش تبدیل یکپارچه» بهاینصورت است:
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نمونهای از درخواست باز کردن اولیه بدون «اندازهگیری در دستگاه»: رویداد کیت توسعه نرمافزار داده بهاینصورت است:
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 نسخه ۱.۱ بهاینصورت است:
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"]}}نمونهای از درخواست ردیابی تبدیل معتبر با نوع رویداد غیرسفارشی و اطلاعات درآمد با rdid (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» برای همه درخواستهای DMA در محدوده الزامی است.
رویدادهای آگهی اشیای اصلی اسناد برنامه هستند و حاوی ویژگیهای زیر خواهند بود.
نکات مهم درباره رفتار پاسخ وابسته به رضایت کاربر:
اگر تبدیل دارای رضایت دادههای کاربر آگهی باشد و کاربر در
تنظیمات کاربر Google خود رضایت استفاده متقابل داشته باشد، Google Ads با یک کلیک آخر
در همه CPSهای خود پاسخ خواهد داد. اگر کاربر در تنظیمات کاربر Google خود با استفاده متقابل موافقت نکرده باشد، Google Ads براساس هر «قیمت بهازای فروش» با چندین کلیک آخر پاسخ خواهد داد.
اگر تبدیل شامل برخیاز «سرویسهای پلاتفرم مشترک» در رضایت استفاده مشترک انتخابشده توسط کاربر باشد
اما شامل برخی دیگر نباشد، Google Ads با یک کلیک آخر در سراسر
«سرویسهای پلاتفرم مشترک» که رضایت استفاده مشترک برای آنها اعطا شده است پاسخ خواهد داد، اما با چندین کلیک آخر، براساس هر «سرویس پلاتفرم مشترک»، برای آن «سرویسهای پلاتفرم مشترک» که رضایت استفاده مشترک برای آنها اعطا نشده است.
| پاسخ «ردیابی تبدیل» | |
|---|---|
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 Ads استفاده کرد. 123456789 |
location |
همیشه موجود است شماره کد شناسه مکان برای مکان جغرافیایی رویداد آگهی. برای تفسیر کدهای مکان، به مرجع Google Ads API مراجعه کنید. |
network_type |
همیشه موجود است رشته این فیلد شبکه تبلیغات Google Ads را که رویداد آگهی در آن رخ داده است شناسایی میکند. مقادیر ممکن به شرح زیر است. Search Display YouTube GoogleTv cross-network |
network_subtype |
وقتی رشته این فیلد «زیرنوع» شبکه تبلیغات Google Ads را که رویداد آگهی در آن رخ داده است شناسایی میکند. مقادیر ممکن براساس نوع شبکه اصلی متفاوت است. جستجوجستجوی معمولی GoogleGoogleSearch SearchPartners نمایشناشران وب تلفن همراهmGDN Google AdMob YouTubeشبکه ویدیوهای YouTubeYouTubeVideos 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 |
فقط زمانی ارائه میشود که شماره شناسه عددی گروه آگهی که رویداد آگهی را تولید کرده است. این مقدار منحصربهفرد تضمینشده است. این فیلد برای رویدادهای آگهی نسبتدادهشده gbraid که بهصورت قطعی نسبت داده شدهاند ( 123456789 |
ad_group_name |
فقط وقتی رشته نام گروه آگهی تعریفشده توسط تبلیغکننده برای گروه آگهی که رویداد آگهی را تولید کرده است. این مقدار تضمین نمیکند که منحصربهفرد باشد. این فیلد برای رویدادهای آگهی نسبتدادهشده gbraid که بهصورت قطعی نسبت داده شدهاند ( 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": 123456789,
"ad_group_name": "My App AdGroup",
"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": 123456789,
"ad_group_name": "My App AdGroup",
"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": 123456789,
"ad_group_name": "My App AdGroup",
"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,
"ad_group_id": null,
"ad_group_name": 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": 123456789,
"ad_group_name": "My App AdGroup",
"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": null,
"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": null,
"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": null,
"asset_group_id": null,
"creative_id": 123456789,
"timestamp": 1432681913.123456
}],
"errors": [],
"attributed": true,
"warnings": []
}نمونهای از پاسخ پایش تبدیل اسنادی که تبدیل به هر دو تعامل آگهی «جستجو» + Play نسبت داده شده است اما رضایت استفاده متقابل 5(2)(b) + 5(2)(c) بین «جستجو» + Play CPS رد شده است:
{
"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": 123456789,
"ad_group_name": "My App AdGroup",
"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": 123456789,
"ad_group_name": "My App AdGroup",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
}
],
"errors": [],
"warnings": [],
"attributed": true
}نمونهای از پاسخ ردیابی تبدیل اسنادی که در آن تبدیل به هر دو تعامل آگهی «جستجو» + Play نسبت داده شده است و رضایت استفاده متقابل 5(2)(b) + 5(2)(c) بین «جستجو» + Play CPS پذیرفته شده است، مشابه رفتار تبدیل امروز است:
{
"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": 123456789,
"ad_group_name": "My App AdGroup",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
}
],
"errors": [],
"warnings": [],
"attributed": true
}نمونهای از پاسخ ردیابی تبدیل نسبتدادهشده که در آن تبدیل به هر دو تعامل آگهی Play، «جستجو»، و YouTube نسبت داده شده است و رضایت استفاده متقابل 5(2)(b) + 5(2)(c) بین «کانالهای مقایسه قیمت» 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": 123456789,
"ad_group_name": "My App AdGroup",
"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": 123456789,
"ad_group_name": "My App AdGroup",
"asset_group_id": null,
"creative_id": null,
"timestamp": 1432681913.123456
}
],
"errors": [],
"warnings": [],
"attributed": true
}درخواست ارجاع بینشبکهای
وقتی Google Ads به درخواست ردیابی تبدیل پاسخ مثبت میدهد، مصرفکننده API باید پساز شناسایی آخرین کلیک، تصمیم خود درباره اسناد شبکه را به Google Ads اطلاع دهد.
درخواست اسنادی شبکه متقابل با درخواست ردیابی تبدیل اصلی یکسان است، اما با مسیر درخواست زیر:
/pagead/conversion/app/1.1/cross_network
و افزودن دو پارامتر الزامی:
| درخواست ارجاع بینشبکهای | |
|---|---|
ad_event_id |
الزامی مکان: پُرسمان شناسه |
attributed |
الزامی مکان: پُرسمان اینکه آیا Google Ads برای تبدیل ازسوی مصرفکننده API اعتبار دریافت کرده است یا نه. یا |
نمونهای از درخواست اسنادی معتبر بین شبکهای:
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درخواست اسنادی معتبر بین شبکهای همیشه پاسخ عمومی ۲۰۰ بدون بدنه پاسخ دریافت میکند.