احتیاط: شما در حال مشاهده اسناد رابط REST API هستید. اکثر کتابخانه های مشتری رسمی ما از gRPC استفاده می کنند. برای جزئیات بیشتر به مقدمه REST مراجعه کنید.

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Method: customers.uploadClickConversions

درخواست HTTP
پارامترهای مسیر
درخواست بدن
- نمایندگی JSON
بدن پاسخگو
- نمایندگی JSON
محدوده مجوز
ClickConversion
- نمایندگی JSON
ExternalAttributionData
- نمایندگی JSON
CartData
- نمایندگی JSON
مورد
- نمایندگی JSON
ConversionEnvironment
ClickConversionResult
- نمایندگی JSON
آن را امتحان کنید!

تبدیل کلیک های داده شده را پردازش می کند.

فهرست خطاهای پرتاب شده: AuthenticationError AuthorizationError ConversionUploadError HeaderError داخلی خطای جزئی خطا خطا QuotaError RequestError

درخواست HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}:uploadClickConversions

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های

مولفه های
`customerId`	`string` ضروری. شناسه مشتری که بارگذاری را انجام می دهد.

customerId

string

ضروری. شناسه مشتری که بارگذاری را انجام می دهد.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{ "conversions": [ { object (`ClickConversion`) } ], "partialFailure": boolean, "validateOnly": boolean, "debugEnabled": boolean }

زمینه های
`conversions[]`	`object ( ClickConversion )` ضروری. تبدیل هایی که در حال آپلود هستند.
`partialFailure`	`boolean` ضروری. اگر درست باشد، عملیات موفقیت آمیز انجام می شود و عملیات نامعتبر خطاها را برمی گرداند. اگر نادرست باشد، تمام عملیات در یک تراکنش انجام می‌شود، اگر و تنها در صورتی که همه آنها معتبر باشند. این باید همیشه روی true تنظیم شود. برای اطلاعات بیشتر درباره خرابی جزئی به https://developers.google.com/google-ads/api/docs/best-practices/partial-failures مراجعه کنید.
`validateOnly`	`boolean` اگر درست باشد، درخواست تایید می شود اما اجرا نمی شود. فقط خطاها برمی گردند، نه نتایج.
`debugEnabled`	`boolean` اگر درست باشد، API همه بررسی‌های آپلود را انجام می‌دهد و در صورت یافتن خطاها را برمی‌گرداند. اگر نادرست باشد، فقط اعتبار ورودی اولیه را انجام می‌دهد، بررسی‌های آپلود بعدی را رد می‌کند و حتی اگر هیچ کلیکی برای `userIdentifiers` ارائه‌شده یافت نشد، موفقیت را باز می‌گرداند. این تنظیم فقط بر تبدیل‌های پیشرفته برای بارگذاری‌های سرنخ که از `userIdentifiers` به جای `GCLID` ، `GBRAID` ، یا `WBRAID` استفاده می‌کنند، تأثیر می‌گذارد. هنگام آپلود تبدیل‌های بهبودیافته برای سرنخ‌ها، باید همه رویدادهای تبدیل را در API آپلود کنید، از جمله مواردی که ممکن است از کمپین‌های تبلیغات Google نباشد. اگر این فیلد روی `true` تنظیم شود، بارگذاری رویدادی که از یک کمپین تبلیغاتی Google نیست، منجر به خطای `CLICK_NOT_FOUND` خواهد شد. از آنجایی که این خطاها برای چنین رویدادهایی انتظار می‌رود، این فیلد را روی `false` تنظیم کنید تا بتوانید تأیید کنید که آپلودهای شما به درستی قالب‌بندی شده‌اند، اما `CLICK_NOT_FOUND` خطاهای همه تبدیل‌هایی که از یک کمپین تبلیغاتی Google نیستند را نادیده بگیرید. این به شما امکان می دهد فقط بر روی خطاهایی تمرکز کنید که می توانید آنها را برطرف کنید. پیش فرض نادرست است.

بدن پاسخگو

پیام پاسخ برای ConversionUploadService.UploadClickConversions .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{ "partialFailureError": { object (`Status`) }, "results": [ { object (`ClickConversionResult`) } ], "jobId": string }

زمینه های

