Display & Video 360 API v2 غروب است. به جای آن از Display & Video 360 API v3 استفاده کنید. برای دستورالعمل‌های انتقال نسخه 2 به نسخه 3، راهنمای مهاجرت ما را ببینید.

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

از v1 به v2 مهاجرت کنید

آخرین به روز رسانی: 2022-12-06

درخواست خود را مهاجرت کنید

انتقال از نسخه 1 به نسخه 2 نیاز به به روز رسانی URL های نقطه پایانی خود برای فراخوانی نسخه 2 و به روز رسانی برنامه خود برای حسابرسی برای تغییرات شکسته دارد.

تماس های API خود را از v1 به v2 به روز کنید

برای استفاده از v2 به جای v1، باید درخواست های خود را برای استفاده از نقاط پایانی جدید v2 به روز کنید.

به عنوان مثال، برای فراخوانی متد advertisers.get با v1، از URL زیر استفاده کنید:

GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId

برای نسخه 2، URL را به موارد زیر به روز کنید:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

اگر از کتابخانه سرویس گیرنده برای درخواست به API استفاده می کنید، از جدیدترین نسخه کتابخانه مشتری استفاده کنید و پیکربندی خود را برای استفاده از v2 به روز کنید.

تغییرات لازم را انجام دهید

ما در حال معرفی تعدادی از تغییرات شکسته در نسخه 2 هستیم. دستورالعمل‌های زیر را مرور کنید و تغییرات مورد نیاز مربوط به استفاده فعلی خود از Display & Video 360 API را انجام دهید.

تماس ها را به روش های هدف گذاری به روز کنید

برخی از انواع هدف اکنون با استفاده از مقادیر enum به جای هدف‌گیری شناسه‌های گزینه اختصاص داده می‌شوند. برای مثال، دستگاه‌های رایانه لوحی اکنون مستقیماً با فهرست DEVICE_TYPE_TABLET DeviceType مورد هدف قرار می‌گیرند، نه شناسه گزینه هدف از سرویس targetingTypes.targetingOptions . نسخه‌های رشته‌ای از این فهرست‌ها در فیلد جدید assignedTargetingOptionIdAlias در این منابع AssignedTargetingOption نمایش داده می‌شوند و می‌توانند هنگام بازیابی یا حذف هدف‌یابی موجود استفاده شوند. مقدار assignedTargetingOptionId این منابع AssignedTargetingOption تغییر نکرده است.
برای استفاده از مقادیر enum، تماس‌هایی را که انواع هدف‌یابی زیر را مدیریت می‌کنند، به‌روزرسانی کنید:
روش advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions با روش advertisers.lineItems.bulkEditAssignedTargetingOptions جایگزین شده است.
روش advertisers.lineItems.bulkListLineItemAssignedTargetingOptions با روش advertisers.lineItems.bulkListAssignedTargetingOptions جایگزین شده است.
به‌روزرسانی تماس‌های مدیریت TARGETING_TYPE_PROXIMITY_LOCATION_LIST برای استفاده از اندازه شعاع و واحد فاصله تنظیم‌شده به‌جای مقدار enum ProximityRadiusRange .
روش‌های هدف‌یابی که گزینه‌های هدف‌یابی را در چندین نوع هدف تحت یک منبع والد بازیابی یا ویرایش می‌کنند، تغییر نام داده‌اند.
برای استفاده از نام‌های جدید تماس‌ها را به روش‌های زیر به‌روزرسانی کنید:

تماس‌ها را با سرویس `advertisers.lineItems` به‌روزرسانی کنید

inventorySourceIds فیلد حذف شده است. با استفاده از منابع AssignedTargetingOption TARGETING_TYPE_INVENTORY_SOURCE ، تخصیص منبع موجودی را مدیریت کنید.
مقادیر enum LineItemWarningMessage زیر در نسخه 2 منسوخ شده است و دیگر در LineItem.warningMessages نمایش داده نخواهد شد:
- NO_POSITIVE_AUDIENCE_LIST_TARGETED
- APP_INSTALL_NO_CONVERSION_PIXEL
- TARGETING_REVOKED_OR_CLOSED_USER_LIST
- APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
- CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
- NO_CREATIVE_FOR_TARGETED_DEALS
- TARGETING_DEPRECATED_GEO_TARGET
فیلد triggerId از شی LineItemFlight و مقدار LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER از نوع enum LineItemFlightDateType حذف شده است. v2 از تنظیم موارد خط برای خرج کردن بر اساس فعال‌سازی راه‌اندازهای دستی پشتیبانی نمی‌کند.

