از نگاشتهای موجود در جدولها برای نگاشت کردن روشها و فیلدهای Google Ads API به
معادل IngestEventsRequest آنها در Data Manager API استفاده کنید.
اصالتسنجی
Data Manager API به اعتبارنامههایی با دامنه متفاوت از Google Ads API نیاز دارد. مراحل موجود در راهاندازی دسترسی به API را دنبال کنید تا اعتبارنامه جدیدی تولید کنید که شامل دامنه Data Manager API باشد.
روشهای میانای برنامهسازی کاربردی
با Data Manager API میتوانید هر دسته از رویدادهای فروش فروشگاه را در یک
IngestEventsRequest بارگذاری کنید.
درمقابل، Google Ads API به فرایندی سهمرحلهای بااستفاده از
OfflineUserDataJobService نیاز دارد:
- ایجاد شغل بااستفاده از
CreateOfflineUserDataJob - افزودن عملیات به کار بااستفاده از
AddOfflineUserDataJobOperations - اجرای کار بااستفاده از
RunOfflineUserDataJob
فیلدهای درخواست
هر IngestEventsRequest مشمول
محدودیتهای درخواست است. اگر تعداد عملیات در درخواست AddOfflineUserDataJobOperations شما از این حدود فراتر رود، باید آن را به چند درخواست جذب Data Manager API تقسیم کنید.
در اینجا نحوه نگاشت فیلدهای درخواستهای Google Ads API به Data Manager API آورده شده است.
CreateOfflineUserDataJobRequest
جدول زیر نشان میدهد که چگونه فیلدهای یک CreateOfflineUserDataJobRequest
به یک IngestEventsRequest نگاشت میشوند.
CreateOfflineUserDataJobRequest (Google Ads API) |
IngestEventsRequest (Data Manager API) |
یادداشتها |
|---|---|---|
customer_id |
destinations.operating_account |
فیلدهای کنش تبدیل و مشتری را ببینید. |
|
destinations |
فیلدهای کنش تبدیل و مشتری را ببینید. |
|
عیبیابی | از request_id برگرداندهشده در IngestEventsResponse برای بازیابی عیبیابی درباره بارگذاری تبدیل خود استفاده کنید. |
job.id |
request_id |
از request_id برگرداندهشده در IngestEventsResponse برای بازیابی عیبیابی درباره بارگذاری تبدیل خود استفاده کنید. |
job.external_id |
بدون معادل | |
job.type |
بدون معادل | |
job.store_sales_metadata.third_party_metadata.partner_id |
destinations.login_account |
شریک دادهای که تبدیلهای فروش فروشگاهی را بارگذاری میکند با login_account مقصد شناسایی میشود. برای جزئیات بیشتر، به پیکربندی مقصدها مراجعه کنید. |
job.store_sales_metadata.third_party_metadata.advertiser_upload_date_time |
بدون معادل | |
job.store_sales_metadata.third_party_metadata.valid_transaction_fraction |
بدون معادل | |
job.store_sales_metadata.third_party_metadata.partner_match_fraction |
بدون معادل | |
job.store_sales_metadata.third_party_metadata.partner_upload_fraction |
بدون معادل | |
job.store_sales_metadata.third_party_metadata.bridge_map_version_id |
بدون معادل | |
job.store_sales_metadata.loyalty_fraction |
بدون معادل | |
job.store_sales_metadata.transaction_upload_fraction |
بدون معادل | |
job.store_sales_metadata.custom_key |
|
به فیلد variable از CustomVariable در سطح رویداد یا ItemCustomVariable در سطح مورد نگاشت میشود. |
enable_match_rate_range_preview |
بدون معادل | |
validate_only |
validate_only |
|
| بدون معادل | consent |
Google Ads API فقط از مشخص کردن consent در سطح رویداد در UserData پشتیبانی میکند. برای Data Manager API، میتوانید با تنظیم فیلد consent در IngestEventsRequest، رضایت را برای همه رویدادها در یک درخواست مشخص کنید. میتوانید این مقدار را برای رویدادی تکی با تنظیم فیلد consent از Event لغو کنید. |
| بدون معادل | encoding |
برای بارگذاری UserData الزامی است. روی Encoding استفادهشده برای مقادیر UserIdentifier تنظیم کنید. |
| بدون معادل | encryption_info |
اگر درخواست حاوی شناسههای کاربر UserData رمزگذاریشده باشد، تنظیم میشود. برای جزئیات، رمزگذاری را ببینید. |
AddOfflineUserDataJobOperationsRequest
جدول زیر نشان میدهد که چگونه فیلدهای یک AddOfflineUserDataJobOperationsRequest
به یک IngestEventsRequest نگاشت میشوند.
AddOfflineUserDataJobOperationsRequest (Google Ads API) |
IngestEventsRequest (Data Manager API) |
یادداشتها |
|---|---|---|
|
destinations |
فیلدهای کنش تبدیل و مشتری را ببینید. |
resource_name |
بدون معادل | Data Manager API نیازی به بهروزرسانی منبع کار ندارد. |
enable_partial_failure |
بدون معادل | اگر IngestEventsRequest موفقیتآمیز باشد، هرگونه خطایی که درطول پردازش پاییندست رخ دهد در سطح رویداد رسیدگی میشود که میتواند منجر به موفقیت جزئی شود. از تشخیص خرابی برای بازیابی وضعیت بارگذاری و همچنین خطاها و هشدارهای مربوط به رویدادهای جداگانه استفاده کنید. اگر IngestEventsRequest ناموفق باشد (برای مثال، بهدلیل BadRequest)، هیچ رویدادی پردازش نمیشود و باید خطا را برطرف کنید و درخواست را دوباره امتحان کنید. برای اطلاعات بیشتر، به درک خطاهای API مراجعه کنید. |
enable_warnings |
بدون معادل | از تشخیص خرابی برای بازیابی هشدارهای مربوط به درخواست Data Manager API استفاده کنید. لازم نیست این را فعال کنید. |
operations |
events |
عملیات OfflineUserDataJobOperation.create معادل ارسال IngestEventsRequest است. Data Manager API از برداشتن رویدادها پشتیبانی نمیکند. |
validate_only |
validate_only |
|
| بدون معادل | consent |
Google Ads API فقط از مشخص کردن consent در سطح رویداد در UserData پشتیبانی میکند. برای Data Manager API، میتوانید با تنظیم کردن فیلد consent در IngestEventsRequest، رضایت را برای همه رویدادها در یک درخواست مشخص کنید. میتوانید این مقدار را برای رویدادی تکی با تنظیم فیلد consent از Event لغو کنید. |
| بدون معادل | encoding |
برای بارگذاری UserData الزامی است. روی Encoding استفادهشده برای مقادیر UserIdentifier تنظیم کنید. |
| بدون معادل | encryption_info |
اگر درخواست حاوی شناسههای کاربر UserData رمزگذاریشده باشد، تنظیم میشود. برای جزئیات، رمزگذاری را ببینید. |
فیلدهای مشتری و کنش تبدیل
Google Ads API به سرایند درخواست developer-token نیاز دارد و شما سرایندهای درخواست
login-customer-id و linked-customer-id
را برای سناریوهای اصالتسنجی مختلف تنظیم میکنید.
Data Manager API به یک کد توسعهدهنده نیاز ندارد و شما اطلاعات ورود به سیستم و مشتری پیوندشده را بااستفاده از فیلدهای یک Destination بهجای سرایندهای درخواست مشخص میکنید. برای اطلاعات بیشتر درباره مقصدها، پیکربندی مقصدها را بررسی کنید.
| Google Ads API | Destination (Data Manager API) |
یادداشتها |
|---|---|---|
customer_id درخواست |
operating_account |
account_id را روی شناسه مشتری حساب تبدیل Google Ads تنظیم کنید. account_type operating_account را روی GOOGLE_ADS تنظیم کنید. |
سرایند درخواست developer-token |
بدون معادل | برای Data Manager API به کد توسعهدهنده نیازی نیست. |
سرایند درخواست login-customer-id |
login_account |
account_id را روی شناسه مشتری حساب ورود به سیستم تنظیم کنید. اگر حساب ورود به سیستم حساب Google Ads است، account_type را روی GOOGLE_ADS تنظیم کنید، یا اگر حساب ورود به سیستم حساب شریک داده است، آن را روی DATA_PARTNER تنظیم کنید. |
سرایند درخواست linked-customer-id |
linked_account |
اگر بااستفاده از پیوند شریک به operating_account دسترسی پیدا میکنید، account_id را روی شناسه مشتری حساب پیوندشده تنظیم کنید و account_type را روی DATA_PARTNER تنظیم کنید. درغیراینصورت، فیلد linked_account را تنظیم نکنید. |
conversion_action |
product_destination_id |
روی شناسه عددی کنش تبدیل تنظیم شده است. از نام منبع استفاده نکنید. |
فیلدهای رویداد
جدول زیر نشان میدهد که فیلدهای تبدیل فروش فروشگاهی چگونه بین دو میانای برنامهسازی کاربردی نگاشت میشوند.
برخلاف Google Ads API که فقط از گنجاندن یک مورد در هر تراکنش بااستفاده از ItemAttribute پشتیبانی میکند، Data Manager API از گنجاندن چند مورد در هر رویداد در CartData پشتیبانی میکند.
OfflineUserDataJobOperation.create (Google Ads API) |
Event (Data Manager API) |
یادداشتها |
|---|---|---|
| بدون معادل | event_source |
الزامی برای تبدیلهای فروش فروشگاهی روی IN_STORE تنظیم کنید. |
transaction_attribute.conversion_action |
destinations.product_destination_id |
فیلدهای کنش تبدیل و مشتری را ببینید. بهجای نام منبع، از شناسه عددی کنش تبدیل استفاده کنید. |
transaction_attribute.transaction_date_time |
event_timestamp |
برای جزئیات، قالب مُهر زمان را ببینید. |
transaction_attribute.transaction_amount_micros |
|
روی مقدار واحد پولی تنظیم شود، نه مقدار به میکرو. برای مثال، برای مقدار تبدیل ۵٫۲۳ دلار، از مقدار 5.23 استفاده کنید. |
transaction_attribute.currency_code |
currency |
الزامی. |
transaction_attribute.order_id |
transaction_id |
الزامی. |
transaction_attribute.store_attribute.store_code |
event_location.store_id |
الزامی کد فروشگاه را در فیلد store_id در شیء EventLocation تنظیم کنید. |
transaction_attribute.custom_value |
|
به فیلد value از CustomVariable در سطح رویداد یا ItemCustomVariable در سطح مورد نگاشت میشود. |
transaction_attribute.item_attribute.item_id |
cart_data.items[].merchant_product_id |
|
transaction_attribute.item_attribute.merchant_id |
|
اگر cart_data.merchant_id را تنظیم کنید، بهعنوان پیشفرض برای همه موارد عمل میکند، اما میتوانید آن را برای موارد تکی لغو کنید. |
transaction_attribute.item_attribute.country_code |
|
اگر cart_data.merchant_feed_label را تنظیم کنید، بهعنوان پیشفرض برای همه موارد عمل میکند، اما میتوانید آن را برای موارد تکی لغو کنید. |
transaction_attribute.item_attribute.language_code |
|
اگر cart_data.merchant_feed_language_code را تنظیم کنید، بهعنوان پیشفرض برای همه موارد عمل میکند، اما میتوانید آن را برای موارد تکی لغو کنید. |
transaction_attribute.item_attribute.quantity |
cart_data.items[].quantity |
|
| بدون معادل | cart_data.items[].unit_price |
روی قیمت واحد بدون احتساب مالیات، ارسال، و تخفیفهای رویدادمحور (سطح تراکنش) برای این مورد تنظیم شده است. |
user_identifiers |
|
الزامی.
|
consent |
consent |
هر دو میانای برنامهسازی کاربردی از شیء Consent مشابهی (ad_user_data، ad_personalization) استفاده میکنند. برای Data Manager API، میتوانید با تنظیم فیلد consent در IngestEventsRequest، برای همه رویدادها در یک درخواست رضایت تنظیم کنید. |
فیلدهای شناسه کاربر
UserIdentifier (Google Ads API) |
UserIdentifier (Data Manager API) |
یادداشتها |
|---|---|---|
user_identifier_source |
منبع تعیین میکند کدام فیلد در Data Manager API
|
|
hashed_email |
email_address |
روی نشانی ایمیل قالببندیشده و درهمسازیشده تنظیم شود. همچنین میتوانید نشانی ایمیل درهمسازیشده را رمزگذاری کنید. |
hashed_phone_number |
phone_number |
روی شماره تلفن قالببندیشده و درهمسازیشده تنظیم شده است. همچنین میتوانید شماره تلفن درهمسازیشده را رمزگذاری کنید. |
address_info |
address |
روی شیء AddressInfo تنظیم شده است. دستورالعملهای قالببندی و درهمسازی را دنبال کنید. همچنین میتوانید مشخصههای درهمسازیشده نشانی را رمزگذاری کنید. |
address_info.hashed_first_name |
address.given_name |
|
address_info.hashed_last_name |
address.family_name |
|
address_info.country_code |
address.region_code |
|
address_info.postal_code |
address.postal_code |
|
address_info.city |
بدون معادل | برای مقصدهای Google Ads پشتیبانی نمیشود. |
address_info.state |
بدون معادل | برای مقصدهای Google Ads پشتیبانی نمیشود. |
address_info.hashed_street_address |
بدون معادل | برای مقصدهای Google Ads پشتیبانی نمیشود. |