زمینه های
`partialFailureError`	`object ( Status )` خطاهایی که مربوط به شکست تبدیل در حالت شکست جزئی است. زمانی که همه خطاها در داخل تبدیل ها رخ می دهد، برگردانده می شود. اگر هر خطایی خارج از تبدیل ها رخ دهد (مثلاً خطاهای تأیید اعتبار)، یک خطای سطح RPC را برمی گردانیم. برای اطلاعات بیشتر درباره خرابی جزئی به https://developers.google.com/google-ads/api/docs/best-practices/partial-failures مراجعه کنید.
`results[]`	`object ( ClickConversionResult )` برای تبدیل‌های پردازش شده با موفقیت برگردانده شد. Proto برای ردیف هایی که خطا دریافت کرده اند خالی خواهد بود. زمانی که validateOnly true باشد، نتایج برگردانده نمی شوند.
`jobId`	`string ( int64 format)` شناسه شغلی برای دسته آپلود.

partialFailureError

object ( Status )

خطاهایی که مربوط به شکست تبدیل در حالت شکست جزئی است. زمانی که همه خطاها در داخل تبدیل ها رخ می دهد، برگردانده می شود. اگر هر خطایی خارج از تبدیل ها رخ دهد (مثلاً خطاهای تأیید اعتبار)، یک خطای سطح RPC را برمی گردانیم. برای اطلاعات بیشتر درباره خرابی جزئی به https://developers.google.com/google-ads/api/docs/best-practices/partial-failures مراجعه کنید.

results[]

object ( ClickConversionResult )

برای تبدیل‌های پردازش شده با موفقیت برگردانده شد. Proto برای ردیف هایی که خطا دریافت کرده اند خالی خواهد بود. زمانی که validateOnly true باشد، نتایج برگردانده نمی شوند.

jobId

string ( int64 format)

شناسه شغلی برای دسته آپلود.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

https://www.googleapis.com/auth/adwords

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ClickConversion

تبدیل کلیکی

نمایندگی JSON

نمایندگی JSON
{ "gbraid": string, "wbraid": string, "externalAttributionData": { object (`ExternalAttributionData`) }, "customVariables": [ { object (`CustomVariable`) } ], "cartData": { object (`CartData`) }, "userIdentifiers": [ { object (`UserIdentifier`) } ], "conversionEnvironment": enum (`ConversionEnvironment`), "gclid": string, "conversionAction": string, "conversionDateTime": string, "conversionValue": number, "currencyCode": string, "orderId": string }

{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}

زمینه های
`gbraid`	`string` شناسه کلیک برای کلیک‌های مرتبط با تبدیل برنامه‌ها و از دستگاه‌های iOS که با iOS14 شروع می‌شوند.
`wbraid`	`string` شناسه کلیک برای کلیک‌های مرتبط با تبدیل‌های وب و از دستگاه‌های iOS که با iOS14 شروع می‌شوند.
`externalAttributionData`	`object ( ExternalAttributionData )` داده‌های اضافی درباره تبدیل‌های نسبت داده شده خارجی. این فیلد برای تبدیل‌هایی با یک کنش تبدیل نسبت داده شده خارجی لازم است، اما نباید در غیر این صورت تنظیم شود.
`customVariables[]`	`object ( CustomVariable )` متغیرهای سفارشی مرتبط با این تبدیل.
`cartData`	`object ( CartData )` داده‌های سبد خرید مرتبط با این تبدیل.
`userIdentifiers[]`	`object ( UserIdentifier )` شناسه های کاربر مرتبط با این تبدیل. فقط hashedEmail و hashedPhoneNumber برای آپلودهای تبدیل پشتیبانی می‌شوند. حداکثر تعداد شناسه های کاربر برای هر تبدیل 5 عدد است.
`conversionEnvironment`	`enum ( ConversionEnvironment )` محیطی که این تبدیل در آن ثبت شده است، به عنوان مثال، برنامه یا وب.
`gclid`	`string` شناسه کلیک Google (gclid) مرتبط با این تبدیل.
`conversionAction`	`string` نام منبع عمل تبدیل مرتبط با این تبدیل. توجه: اگرچه این نام منبع از یک شناسه مشتری و یک شناسه اقدام تبدیل تشکیل شده است، اعتبارسنجی شناسه مشتری را نادیده می گیرد و از شناسه اقدام تبدیل به عنوان تنها شناسه کنش تبدیل استفاده می کند.
`conversionDateTime`	`string` تاریخی که در آن تبدیل صورت گرفته است. باید بعد از زمان کلیک باشد. منطقه زمانی باید مشخص شود. قالب "yyyy-mm-dd hh:mm:ss+\|-hh:mm" است، برای مثال، "01-01-2019 12:32:45-08:00".
`conversionValue`	`number` ارزش تبدیل برای تبلیغ کننده.
`currencyCode`	`string` ارز مرتبط با ارزش تبدیل. این کد ارز 3 کاراکتری ISO 4217 است. به عنوان مثال: USD، EUR.
`orderId`	`string` شناسه سفارش مرتبط با تبدیل. شناسه سفارش فقط برای یک تبدیل در هر اقدام تبدیل قابل استفاده است.