تماس ها را به سرویس `customBiddingAlgorithms` به روز کنید

فیلدهای customBiddingAlgorithmState و modelReadiness با فیلد modelDetails جایگزین شده‌اند که حالت‌های آمادگی و تعلیق مدل الگوریتم موجود را برای هر تبلیغ‌کننده‌ای که از طریق فهرستی از اشیاء CustomBiddingModelDetails دسترسی دارد، ارائه می‌کند.

تغییرات اضافی

علاوه بر تغییرات اساسی ذکر شده در بالا، v2 همچنین ویژگی های جدیدی را معرفی می کند.

ویژگی های اضافه شده به نسخه 2 پس از راه اندازی اولیه را می توان در یادداشت های انتشار ما یافت.

دسترسی فقط خواندنی به موارد خط YouTube

در نسخه 2، موارد خط YouTube و تنظیمات هدفمندی آنها را می توان به ترتیب با استفاده از سرویس های advertisers.lineItems و advertisers.lineItems.targetingTypes.assignedTargetingOptions بازیابی کرد. API دسترسی فقط خواندنی را فراهم می‌کند، به این معنی که هر درخواست نوشتنی که برای این آیتم‌های خط انجام شود، یک خطا برمی‌گرداند. موارد خط YouTube دارای یکی از مقادیر LineItemType زیر خواهند بود:

روش‌های جدید عملکرد بهتری را ممکن می‌سازد

در نسخه 2، سرویس advertisers.lineItems روش های جدیدی را برای استفاده به جای درخواست های دسته ای برای عملکرد بهتر و کاهش مصرف سهمیه ارائه می دهد:

می‌توانید از advertisers.lineItems.bulkUpdate برای تنظیم مقادیر فیلد یکسان برای چندین مورد استفاده کنید. در حال حاضر فقط به‌روزرسانی‌های فیلد entityStatus پشتیبانی می‌شوند.
می‌توانید از advertisers.lineItems.bulkEditAssignedTargetingOptions برای افزودن یا حذف گزینه‌های هدف اختصاص داده شده در چندین مورد استفاده کنید.
می‌توانید از advertisers.lineItems.bulkListAssignedTargetingOptions برای فهرست کردن گزینه‌های هدف اختصاص داده شده در چندین مورد استفاده کنید.
می‌توانید از advertisers.lineItems.duplicate برای ایجاد یک نسخه تکراری از یک مورد خط موجود در همان ترتیب درج، کپی کردن روی همه تنظیمات و تنظیمات هدف استفاده کنید.

دسترسی به نوشتن جزئی برای هدف قرار دادن سفارش درج

در نسخه 2، می‌توانید تنظیمات هدف‌گیری زیرمجموعه‌ای را برای منابع InsertionOrder با استفاده از روش‌های جدید create و delete در سرویس advertisers.insertionOrders.targetingTypes.assignedTargetingOptions ویرایش کنید. انواع هدف گذاری زیر را می توان به طور کامل در سطح سفارش درج مدیریت کرد:

TARGETING_TYPE_AGE_RANGE
TARGETING_TYPE_BROWSER
TARGETING_TYPE_CATEGORY
TARGETING_TYPE_CHANNEL
TARGETING_TYPE_DEVICE_MAKE_MODEL
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
TARGETING_TYPE_ENVIRONMENT
TARGETING_TYPE_GENDER
TARGETING_TYPE_KEYWORD
TARGETING_TYPE_LANGUAGE
TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
TARGETING_TYPE_OPERATING_SYSTEM
TARGETING_TYPE_PARENTAL_STATUS
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
TARGETING_TYPE_VIEWABILITY