- درخواست HTTP
- پارامترهای مسیر
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- ClickConversion
- ExternalAttributionData
- CartData
- مورد
- ConversionEnvironment
- ClickConversionResult
- آن را امتحان کنید!
تبدیل کلیک های داده شده را پردازش می کند.
لیست خطاهای پرتاب شده: AuthenticationError AuthorizationError ConversionUploadError HeaderError داخلی خطای جزئی خطا خطا QuotaError RequestError
درخواست HTTP
POST https://googleads.googleapis.com/v16/customers/{customerId}:uploadClickConversions
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
customerId | ضروری. شناسه مشتری که بارگذاری را انجام می دهد. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"conversions": [
{
object ( |
زمینه های | |
---|---|
conversions[] | ضروری. تبدیل هایی که در حال آپلود هستند. |
partialFailure | ضروری. اگر درست باشد، عملیات موفقیت آمیز انجام می شود و عملیات نامعتبر خطاها را برمی گرداند. اگر نادرست باشد، تمام عملیات در یک تراکنش انجام میشود، اگر و تنها در صورتی که همه آنها معتبر باشند. این باید همیشه روی true تنظیم شود. برای اطلاعات بیشتر درباره خرابی جزئی به https://developers.google.com/google-ads/api/docs/best-practices/partial-failures مراجعه کنید. |
validateOnly | اگر درست باشد، درخواست تایید می شود اما اجرا نمی شود. فقط خطاها برمی گردند، نه نتایج. |
debugEnabled | اگر درست باشد، API همه بررسیهای آپلود را انجام میدهد و در صورت یافتن خطاها را برمیگرداند. اگر نادرست باشد، فقط اعتبار ورودی اولیه را انجام میدهد، بررسیهای آپلود بعدی را رد میکند و حتی اگر هیچ کلیکی برای این تنظیم فقط بر تبدیلهای پیشرفته برای بارگذاریهای سرنخ که از پیش فرض نادرست است. |
jobId | اختیاری. ورودی اختیاری برای تنظیم شناسه شغل. اگر ارائه شود باید عددی غیر منفی باشد که کمتر از 2^31 باشد. اگر این فیلد ارائه نشود، API یک شناسه شغلی در محدوده [2^31, (2^63)-1] ایجاد می کند. API مقدار این درخواست را در قسمت |
بدن پاسخگو
پیام پاسخ برای ConversionUploadService.UploadClickConversions
.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "partialFailureError": { object ( |
زمینه های | |
---|---|
partialFailureError | خطاهایی که مربوط به شکست تبدیل در حالت شکست جزئی است. زمانی که همه خطاها در داخل تبدیل ها رخ می دهد، برگردانده می شود. اگر هر خطایی خارج از تبدیل ها رخ دهد (مثلاً خطاهای تأیید اعتبار)، یک خطای سطح RPC را برمی گردانیم. برای اطلاعات بیشتر درباره خرابی جزئی به https://developers.google.com/google-ads/api/docs/best-practices/partial-failures مراجعه کنید. |
results[] | برای تبدیلهای پردازش شده با موفقیت برگردانده شد. Proto برای ردیف هایی که خطا دریافت کرده اند خالی خواهد بود. زمانی که validateOnly true باشد، نتایج برگردانده نمی شوند. |
jobId | شناسه شغلی برای دسته آپلود. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/adwords
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
ClickConversion
تبدیل کلیکی
نمایندگی JSON |
---|
{ "gbraid": string, "wbraid": string, "externalAttributionData": { object ( |
زمینه های | |
---|---|
gbraid | شناسه کلیک برای کلیکهای مرتبط با تبدیل برنامهها و از دستگاههای iOS که با iOS14 شروع میشوند. |
wbraid | شناسه کلیک برای کلیکهای مرتبط با تبدیلهای وب و از دستگاههای iOS که با iOS14 شروع میشوند. |
externalAttributionData | دادههای اضافی درباره تبدیلهای نسبت داده شده خارجی. این فیلد برای تبدیلهایی با یک کنش تبدیل نسبت داده شده خارجی لازم است، اما نباید در غیر این صورت تنظیم شود. |
customVariables[] | متغیرهای سفارشی مرتبط با این تبدیل. |
cartData | دادههای سبد خرید مرتبط با این تبدیل. |
userIdentifiers[] | شناسه های کاربر مرتبط با این تبدیل. فقط hashedEmail و hashedPhoneNumber برای آپلودهای تبدیل پشتیبانی میشوند. حداکثر تعداد شناسه های کاربر برای هر تبدیل 5 عدد است. |
conversionEnvironment | محیطی که این تبدیل در آن ثبت شده است، به عنوان مثال، برنامه یا وب. |
consent | تنظیم رضایت برای رویداد. |
gclid | شناسه کلیک Google (gclid) مرتبط با این تبدیل. |
conversionAction | نام منبع عمل تبدیل مرتبط با این تبدیل. توجه: اگرچه نام این منبع از یک شناسه مشتری و یک شناسه اقدام تبدیل تشکیل شده است، اعتبارسنجی شناسه مشتری را نادیده می گیرد و از شناسه اقدام تبدیل به عنوان تنها شناسه کنش تبدیل استفاده می کند. |
conversionDateTime | تاریخی که در آن تبدیل صورت گرفته است. باید بعد از زمان کلیک باشد. منطقه زمانی باید مشخص شود. قالب "yyyy-mm-dd hh:mm:ss+|-hh:mm" است، برای مثال، "01-01-2019 12:32:45-08:00". |
conversionValue | ارزش تبدیل برای تبلیغ کننده. |
currencyCode | ارز مرتبط با ارزش تبدیل. این کد ارز 3 کاراکتری ISO 4217 است. به عنوان مثال: USD، EUR. |
orderId | شناسه سفارش مرتبط با تبدیل. شناسه سفارش فقط برای یک تبدیل در هر اقدام تبدیل قابل استفاده است. |
ExternalAttributionData
حاوی اطلاعات اضافی درباره تبدیلهای نسبت داده شده خارجی است.
نمایندگی JSON |
---|
{ "externalAttributionCredit": number, "externalAttributionModel": string } |
زمینه های | |
---|---|
externalAttributionCredit | نشان دهنده کسری از تبدیلی است که به کلیک Google Ads نسبت داده می شود. |
externalAttributionModel | نام مدل انتساب را مشخص می کند. |
CartData
حاوی اطلاعات اضافی درباره اطلاعات سبد خرید است.
نمایندگی JSON |
---|
{
"merchantId": string,
"feedCountryCode": string,
"feedLanguageCode": string,
"localTransactionCost": number,
"items": [
{
object ( |
زمینه های | |
---|---|
merchantId | شناسه Merchant Center که در آن موارد آپلود می شوند. |
feedCountryCode | کد کشور مرتبط با فید که در آن موارد آپلود می شوند. |
feedLanguageCode | کد زبان مرتبط با فید که در آن موارد آپلود می شوند. |
localTransactionCost | مجموع تمام تخفیف های سطح تراکنش، مانند ارسال رایگان و تخفیف کوپن برای کل سبد خرید. کد ارز همان است که در پیام ClickConversion وجود دارد. |
items[] | داده های اقلام خریداری شده |
مورد
حاوی اطلاعات اقلام خریداری شده است.
نمایندگی JSON |
---|
{ "productId": string, "quantity": integer, "unitPrice": number } |
زمینه های | |
---|---|
productId | شناسه خرید کالا باید با شناسه محصول Merchant Center برابر باشد. |
quantity | تعداد اقلام فروخته شده |
unitPrice | قیمت واحد بدون احتساب مالیات، حمل و نقل، و هر گونه تخفیف در سطح تراکنش. کد ارز همان است که در پیام ClickConversion وجود دارد. |
ConversionEnvironment
محیط تبدیل تبدیل آپلود شده.
Enums | |
---|---|
UNSPECIFIED | مشخص نشده است. |
UNKNOWN | فقط برای مقدار برگشتی استفاده می شود. نشان دهنده مقدار ناشناخته در این نسخه است. |
APP | تبدیل در یک برنامه ثبت شد. |
WEB | تبدیل در یک وب سایت ثبت شد. |
ClickConversionResult
شناسایی اطلاعات برای یک ClickConversion که با موفقیت پردازش شده است.
نمایندگی JSON |
---|
{
"gbraid": string,
"wbraid": string,
"userIdentifiers": [
{
object ( |
زمینه های | |
---|---|
gbraid | شناسه کلیک برای کلیکهای مرتبط با تبدیل برنامهها و از دستگاههای iOS که با iOS14 شروع میشوند. |
wbraid | شناسه کلیک برای کلیکهای مرتبط با تبدیلهای وب و از دستگاههای iOS که با iOS14 شروع میشوند. |
userIdentifiers[] | شناسه های کاربر مرتبط با این تبدیل. فقط hashedEmail و hashedPhoneNumber برای آپلودهای تبدیل پشتیبانی میشوند. حداکثر تعداد شناسه های کاربر برای هر تبدیل 5 عدد است. |
gclid | شناسه کلیک Google (gclid) مرتبط با این تبدیل. |
conversionAction | نام منبع عمل تبدیل مرتبط با این تبدیل. |
conversionDateTime | تاریخی که در آن تبدیل صورت گرفته است. قالب "yyyy-mm-dd hh:mm:ss+|-hh:mm" است، برای مثال، "01-01-2019 12:32:45-08:00". |