ExternalAttributionData

حاوی اطلاعات اضافی درباره تبدیل‌های نسبت داده شده خارجی است.

نمایندگی JSON
{ "externalAttributionCredit": number, "externalAttributionModel": string }

زمینه های

زمینه های
`externalAttributionCredit`	`number` نشان دهنده کسری از تبدیلی است که به کلیک Google Ads نسبت داده می شود.
`externalAttributionModel`	`string` نام مدل انتساب را مشخص می کند.

externalAttributionCredit

number

نشان دهنده کسری از تبدیلی است که به کلیک Google Ads نسبت داده می شود.

externalAttributionModel

string

نام مدل انتساب را مشخص می کند.

CartData

حاوی اطلاعات اضافی درباره اطلاعات سبد خرید است.

نمایندگی JSON
{ "merchantId": string, "feedCountryCode": string, "feedLanguageCode": string, "localTransactionCost": number, "items": [ { object (`Item`) } ] }

زمینه های
`merchantId`	`string ( int64 format)` شناسه Merchant Center که در آن موارد آپلود می شوند.
`feedCountryCode`	`string` کد کشور مرتبط با فید که در آن موارد آپلود می شوند.
`feedLanguageCode`	`string` کد زبان مرتبط با فید که در آن موارد آپلود می شوند.
`localTransactionCost`	`number` مجموع تمام تخفیف های سطح تراکنش، مانند ارسال رایگان و تخفیف کوپن برای کل سبد خرید. کد ارز همان است که در پیام ClickConversion وجود دارد.
`items[]`	`object ( Item )` داده های اقلام خریداری شده

مورد

حاوی اطلاعات اقلام خریداری شده است.

نمایندگی JSON
{ "productId": string, "quantity": integer, "unitPrice": number }

زمینه های

زمینه های
`productId`	`string` شناسه خرید کالا باید با شناسه محصول Merchant Center برابر باشد.
`quantity`	`integer` تعداد اقلام فروخته شده
`unitPrice`	`number` قیمت واحد بدون احتساب مالیات، حمل و نقل، و هر گونه تخفیف در سطح تراکنش. کد ارز همان است که در پیام ClickConversion وجود دارد.

productId

string

شناسه خرید کالا باید با شناسه محصول Merchant Center برابر باشد.

quantity

integer

تعداد اقلام فروخته شده

unitPrice

number

قیمت واحد بدون احتساب مالیات، حمل و نقل، و هر گونه تخفیف در سطح تراکنش. کد ارز همان است که در پیام ClickConversion وجود دارد.

ConversionEnvironment

محیط تبدیل تبدیل آپلود شده.

Enums
`UNSPECIFIED`	مشخص نشده است.
`UNKNOWN`	فقط برای مقدار برگشتی استفاده می شود. نشان دهنده مقدار ناشناخته در این نسخه است.
`APP`	تبدیل در یک برنامه ثبت شد.
`WEB`	تبدیل در یک وب سایت ثبت شد.

ClickConversionResult

شناسایی اطلاعات برای یک ClickConversion که با موفقیت پردازش شده است.

نمایندگی JSON
{ "gbraid": string, "wbraid": string, "userIdentifiers": [ { object (`UserIdentifier`) } ], "gclid": string, "conversionAction": string, "conversionDateTime": string }

زمینه های
`gbraid`	`string` شناسه کلیک برای کلیک‌های مرتبط با تبدیل برنامه‌ها و از دستگاه‌های iOS که با iOS14 شروع می‌شوند.
`wbraid`	`string` شناسه کلیک برای کلیک‌های مرتبط با تبدیل‌های وب و از دستگاه‌های iOS که با iOS14 شروع می‌شوند.
`userIdentifiers[]`	`object ( UserIdentifier )` شناسه های کاربر مرتبط با این تبدیل. فقط hashedEmail و hashedPhoneNumber برای آپلودهای تبدیل پشتیبانی می‌شوند. حداکثر تعداد شناسه های کاربر برای هر تبدیل 5 عدد است.
`gclid`	`string` شناسه کلیک Google (gclid) مرتبط با این تبدیل.
`conversionAction`	`string` نام منبع عمل تبدیل مرتبط با این تبدیل.
`conversionDateTime`	`string` تاریخی که در آن تبدیل صورت گرفته است. قالب "yyyy-mm-dd hh:mm:ss+\|-hh:mm" است، برای مثال، "01-01-2019 12:32:45-08:00".