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

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

مهاجرت از Entity Read Files

فایل‌های خوانده شده موجودیت (ERF) نمایش‌های JSON از اشیاء کمپین شریک هستند که بنا به درخواست، روزانه تولید می‌شوند و از طریق Google Cloud Storage در دسترس قرار می‌گیرند.

ERF ها در ژوئن 2021 منسوخ شدند . از 31 اکتبر 2024، ERF ها رسما غروب می شوند و دیگر تولید نمی شوند. همه کاربران موجود Entity Read File تشویق می‌شوند تا به API Display & Video 360 مهاجرت کنند تا به بازیابی منابع Display & Video 360 ادامه دهند.

این راهنما نحوه مهاجرت از Entity Read Files به Display & Video 360 API را توسط:

ارائه یک نمای کلی از تفاوت های بین این دو رابط
مقایسه جداول ERF با خدمات API
ارائه راهنمایی در مورد بازیابی موجودیت از طریق API
اعتراف به شکاف های موجود در داده ها
ارائه نگاشت تمام فیلدهای ERF به فیلدهای منابع API قابل مقایسه

نمای کلی

هنگام انتقال از ERF به API Display & Video 360، تعدادی تفاوت کلیدی وجود دارد که باید در نظر گرفته شود، از جمله:

تازگی داده ها ERF ها روزانه و به صورت انبوه تولید می شوند در حالی که API به روزترین نسخه یک منبع را بازیابی می کند.
ساختار منابع API از ساختارهای JSON متفاوتی نسبت به ERF برای نمایش انواع منابع مشابه استفاده می کند. برخی از منابع، مانند تنظیمات هدف گذاری عمومی، ممکن است از فضای شناسایی متفاوتی استفاده کنند.
روش بازیابی. API Display & Video 360 برخلاف فایل‌های JSON خام ارائه شده توسط ERF، فقط بازیابی منابع را به صورت جداگانه، در فهرست‌های صفحه‌بندی شده یا از طریق انتقال داده‌های BigQuery امکان‌پذیر می‌کند.
دامنه. برخلاف ERF ها که با شناسه شریک محدوده بندی می شوند، بیشتر منابع API با شناسه تبلیغ کننده محدوده می شوند. منابع موجود در پاسخ ها به منابعی در آن محدوده محدود می شود.

نمایش داده های ERF در API

فایل های خوانده شده موجودیت به جداول "عمومی" و "خصوصی" جدا می شوند. جداول عمومی اطلاعاتی را ارائه می دهند که برای همه کاربران در دسترس و قابل اجرا است، مانند مقادیر هدف. جداول خصوصی داده‌هایی را ارائه می‌کنند که مختص یک شریک است، مانند منابع خلاقیت یا آیتم‌های خطی.

API Display & Video 360 از این دوگانگی استفاده نمی کند، در عوض همه این اطلاعات را از طریق سرویس های مختلف و با استفاده از ساختارهای مختلف JSON قابل بازیابی می کند. این بخش اطلاعات ارائه شده از طریق جداول ERF عمومی و خصوصی را با اطلاعاتی که از طریق منابع و خدمات Display & Video 360 API در دسترس است مقایسه می کند.

اطلاعات عمومی

جداول عمومی ERF مواد مرجعی را برای کاربران فراهم می‌کند تا هنگام تفسیر تنظیمات هدف‌گیری منابع خصوصی بازیابی‌شده و اختصاص هدف‌یابی از طریق زیرمجموعه‌ای از نسخه‌های فایل‌های داده ساختاریافته (SDF) که از طریق UI آپلود شده‌اند، استفاده کنند. این مواد مرجع برای همه کاربران یکسان است و شامل یک شناسه عددی است که برای نقشه‌برداری استفاده می‌شود و جزئیات توصیفی بیشتری مانند نام نمایشی.

هنگام استفاده از Display & Video 360 API، اطلاعات مرجع هدف را می توان از طریق سرویس targetingTypes.targetingOptions بازیابی کرد. مشابه جداول عمومی، این سرویس شناسه ها و جزئیات گزینه های هدف گیری را برای یک نوع هدف گذاری خاص ارائه می دهد. برای نمونه کدی که بازیابی شناسه گزینه هدف را نشان می دهد، به صفحه تعیین هدف موجود ما مراجعه کنید.

جداول عمومی و SDF

قبل از SDF v7 ، Entity Read Files و Structured Data Files از همان فضای ID برای تنظیمات هدف استفاده می کنند. اگر کاربر SDF هستید که از جداول عمومی ERF برای تفسیر یا تخصیص تنظیمات هدف با استفاده از SDF استفاده می‌کنید، در عوض می‌توانید این ماده مرجع را در قالب CSV از طریق Display & Video 360 UI دانلود کنید.

با شروع نسخه ۷ ، فضاهای شناسه استفاده شده توسط زیرمجموعه‌ای از ستون‌های فایل‌های داده ساختاریافته به‌روزرسانی شده‌اند تا SDF را از ERF جدا کرده و بیشتر با Display & Video 360 API هماهنگ شوند. برای اطلاعات بیشتر به راهنمای مهاجرت v7 و مستندات مرجع مراجعه کنید.

منابع خصوصی

جداول خصوصی ERF تصویری روزانه از تنظیمات فعلی منابع خصوصی متعلق به یک شریک را ارائه می دهد. با توجه به حجم عظیم منابعی که می‌توان تحت یک شریک ایجاد کرد، این فایل‌ها می‌توانند بسیار بزرگ و دانلود و پردازش آن‌ها دشوار باشد.

در API، هر جدول خصوصی دارای یک سرویس مربوطه است که نقاط پایانی را برای بازیابی و مدیریت آن نوع منبع فراهم می کند. منابع را می توان به صورت انبوه با استفاده از روش فهرست مربوطه هر سرویس بازیابی کرد. ساختار JSON برای هر منبع در API در مقایسه با ERF متفاوت است و از نام فیلدهای مختلف و منابع مشترک استفاده می کند.

برخی از اطلاعات موجود در نمایش ERF یک منبع، مانند تنظیمات هدف اختصاص داده شده یک منبع یا سایت های یک کانال، در API به عنوان فرزندان منبع اصلی نشان داده می شوند و باید از طریق درخواست های API اضافی بازیابی شوند.

بازیابی موجودیت در API

منابع Display & Video 360 را می توان از طریق درخواست های مستقیم API یا وارد کردن خودکار به BigQuery بازیابی کرد.

درخواست های مستقیم API

هر نوع منبع از طریق یک سرویس API متفاوت قابل بازیابی است. منابع را می توان به صورت تکی یا انبوه با استفاده از روش دریافت یا فهرست سرویس مناسب بازیابی کرد. ویژگی های مهم روش های فهرست API Display & Video 360 عبارتند از:

محدوده مورد نیاز برخلاف ERF ها که توسط شریک محدوده بندی می شوند، بیشتر منابع در API توسط تبلیغ کننده تعیین می شوند. بازیابی همه نوع منبع، مانند موارد خط، تحت شریک ممکن است به درخواست فهرست فردی برای هر تبلیغ‌کننده فرزند آن شریک نیاز داشته باشد. استثناها شامل فرزندان مستقیم یک شریک، مانند تبلیغ‌کنندگان و کانال‌های متعلق به شریک هستند.
صفحه بندی. روش‌های فهرست API از صفحه‌بندی استفاده می‌کنند تا تضمین کنند که پاسخ‌ها در اندازه معقول هستند و اکثر پاسخ‌های درخواستی یا صفحات را به 100 منبع محدود می‌کنند. اگر تعداد منابع مربوطه بزرگتر از اندازه صفحه باشد، برای بازیابی صفحات بعدی پاسخ لیست کامل، به فراخوانی های لیستی متوالی نیاز است. یک نمونه کد برای صفحه‌بندی پاسخ لیست در بخشی از صفحه راهنمای هدفمندی ما در رابطه با بازیابی گزینه‌های هدف‌یابی موجود ارائه شده است.
درخواست‌های اضافی برای بازیابی هدفمند مورد نیاز است. تنظیمات هدف یک منبع در شیء API JSON آن گنجانده نشده است، اما در عوض منابع فرزندی هستند که به عنوان گزینه های هدف گذاری اختصاص یافته شناخته می شوند. این منابع کودک باید از طریق یک درخواست جداگانه بازیابی شوند. به عنوان مثال، برای هر آیتم خطی که از طریق یک درخواست advertisers.lineItems.list بازیابی می‌شود، یک درخواست جداگانه advertisers.lineItems.bulkListAssignedTargetingOptions باید برای بازیابی همه اطلاعات هدف ارائه شود.

بهینه سازی بازیابی منابع

Display & Video 360 API ممکن است برای بازیابی همان مقدار اطلاعات موجود در یک Entity Read File به چندین درخواست نیاز داشته باشد. بهینه‌سازی نحوه بازیابی منابع می‌تواند به بازیابی داده‌های مورد نیاز با کارآمدتر کمک کند:

درخواست های همزمان به API انجام دهید. Display & Video 360 API با استفاده از درخواست‌های هر تبلیغ‌کننده در هر محدودیت نرخ پروژه از زیرساخت محافظت می‌کند. این ساختار سهمیه ای به شما امکان می دهد یک راه حل چند رشته ای را در بین چندین تبلیغ کننده پیاده سازی کنید که کل زمان لازم برای بازیابی همه منابع لازم را کاهش می دهد. اگرچه صفحه بندی مستلزم آن است که همه منابع از یک نوع در محدوده خاصی از طریق فراخوانی های متوالی بازیابی شوند، بازیابی منابع در محدوده دیگری یا از نوع دیگری می تواند همزمان انجام شود.
از فیلترها استفاده کنید و بر اساس پارامترها در تماس های فهرستی خود ترتیب دهید تا فقط منابع مرتبط را بازیابی کنید. به عنوان مثال، اگر فقط به موارد خطی علاقه مند هستید که در روز گذشته به روز شده اند، می توانید از پارامتر filter متد advertisers.lineItems.list استفاده کنید تا فقط موارد خط را با updateTime بزرگتر از یک مهر زمانی معین برگردانید. این می تواند به میزان قابل توجهی تعداد درخواست هایی را که باید انجام شود کاهش می دهد.
برای جلوگیری از درخواست‌های غیرضروری API ، معمولاً شناسه‌های مورد استفاده را در حافظه پنهان ذخیره کنید . برخی از اطلاعات مرجع، مانند شناسه‌های گزینه‌های هدف و شناسه‌های مخاطب Google، نسبتاً پایدار هستند و می‌توانند با خیال راحت ذخیره شوند تا نیازی به بازیابی در هر بار استفاده نباشد. با این حال، مقادیر ذخیره شده در حافظه پنهان باید به صورت هفتگی بررسی شوند تا تغییرات یا کاهش‌های نادر را در نظر بگیرند.

برای اطلاعات بیشتر در مورد نحوه دسترسی موثر به Display & Video 360 API راهنمای بهینه سازی سهمیه ما را ببینید.

وارد کردن به BigQuery

رابط BigQuery API Display & Video 360 به شما این امکان را می‌دهد تا پیکربندی‌های منبع Display & Video 360 را به طور خودکار به صورت روزانه به طور مستقیم به BigQuery وارد کنید. پیکربندی ها با استفاده از طراحی منبع Display & Video 360 API در BigQuery ذخیره می شوند. زیر مجموعه ای از منابع API پشتیبانی می شوند.

برای اطلاعات بیشتر در مورد استفاده از رابط BigQuery API Display & Video 360 به مستندات ابری زیر مراجعه کنید:

شکاف های داده API شناخته شده

هنگام مهاجرت از ERF به Display & Video 360 API ممکن است با شکاف های داده قابل توجهی مواجه شوید، مانند:

دستورات درج داستان سفارش‌های درج داستان از طریق API قابل بازیابی نیستند و باید از طریق رابط کاربری Display & Video 360 بازیابی شوند.
زیر مجموعه ای از زمینه های منبع تعداد کمی از فیلدهای منبع موجود در اشیاء ERF در منابع مربوطه بازیابی شده از طریق Display & Video 360 API موجود نیستند.

پیوست: نگاشت فیلدهای ERF به API

نقشه برداری جدول عمومی

جداول زیر فیلدهای جداول عمومی ERF را به انواع هدف‌گیری موجود و فیلدهای گزینه هدف در Display & Video 360 API ترسیم می‌کنند. اگرچه مقدار یک فیلد ممکن است به فیلد دیگر منطبق شود، اما این تضمین نمی کند که آنها از همان نوع داده، مقادیر enum یا فضای ID استفاده می کنند.

مجموعه برنامه

قابل بازیابی تحت نوع هدف گیری TARGETING_TYPE_APP_CATEGORY .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `TargetingOption.targetingOptionId` .
نام	قسمت `TargetingOption.appCategoryDetails.displayName` .

مرورگر

قابل بازیابی تحت نوع هدف گیری TARGETING_TYPE_BROWSER .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `TargetingOption.targetingOptionId` .
is_mobile	در دسترس نیست.
نام	قسمت `TargetingOption.browserDetails.displayName` .

DataPartner

هیچ منبع یا فیلدی معادلی در Display & Video 360 API موجود نیست.

معیارهای دستگاه

قابل بازیابی تحت انواع هدف گیری TARGETING_TYPE_OPERATING_SYSTEM ، TARGETING_TYPE_DEVICE_MAKE_MODEL ، و TARGETING_TYPE_DEVICE_TYPE .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	قسمت `TargetingOption.targetingOptionId` یا `DeviceType` enum.
is_mobile	در دسترس نیست.
نام	فیلد `TargetingOption.operatingSystemDetails.displayName` ، فیلد `TargetingOption.deviceMakeModelDetails.displayName` ، یا `DeviceType` enum، بسته به نوع هدف.
معیار_نوع	فیلد `TargetingOption.targetingType` .
شناسه_سیستم_عامل	در دسترس نیست.
Mobile_brand_name	در دسترس نیست.
mobile_model_name	در دسترس نیست.
mobile_make_model_id	در دسترس نیست.
دستگاه_نوع	`DeviceType` enum.

موقعیت جغرافیایی

قابل بازیابی تحت نوع هدف گیری TARGETING_TYPE_GEO_REGION .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `TargetingOption.targetingOptionId` .
canonical_name	قسمت `TargetingOption.geoRegionDetails.displayName` .
geo_name	در دسترس نیست.
کشور_کد	در دسترس نیست.
منطقه_کد	در دسترس نیست.
شهر_نام	در دسترس نیست.
postal_name	در دسترس نیست.
dma_code	در دسترس نیست.

ISP

قابل بازیابی تحت نوع هدف گیری TARGETING_TYPE_CARRIER_AND_ISP .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `TargetingOption.targetingOptionId` .
is_mobile	در دسترس نیست.
نام	قسمت `TargetingOption.carrierAndIspDetails.displayName` .
شناسه_معیار_ثانویه	فیلد `TargetingOption.targetingOptionId` .

زبان

قابل بازیابی تحت نوع هدف TARGETING_TYPE_LANGUAGE .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `TargetingOption.targetingOptionId` .
نام	در دسترس نیست. نام نمایشی کامل یک زبان در قسمت `TargetingOption.languageDetails.displayName` موجود است.

SiteToPlacementId

هیچ منبع یا فیلدی معادلی در Display & Video 360 API موجود نیست.

SupportedExchange

قابل بازیابی تحت نوع هدف گیری TARGETING_TYPE_EXCHANGE .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	`Exchange` enum.
نام	`Exchange` enum.

یونیورسال سایت

هیچ منبع یا فیلدی معادلی در Display & Video 360 API موجود نیست. سایت‌ها و برنامه‌ها را می‌توان مستقیماً تحت انواع هدف‌گیری TARGETING_TYPE_URL و TARGETING_TYPE_APP هدف قرار داد. در Display & Video 360، هر برنامه یا URL را می توان هدف قرار داد، اما نمی توان هر برنامه یا URL را در آن گزارش داد. اگر می‌خواهید برنامه‌ها و نشانی‌های وب غیرقابل گزارش را از هزینه حذف کنید، دستورالعمل‌های موجود در مرکز راهنمای DV360 را دنبال کنید.

نگاشت فیلد جدول خصوصی

جداول زیر فیلدهای جداول خصوصی ERF را با فیلدها یا خدمات موجود در Display & Video 360 API ترسیم می کنند. اگرچه مقدار یک فیلد ممکن است به فیلد دیگر منطبق شود، اما این تضمین نمی کند که آنها از همان نوع داده، مقادیر enum یا فضای ID استفاده می کنند.

تبلیغ کننده

نام فیلد ERF	در دسترس بودن DV360 API
common_data.id	فیلد `Advertiser.advertiserId` .
common_data.name	قسمت `Advertiser.displayName` .
common_data.active	فیلد `Advertiser.entityStatus` .
common_data.integration_code	قسمت `Advertiser.integrationDetails.integrationCode` .
partner_id	قسمت `Advertiser.partnerId` .
ارز_کد	قسمت `Advertiser.generalConfig.currencyCode` .
منطقه زمانی_کد	فیلد `Advertiser.generalConfig.timeZone` .
landing_page_url	قسمت `Advertiser.generalConfig.domainUrl` .
در دسترس_کانال_ids	قابل بازیابی از طریق روش `advertisers.channels.list` .
blacklist_channel_id	قابل بازیابی از طریق روش `advertisers.targetingTypes.assignedtargetingOptions.list` تحت نوع هدف گیری `TARGETING_TYPE_CHANNEL` . اگر `AssignedTargetingOption.channelDetails.negative` درست باشد، کانال هدف گذاری منفی می شود.
dcm_configuration	در دسترس نیست.
dcm_network_id	فیلد `Advertiser.adServerConfig.cmHybridConfig.cmAccountId` .
dcm_advertiser_id	فیلد `Advertiser.adServerConfig.cmHybridConfig.cmAdvertiserIds` شناسه های تبلیغ کننده CM360 را فهرست می کند که با پیکربندی Floodlight CM360 مشترک هستند.
dcm_floodlight_group_id	فیلد `Advertiser.adServerConfig.cmHybridConfig.cmFloodlightConfigId` .
dcm_syncable_site_ids	فیلد `Advertiser.adServerConfig.cmHybridConfig.cmSyncableSiteIds` .
enable_oba_tags	در دسترس نیست.

کمپین

نام فیلد ERF	در دسترس بودن DV360 API
common_data.id	فیلد `Campaign.campaignId` .
common_data.name	فیلد `Campaign.displayName` .
common_data.active	فیلد `Campaign.entityStatus` .
common_data.integration_code	در دسترس نیست.
advertiser_id	فیلد `Campaign.advertiserId` .
بودجه	فیلدهای `Campaign.campaignFlight` و `Campaign.campaignBudgets` .
فرکانس_کاپ	قسمت `Campaign.frequencyCap` .
default_target_list	قابل بازیابی از طریق روش `advertisers.campaigns.bulkListCampaignAssignedTargetingOptions` .
use_video_creatives	در دسترس نیست.
use_display_creatives	در دسترس نیست.
use_audio_creatives	در دسترس نیست.
هدف	قسمت `Campaign.campaignGoal.campaignGoalType` .
متریک	قسمت `Campaign.campaignGoal.performanceGoal.performanceGoalType` .
Objective_Description	فیلد `Campaign.campaignGoal.performanceGoal.performanceGoalString` .
متریک_میزان_میکروها	فیلد `Campaign.campaignGoal.performanceGoal.performanceGoalAmountMicros` .

خلاق

نام فیلد ERF	در دسترس بودن DV360 API
common_data.id	فیلد `Creative.creativeId` .
common_data.name	فیلد `Creative.displayName` .
common_data.active	فیلد `Creative.entityStatus` .
common_data.integration_code	فیلد `Creative.integrationCode` .
advertiser_id	فیلد `Creative.advertiserId` .
dcm_placement_id	فیلد `Creative.cmPlacementId` .
عرض_پیکسل	قسمت `Creative.dimensions.widthPixels` .
ارتفاع_پیکسل	قسمت `Creative.dimensions.heightPixels` .
تایید_وضعیت	قسمت `Creative.reviewStatus` .
گسترش_جهت	فیلد `Creative.expandingDirection` .
Creative_type	فیلد `Creative.creativeType` .

CustomAffinity

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `CustomList.customListId` .
نام	فیلد `CustomList.displayName` .
توضیحات	در دسترس نیست.
advertiser_id	در دسترس نیست.

FloodlightActivity

نام فیلد ERF	در دسترس بودن DV360 API
common_data.id	قسمت `FloodlightActivity.floodlightActivityId` .
common_data.name	قسمت `FloodlightActivity.displayName` .
common_data.active	قسمت `FloodlightActivity.servingStatus` .
common_data.integration_code	در دسترس نیست.
advertiser_id	فیلد `FloodlightActivity.advertiserIds` همه تبلیغ‌کنندگانی را فهرست می‌کند که به فعالیت floodlight تحت شریک داده‌شده دسترسی دارند.
partner_id	هنگام درخواست از سرویس `floodlightGroups.floodlightActivities` توسط کاربر ارائه می شود.
remarketing_enabled	فیلد `FloodlightActivity.remarketingConfigs` این پیکربندی را برای هر تبلیغ‌کننده با دسترسی به فعالیت نورافکن تحت شریک معین فهرست می‌کند.
ssl_required	`FloodlightActivity.sslRequired` فیلد الزامی.

درج سفارش

نام فیلد ERF	در دسترس بودن DV360 API
common_data.id	فیلد `InsertionOrder.insertionOrderId` .
common_data.name	فیلد `InsertionOrder.displayName` .
common_data.active	فیلد `InsertionOrder.entityStatus` .
common_data.integration_code	فیلد `InsertionOrder.integrationDetails.integrationCode` .
advertiser_id	فیلد `InsertionOrder.advertiserId` .
Campaign_id	فیلد `InsertionOrder.campaignId` .
کلی_بودجه	در دسترس نیست. با استفاده از محتویات فیلد `InsertionOrder.budget.budgetSegments` قابل محاسبه است.
Scheded_Segments	فیلد `InsertionOrder.budget.budgetSegments` .
فرکانس_کاپ	فیلد `InsertionOrder.frequencyCap` .
پیش فرض_هزینه_شریک	قسمت `InsertionOrder.partnerCosts` .
default_target_list	قابل بازیابی از طریق روش `advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions` .

InventorySource

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `InventorySource.inventorySourceId` .
طبقه بندی نشده	در دسترس نیست.
inventory_name	فیلد `InventorySource.displayName` .
exchange_id	فیلد `InventorySource.exchange` .
accessing_advertisers	فیلدهای `InventorySource.readWriteAccessors` و `InventorySource.readAdvertiserIds` .
خارجی_id	فیلد `InventorySource.dealId` .
min_cpm_micros	فیلد `InventorySource.rateDetails.rate.nanos` ، بسته به مقدار فیلد `InventorySource.rateDetails.inventorySourceRateType` .
min_cpm_currency_code	فیلد `InventorySource.rateDetails.rate.currencyCode` .

آیتم خط

نام فیلد ERF	در دسترس بودن DV360 API
common_data.id	فیلد `LineItem.lineItemId` .
common_data.name	فیلد `LineItem.displayName` .
common_data.active	فیلد `LineItem.entityStatus` .
common_data.integration_code	فیلد `LineItem.integrationDetails.integrationCode` .
خط_نوع_آیتم	فیلد `LineItem.lineItemType` .
insertion_order_id	فیلد `LineItem.insertionOrderId` .
creative_ids	فیلد `LineItem.creativeIds` .
max_cpm_advertiser_micros	فیلدهای `LineItem.bidStrategy.maximizeSpendAutoBid.maxAverageCpmBidAmountMicros` یا `LineItem.bidStrategy.performanceGoalAutoBid.maxAverageCpmBidAmountMicros` ، بسته به طرح استراتژی مورد استفاده.
عملکرد_هدف	فیلدهای `LineItem.bidStrategy.maximizeSpendAutoBid.performanceGoalType` یا `LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalType` بسته به طرح استراتژی مورد استفاده.
target_advertiser_micro	فیلد `LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalAmountMicros` .
شریک_درآمد_مدل	فیلد `LineItem.partnerRevenueModel` .
هزینه_ردیابی_پیکسل	فیلد `LineItem.conversionCounting.floodlightActivityConfigs` .
budget.start_time_usec	فیلد `LineItem.flight.dateRange.startDate` .
budget.end_time_usec	فیلد `LineItem.flight.dateRange.endDate` .
بودجه.max_impressions	اگر `LineItem.budget.budgetUnit` `BUDGET_UNIT_IMPRESSIONS` باشد، قسمت `LineItem.budget.maxAmount` .
budget.max_spend_advertiser_micros	اگر `LineItem.budget.budgetUnit` `BUDGET_UNIT_CURRENCY` باشد، قسمت `LineItem.budget.maxAmount` .
budce.pacing_type	فیلد `LineItem.pacing.pacingPeriod` .
budget.pacing_max_impressions	فیلد `LineItem.pacing.dailyMaxImpressions` .
budget.pacing_max_spend_advertiser_micros	فیلد `LineItem.pacing.dailyMaxMicros` .
بودجه.pacing_distribution	فیلد `LineItem.pacing.pacingType` .
فرکانس_کاپ	فیلد `LineItem.frequencyCap` .
شریک_هزینه ها	فیلد `LineItem.partnerCosts` .
target_list	قابل بازیابی از طریق روش `advertisers.lineItems.bulkListLineItemAssignedTargetingOptions` .

Negative Keyword List

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `NegativeKeywordList.negativeKeywordListId` .
نام	فیلد `NegativeKeywordList.displayName` .
advertiser_id	فیلد `NegativeKeywordList.advertiserId` .

شریک

نام فیلد ERF	در دسترس بودن DV360 API
common_data.id	قسمت `Partner.partnerId` .
common_data.name	قسمت `Partner.displayName` .
common_data.active	قسمت `Partner.entityStatus` .
common_data.integration_code	در دسترس نیست.
ارز_کد	قسمت `Partner.generalConfig.currencyCode` .
Exchange_settings	قسمت `Partner.exchangeConfig.enabledExchanges` .
پیش فرض_هزینه_شریک	در دسترس نیست.
default_partner_revenue	در دسترس نیست.
default_target_list	در دسترس نیست.

پیکسل

هیچ منبع یا فیلدی معادلی در Display & Video 360 API موجود نیست.

یونیورسال کانال

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `Channel.channelId` .
نام	قسمت `Channel.displayName` .
site_ids	بسته به نوع `owner` ، از طریق روش‌های `advertisers.channels.sites.list` و `partners.channels.sites.list` قابل بازیابی است.
accessing_advertisers	در دسترس نیست.
is_deleted	در دسترس نیست.
is_brand_safe_channel	در دسترس نیست.

لیست کاربران

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId` .
نام	فیلد `FirstAndThirdPartyAudience.displayName` .
data_partner_id	در دسترس نیست.
accessing_advertisers	در دسترس نیست.
شریک_قیمت گذاری	در دسترس نیست.
آگهی‌دهنده_قیمت‌ها	در دسترس نیست.

این راهنما نحوه مهاجرت از Entity Read Files به Display & Video 360 API را توسط:

ارائه یک نمای کلی از تفاوت های بین این دو رابط
مقایسه جداول ERF با خدمات API
ارائه راهنمایی در مورد بازیابی موجودیت از طریق API
اعتراف به شکاف های موجود در داده ها
ارائه نگاشت تمام فیلدهای ERF به فیلدهای منابع API قابل مقایسه

نمای کلی

هنگام انتقال از ERF به API Display & Video 360، تعدادی تفاوت کلیدی وجود دارد که باید در نظر گرفته شود، از جمله:

تازگی داده ها ERF ها روزانه و به صورت انبوه تولید می شوند در حالی که API به روزترین نسخه یک منبع را بازیابی می کند.
ساختار منابع API از ساختارهای JSON متفاوتی نسبت به ERF برای نمایش انواع منابع مشابه استفاده می کند. برخی از منابع، مانند تنظیمات هدف گذاری عمومی، ممکن است از فضای شناسایی متفاوتی استفاده کنند.
روش بازیابی. API Display & Video 360 برخلاف فایل‌های JSON خام ارائه شده توسط ERF، فقط بازیابی منابع را به صورت جداگانه، در فهرست‌های صفحه‌بندی شده یا از طریق انتقال داده‌های BigQuery امکان‌پذیر می‌کند.
دامنه. برخلاف ERF ها که با شناسه شریک محدوده بندی می شوند، بیشتر منابع API با شناسه تبلیغ کننده محدوده می شوند. منابع موجود در پاسخ ها به منابعی در آن محدوده محدود می شود.

نمایش داده های ERF در API

اطلاعات عمومی

جداول عمومی و SDF

منابع خصوصی

بازیابی موجودیت در API

منابع Display & Video 360 را می توان از طریق درخواست های مستقیم API یا وارد کردن خودکار به BigQuery بازیابی کرد.

درخواست های مستقیم API

محدوده مورد نیاز برخلاف ERF ها که توسط شریک محدوده بندی می شوند، بیشتر منابع در API توسط تبلیغ کننده تعیین می شوند. بازیابی همه نوع منبع، مانند موارد خط، تحت شریک ممکن است به درخواست فهرست فردی برای هر تبلیغ‌کننده فرزند آن شریک نیاز داشته باشد. استثناها شامل فرزندان مستقیم یک شریک، مانند تبلیغ‌کنندگان و کانال‌های متعلق به شریک هستند.
صفحه بندی. روش‌های فهرست API از صفحه‌بندی استفاده می‌کنند تا تضمین کنند که پاسخ‌ها در اندازه معقول هستند و اکثر پاسخ‌های درخواستی یا صفحات را به 100 منبع محدود می‌کنند. اگر تعداد منابع مربوطه بزرگتر از اندازه صفحه باشد، برای بازیابی صفحات بعدی پاسخ لیست کامل، به فراخوانی های لیستی متوالی نیاز است. یک نمونه کد برای صفحه‌بندی پاسخ لیست در بخشی از صفحه راهنمای هدفمندی ما در رابطه با بازیابی گزینه‌های هدف‌یابی موجود ارائه شده است.
درخواست‌های اضافی برای بازیابی هدفمند مورد نیاز است. تنظیمات هدف یک منبع در شیء API JSON آن گنجانده نشده است، اما در عوض منابع فرزندی هستند که به عنوان گزینه های هدف گذاری اختصاص یافته شناخته می شوند. این منابع کودک باید از طریق یک درخواست جداگانه بازیابی شوند. به عنوان مثال، برای هر آیتم خطی که از طریق یک درخواست advertisers.lineItems.list بازیابی می‌شود، یک درخواست جداگانه advertisers.lineItems.bulkListAssignedTargetingOptions باید برای بازیابی همه اطلاعات هدف ارائه شود.

بهینه سازی بازیابی منابع

درخواست های همزمان به API انجام دهید. Display & Video 360 API با استفاده از درخواست‌های هر تبلیغ‌کننده در هر محدودیت نرخ پروژه از زیرساخت محافظت می‌کند. این ساختار سهمیه ای به شما امکان می دهد یک راه حل چند رشته ای را در بین چندین تبلیغ کننده پیاده سازی کنید که کل زمان لازم برای بازیابی همه منابع لازم را کاهش می دهد. اگرچه صفحه بندی مستلزم آن است که همه منابع از یک نوع در محدوده خاصی از طریق فراخوانی های متوالی بازیابی شوند، بازیابی منابع در محدوده دیگری یا از نوع دیگری می تواند همزمان انجام شود.
از فیلترها استفاده کنید و بر اساس پارامترها در تماس های فهرستی خود ترتیب دهید تا فقط منابع مرتبط را بازیابی کنید. به عنوان مثال، اگر فقط به موارد خطی علاقه مند هستید که در روز گذشته به روز شده اند، می توانید از پارامتر filter متد advertisers.lineItems.list استفاده کنید تا فقط موارد خط را با updateTime بزرگتر از یک مهر زمانی معین برگردانید. این می تواند به میزان قابل توجهی تعداد درخواست هایی را که باید انجام شود کاهش می دهد.
برای جلوگیری از درخواست‌های غیرضروری API ، معمولاً شناسه‌های مورد استفاده را در حافظه پنهان ذخیره کنید . برخی از اطلاعات مرجع، مانند شناسه‌های گزینه‌های هدف و شناسه‌های مخاطب Google، نسبتاً پایدار هستند و می‌توانند با خیال راحت ذخیره شوند تا نیازی به بازیابی در هر بار استفاده نباشد. با این حال، مقادیر ذخیره شده در حافظه پنهان باید به صورت هفتگی بررسی شوند تا تغییرات یا کاهش‌های نادر را در نظر بگیرند.

برای اطلاعات بیشتر در مورد نحوه دسترسی موثر به Display & Video 360 API راهنمای بهینه سازی سهمیه ما را ببینید.

وارد کردن به BigQuery

برای اطلاعات بیشتر در مورد استفاده از رابط BigQuery API Display & Video 360 به مستندات ابری زیر مراجعه کنید:

شکاف های داده API شناخته شده

هنگام مهاجرت از ERF به Display & Video 360 API ممکن است با شکاف های داده قابل توجهی مواجه شوید، مانند:

دستورات درج داستان سفارش‌های درج داستان از طریق API قابل بازیابی نیستند و باید از طریق رابط کاربری Display & Video 360 بازیابی شوند.
زیر مجموعه ای از زمینه های منبع تعداد کمی از فیلدهای منبع موجود در اشیاء ERF در منابع مربوطه بازیابی شده از طریق Display & Video 360 API موجود نیستند.

پیوست: نگاشت فیلدهای ERF به API

نقشه برداری جدول عمومی

مجموعه برنامه

قابل بازیابی تحت نوع هدف گیری TARGETING_TYPE_APP_CATEGORY .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `TargetingOption.targetingOptionId` .
نام	قسمت `TargetingOption.appCategoryDetails.displayName` .

مرورگر

قابل بازیابی تحت نوع هدف گیری TARGETING_TYPE_BROWSER .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	فیلد `TargetingOption.targetingOptionId` .
is_mobile	در دسترس نیست.
نام	قسمت `TargetingOption.browserDetails.displayName` .

DataPartner

هیچ منبع یا فیلدی معادلی در Display & Video 360 API موجود نیست.

معیارهای دستگاه

قابل بازیابی تحت انواع هدف گیری TARGETING_TYPE_OPERATING_SYSTEM ، TARGETING_TYPE_DEVICE_MAKE_MODEL ، و TARGETING_TYPE_DEVICE_TYPE .

نام فیلد ERF	در دسترس بودن DV360 API
شناسه	قسمت `TargetingOption.targetingOptionId` یا `DeviceType` enum.
is_mobile	در دسترس نیست.
نام	`TargetingOption.operatingSystemDetails.displayName` Field ، `TargetingOption.deviceMakeModelDetails.displayName` Field یا `DeviceType` Enum بسته به نوع هدفمند.
معیار_تایپ	قسمت `TargetingOption.targetingType` .
Operating_system_id	در دسترس نیست.
mobile_brand_name	در دسترس نیست.
mobile_model_name	در دسترس نیست.
mobile_make_model_id	در دسترس نیست.
نوع دستگاه	enum `DeviceType` .

جغرافیایی

قابل بازیابی در نوع هدفمند TARGETING_TYPE_GEO_REGION .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
canonical_name	`TargetingOption.geoRegionDetails.displayName` Field.
نام	در دسترس نیست.
کد_ کشور	در دسترس نیست.
کد_ منطقه	در دسترس نیست.
نام_نه شهر	در دسترس نیست.
postal_name	در دسترس نیست.
DMA_CODE	در دسترس نیست.

ISP

قابل بازیابی در نوع هدفمند TARGETING_TYPE_CARRIER_AND_ISP .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
is_mobile	در دسترس نیست.
نام	`TargetingOption.carrierAndIspDetails.displayName` Field.
secondary_criteria_id	میدان `TargetingOption.targetingOptionId` .

زبان

قابل بازیابی در نوع هدفمند TARGETING_TYPE_LANGUAGE .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
نام	در دسترس نیست. نام نمایش کامل برای یک زبان در قسمت `TargetingOption.languageDetails.displayName` در دسترس است.

سیتوپلادیید

هیچ منبع یا زمینه های معادل موجود در نمایش و فیلم 360 API وجود ندارد.

پشتیبانی

قابل بازیابی در نوع هدفمند TARGETING_TYPE_EXCHANGE .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`Exchange` Enum.
نام	`Exchange` Enum.

جهانی

هیچ منبع یا زمینه های معادل موجود در نمایش و فیلم 360 API وجود ندارد. سایت ها و برنامه های انفرادی به ترتیب می توانند به طور مستقیم در زیر انواع هدف TARGETING_TYPE_URL و TARGETING_TYPE_APP هدف قرار گیرند. در Display & Video 360 ، هر برنامه یا URL قابل هدف است ، اما نمی توان هر برنامه یا URL را گزارش کرد. اگر می خواهید برنامه ها و URL های غیر قابل گزارش را از هزینه حذف کنید ، دستورالعمل های موجود در مرکز راهنمای DV360 را دنبال کنید.

نقشه برداری از زمینه میز خصوصی

جداول زیر زمینه های جداول خصوصی ERF را به زمینه ها یا خدمات موجود در API Display & Video 360 نقشه می کند. اگرچه مقدار یک قسمت ممکن است به دیگری نقشه بکشد ، این تضمین نمی کند که از همان نوع داده ، مقادیر enum یا فضای شناسه استفاده کنند.

تبلیغ کننده

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`Advertiser.advertiserId` Field.
common_data.name	`Advertiser.displayName` Field.
Common_Data.Active	`Advertiser.entityStatus` Field.
common_data.integration_code	`Advertiser.integrationDetails.integrationCode` Field.
شریک زندگی_	`Advertiser.partnerId` Field.
رمز	`Advertiser.generalConfig.currencyCode` Field.
منطقه timezone_code	`Advertiser.generalConfig.timeZone` Field.
landing_page_url	`Advertiser.generalConfig.domainUrl` Field.
در دسترس_ channel_ids	قابل بازیابی از طریق `advertisers.channels.list` روش.
Blacklist_Channel_Id	قابل بازیابی از طریق `advertisers.targetingTypes.assignedtargetingOptions.list` روش تحت نوع هدف قرار دادن `TARGETING_TYPE_CHANNEL` . اگر `AssignedTargetingOption.channelDetails.negative` درست است ، کانال از نظر منفی هدفمند است.
DCM_Configuration	در دسترس نیست.
dcm_network_id	`Advertiser.adServerConfig.cmHybridConfig.cmAccountId` .
dcm_advertiser_id	قسمت `Advertiser.adServerConfig.cmHybridConfig.cmAdvertiserIds` .
dcm_floodlight_group_id	`Advertiser.adServerConfig.cmHybridConfig.cmFloodlightConfigId` .
dcm_syncable_site_ids	`Advertiser.adServerConfig.cmHybridConfig.cmSyncableSiteIds` .
Enable_oba_tags	در دسترس نیست.

کمپین

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`Campaign.campaignId` . زمینه campaignid.
common_data.name	`Campaign.displayName` . DISPLAYNAME FIELD.
Common_Data.Active	`Campaign.entityStatus` Field.
common_data.integration_code	در دسترس نیست.
Admentiser_id	`Campaign.advertiserId` . زمینه advertiserid.
بودجه	`Campaign.campaignFlight` and `Campaign.campaignBudgets` Fields.
فرکانس_کپ	`Campaign.frequencyCap` زمینه.
default_target_list	قابل بازیابی از طریق `advertisers.campaigns.bulkListCampaignAssignedTargetingOptions` .
UseS_VIDEO_CREATIVES	در دسترس نیست.
UseS_DISPLAY_CREATIVE	در دسترس نیست.
use_audio_creatives	در دسترس نیست.
هدف	کمپین `Campaign.campaignGoal.campaignGoalType` .
متریک	`Campaign.campaignGoal.performanceGoal.performanceGoalType` .
شرح هدف_	`Campaign.campaignGoal.performanceGoal.performanceGoalString` .
metric_amount_micros	`Campaign.campaignGoal.performanceGoal.performanceGoalAmountMicros` .

خلاق

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`Creative.creativeId` Field.
common_data.name	`Creative.displayName` Field.
Common_Data.Active	`Creative.entityStatus` Field.
common_data.integration_code	`Creative.integrationCode` Field.
Admentiser_id	`Creative.advertiserId` Field.
dcm_plaction_id	`Creative.cmPlacementId` Field.
width_pixels	`Creative.dimensions.widthPixels` Field.
پیکسل ارتفاع	`Creative.dimensions.heightPixels` Field.
تأیید_ استاتوس	`Creative.reviewStatus` Field.
گسترش	`Creative.expandingDirection` Field.
نوع خلاقانه_	`Creative.creativeType` Field.

سفارشی

نام فیلد ERF	در دسترس بودن API DV360
شناسه	زمینه `CustomList.customListId` .
نام	فیلد `CustomList.displayName` .
توضیحات	در دسترس نیست.
Admentiser_id	در دسترس نیست.

نور چراغ برق

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`FloodlightActivity.floodlightActivityId` .
common_data.name	`FloodlightActivity.displayName` Field.
Common_Data.Active	`FloodlightActivity.servingStatus` Field.
common_data.integration_code	در دسترس نیست.
Admentiser_id	قسمت `FloodlightActivity.advertiserIds` همه تبلیغ کنندگان را با دسترسی به فعالیت های روشن در زیر شریک داده شده لیست می کند.
شریک زندگی_	ارائه شده توسط کاربر هنگام درخواست به سرویس `floodlightGroups.floodlightActivities` .
leareting_enabled	قسمت `FloodlightActivity.remarketingConfigs` این پیکربندی را برای هر تبلیغ کننده با دسترسی به فعالیت نوری در زیر شریک داده شده لیست می کند.
ssl_required	`FloodlightActivity.sslRequired` Field.

درج

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`InsertionOrder.insertionOrderId` Field.
common_data.name	`InsertionOrder.displayName` فیلد.
Common_Data.Active	`InsertionOrder.entityStatus` Field.
common_data.integration_code	`InsertionOrder.integrationDetails.integrationCode` .
Admentiser_id	`InsertionOrder.advertiserId` Field.
تبلیغات_ید	`InsertionOrder.campaignId` Field.
به طور کلی_تجت	در دسترس نیست. می توان با استفاده از محتویات قسمت `InsertionOrder.budget.budgetSegments` محاسبه کرد.
برنامه ریزی شده_	قسمت `InsertionOrder.budget.budgetSegments` .
فرکانس_کپ	زمینه `InsertionOrder.frequencyCap` .
Default_Partner_costs	`InsertionOrder.partnerCosts` Field.
default_target_list	قابل بازیابی از طریق `advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions` .

منبع

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`InventorySource.inventorySourceId` FIELD.
طبقه بندی نشده	در دسترس نیست.
موجودی_ نام	Field `InventorySource.displayName` .
Exchange_id	`InventorySource.exchange` Field.
دسترسی به_ادولرز	`InventorySource.readWriteAccessors` و `InventorySource.readAdvertiserIds` زمینه ها.
ide ideud_id	FIELD `InventorySource.dealId` .
min_cpm_micros	`InventorySource.rateDetails.rate.nanos` ، بسته به ارزش `InventorySource.rateDetails.inventorySourceRateType` .
min_cpm_currency_code	`InventorySource.rateDetails.rate.currencyCode` FIELD.

خط

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	زمینه `LineItem.lineItemId` .
common_data.name	فیلد `LineItem.displayName` .
Common_Data.Active	زمینه `LineItem.entityStatus` .
common_data.integration_code	قسمت `LineItem.integrationDetails.integrationCode` .
line_item_type	قسمت `LineItem.lineItemType` .
insertion_order_id	زمینه `LineItem.insertionOrderId` .
IDS خلاق	زمینه `LineItem.creativeIds` .
max_cpm_advertiser_micros	`LineItem.bidStrategy.maximizeSpendAutoBid.maxAverageCpmBidAmountMicros` یا `LineItem.bidStrategy.performanceGoalAutoBid.maxAverageCpmBidAmountMicros` ، بسته به طرح استراتژی مورد استفاده.
عملکرد_	بسته به طرح استراتژی مورد استفاده ، بسته به طرح استراتژی مورد استفاده ، `LineItem.bidStrategy.maximizeSpendAutoBid.performanceGoalType` یا `LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalType` .
هدف_ادورتر_میکروس	`LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalAmountMicros` .
partner_revenue_model	قسمت `LineItem.partnerRevenueModel` .
COST_TRACKING_PIXELS	زمینه `LineItem.conversionCounting.floodlightActivityConfigs` .
بودجه. start_time_usec	زمینه `LineItem.flight.dateRange.startDate` .
بودجه. end_time_usec	زمینه `LineItem.flight.dateRange.endDate` .
بودجه. max_impressions	زمینه `LineItem.budget.maxAmount` if `LineItem.budget.budgetUnit` `BUDGET_UNIT_IMPRESSIONS` است.
بودجه. max_spend_advertiser_micros	زمینه `LineItem.budget.maxAmount` if `LineItem.budget.budgetUnit` `BUDGET_UNIT_CURRENCY` است.
بودجه. pacing_type	زمینه `LineItem.pacing.pacingPeriod` .
بودجه. pacing_max_impressions	قسمت `LineItem.pacing.dailyMaxImpressions` .
بودجه. pacing_max_spend_advertiser_micros	زمینه `LineItem.pacing.dailyMaxMicros` .
بودجه. pacing_distribution	قسمت `LineItem.pacing.pacingType` .
فرکانس_کپ	زمینه `LineItem.frequencyCap` .
CANTER_COSTS	فیلد `LineItem.partnerCosts` .
لیست	قابل بازیابی از طریق `advertisers.lineItems.bulkListLineItemAssignedTargetingOptions` .

لیست کلید واژه

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`NegativeKeywordList.negativeKeywordListId` .
نام	فیلد `NegativeKeywordList.displayName` .
Admentiser_id	قسمت `NegativeKeywordList.advertiserId` .

شریک

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	زمینه `Partner.partnerId` .
common_data.name	`Partner.displayName` Field.
Common_Data.Active	`Partner.entityStatus` Field.
common_data.integration_code	در دسترس نیست.
رمز	قسمت `Partner.generalConfig.currencyCode` .
Exchange_settings	`Partner.exchangeConfig.enabledExchanges` FIELD.
Default_Partner_costs	در دسترس نیست.
Default_Partner_Revenue	در دسترس نیست.
default_target_list	در دسترس نیست.

پیکسل

هیچ منبع یا زمینه های معادل موجود در نمایش و فیلم 360 API وجود ندارد.

کانال جهانی

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`Channel.channelId` .
نام	فیلد `Channel.displayName` .
ids_ids	بسته به نوع `owner` ، از طریق `advertisers.channels.sites.list` . channels.sites.List and `partners.channels.sites.list` قابل بازیابی است.
دسترسی به_ادولرز	در دسترس نیست.
is_deleted	در دسترس نیست.
is_brand_safe_channel	در دسترس نیست.

لیست کاربر

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId` .
نام	`FirstAndThirdPartyAudience.displayName` Field.
data_partner_id	در دسترس نیست.
دسترسی به_ادولرز	در دسترس نیست.
شریک زندگی	در دسترس نیست.
Advertiser_Pricings	در دسترس نیست.

Entity Read Files (ERFS) بازنمایی JSON از اشیاء کمپین یک شریک است که در صورت درخواست ، روزانه تولید می شوند و از طریق Google Cloud Storage در دسترس قرار می گیرند.

ERF ها در ژوئن 2021 کاهش یافتند . از 31 اکتبر 2024 ، ERFS رسما غروب خورشید خواهد بود و دیگر تولید نمی شود. همه کاربران موجود در پرونده های موجود در پرونده های خواندن به منظور ادامه بازیابی منابع نمایش و فیلم 360 ، به API Display & Video 360 تشویق می شوند.

این راهنما در مورد نحوه مهاجرت از فایل های خواندن نهاد به API Display & Video 360 توسط:

ارائه نمای کلی از تفاوت بین دو رابط
مقایسه جداول ERF با خدمات API
ارائه راهنمایی در مورد بازیابی موجودیت از طریق API
تأیید شکاف داده های موجود
ارائه نقشه برداری از همه زمینه های ERF در زمینه های منبع API قابل مقایسه

نمای کلی

هنگام مهاجرت از ERFS به نمایشگر و فیلم 360 API ، تعدادی تفاوت اساسی وجود دارد که باید در نظر گرفت ، از جمله:

طراوت داده ها ERF ها روزانه و به صورت عمده تولید می شوند در حالی که API به روزترین نسخه یک منبع را بازیابی می کند.
ساختار منابع. API از ساختارهای مختلف JSON نسبت به ERF استفاده می کند تا انواع منابع را نشان دهد. برخی از منابع ، مانند تنظیمات هدفمند عمومی ، ممکن است از یک فضای شناسه متفاوت استفاده کنند.
روش بازیابی. Display & Video 360 API فقط بر خلاف پرونده های RAW JSON ارائه شده توسط ERF ، بازیابی منابع را به صورت جداگانه ، در لیست های صفحه ای یا از طریق انتقال داده های BigQuery امکان پذیر می کند.
دامنه. برخلاف ERF ، که توسط شناسه شریک زندگی می شوند ، بیشتر منابع API توسط Advertiser ID استفاده می شوند. منابع موجود در پاسخ ها محدود به منابع در آن محدوده است.

نمایش داده های ERF در API

فایل های خواندن موجودیت به جداول "عمومی" و "خصوصی" جدا می شوند. جداول عمومی اطلاعاتی را ارائه می دهد که در دسترس است و برای همه کاربران ، مانند مقادیر هدفمند. جداول خصوصی داده هایی را ارائه می دهد که مختص شریک زندگی است ، مانند منابع خلاق یا خط.

Display & Video 360 API از این دوگانگی استفاده نمی کند ، در عوض باعث می شود همه این اطلاعات از طریق خدمات مختلف و استفاده از ساختارهای مختلف JSON قابل بازیابی باشند. در این بخش اطلاعات ارائه شده از طریق جداول ERF عمومی و خصوصی با اطلاعاتی که از طریق منابع و خدمات API Display & Video 360 در دسترس است ، مقایسه می شود.

اطلاعات عمومی

جداول عمومی ERF مواد مرجع را برای استفاده کاربران در هنگام تفسیر تنظیمات هدفمند منابع خصوصی بازیابی شده خود و اختصاص هدف قرار دادن از طریق زیر مجموعه ای از پرونده های داده های ساختار یافته (SDF) که از طریق UI بارگذاری می شوند ، فراهم می کند. این مواد مرجع برای همه کاربران یکسان است و از یک شناسه عددی تشکیل شده است که برای نقشه برداری و جزئیات توصیفی تر مانند نام نمایش استفاده می شود.

هنگام استفاده از API Display & Video 360 ، می توان اطلاعات مرجع را از طریق سرویس targetingTypes.targetingOptions بازیابی کرد. مشابه جداول عمومی ، این سرویس شناسه ها و جزئیات گزینه های هدفمند را برای یک نوع هدفمند خاص ارائه می دهد. برای مثال کد که نشان دهنده بازیابی شناسه گزینه هدفمند است ، به صفحه هدف گذاری مجموعه موجود ما مراجعه کنید.

جداول عمومی و SDF

قبل از SDF V7 ، Entity Files و Files Data ساختاری از همان فضای شناسه برای هدف قرار دادن تنظیمات استفاده می کنند. اگر شما یک کاربر SDF هستید که از جداول عمومی ERF برای تفسیر یا اختصاص تنظیمات هدفمند با استفاده از SDF استفاده می کنید ، می توانید در عوض این ماده مرجع را با فرمت CSV از طریق Display & Video 360 UI بارگیری کنید.

با شروع V7 ، فضاهای شناسه مورد استفاده توسط زیر مجموعه ای از ستون های داده های ساختار یافته برای جداسازی SDF از ERFS و تراز بیشتر با Display & Video 360 API به روز شده است. برای اطلاعات بیشتر به راهنمای مهاجرت V7 و مستندات مرجع مراجعه کنید.

منابع خصوصی

جداول خصوصی ERF عکس فوری از تنظیمات فعلی منابع خصوصی متعلق به یک شریک را ارائه می دهد. با توجه به حجم زیاد منابعی که می تواند تحت یک شریک واحد ایجاد شود ، این پرونده ها می توانند بسیار بزرگ و بارگیری و پردازش شوند.

در API ، هر جدول خصوصی دارای یک سرویس مربوطه است که نقاط پایانی برای بازیابی و مدیریت آن نوع منابع را فراهم می کند. منابع را می توان با استفاده از روش لیست مربوطه هر سرویس به صورت عمده بازیابی کرد. ساختار JSON برای هر منبع در API در مقایسه با ERF متفاوت است ، با استفاده از نام های مختلف زمینه و منابع مشترک.

برخی از اطلاعات موجود در نمایندگی ERF از یک منبع ، مانند تنظیمات هدفمند اختصاص داده شده یک منبع یا سایت های کانال ، در API به عنوان کودکان منبع اصلی نشان داده شده است و باید از طریق درخواست های اضافی API بازیابی شود.

بازیابی موجودیت در API

نمایش و فیلم 360 منابع را می توان از طریق درخواست های مستقیم API یا واردات خودکار به BigQuery بازیابی کرد.

درخواست های API مستقیم

هر نوع منبع از طریق یک سرویس API متفاوت قابل بازیابی است. منابع را می توان به ترتیب با استفاده از روش GET یا لیست خدمات مناسب به صورت جداگانه یا به صورت عمده بازیابی کرد. ویژگی های مهم نمایش و فیلم 360 لیست لیست API شامل موارد زیر است:

دامنه مورد نیاز بر خلاف ERFS ، که توسط شریک زندگی می شوند ، بیشتر منابع موجود در API توسط تبلیغ کننده جمع می شوند. بازیابی همه نوع منابع ، مانند موارد خط ، تحت یک شریک ممکن است به درخواست لیست شخصی برای هر تبلیغ کننده کودک از آن شریک نیاز داشته باشد. استثنائات شامل فرزندان مستقیم شریک زندگی ، مانند تبلیغ کنندگان و کانال های متعلق به شریک زندگی است.
صفحه بندی روشهای لیست API از صفحه بندی استفاده می کنند تا تضمین کنند که پاسخ ها در اندازه معقول هستند و بیشتر پاسخ های درخواست شخصی یا صفحات را به 100 منبع محدود می کنند. اگر تعداد منابع مرتبط از اندازه صفحه بزرگتر باشد ، برای بازیابی صفحات بعدی پاسخ لیست کامل ، تماس های لیست متوالی لازم است. یک مثال کد صفحه بندی پاسخ لیست در بخشی از صفحه راهنمای هدف گذاری ما در مورد بازیابی گزینه های هدفمند در دسترس ارائه شده است.
درخواست های اضافی برای هدف قرار دادن بازیابی مورد نیاز است. تنظیمات هدفمند یک منبع در شیء API JSON آن گنجانده نشده است ، اما در عوض منابع کودک هستند که به عنوان گزینه های هدفمند اختصاص داده می شوند . این منابع کودک باید از طریق یک درخواست جداگانه بازیابی شود. به عنوان مثال ، برای هر مورد خط بازیابی شده از طریق یک advertisers.lineItems.list ، یک advertisers.lineItems.bulkListAssignedTargetingOptions جداگانه. LineItems.BulkListAssignEdtargetingOptions باید برای بازیابی کلیه اطلاعات هدفمند انجام شود.

بازیابی منابع را بهینه کنید

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

درخواست های همزمان را به API انجام دهید. Display & Video 360 API با استفاده از درخواست برای هر تبلیغ در هر محدودیت نرخ پروژه ، از زیرساخت ها محافظت می کند. این ساختار سهمیه به شما امکان می دهد یک راه حل چند رشته ای را در چندین تبلیغ کننده اجرا کنید که کل زمان لازم برای بازیابی تمام منابع لازم را کاهش می دهد. اگرچه صفحه بندی مستلزم آن است که تمام منابع از یک نوع در یک محدوده خاص از طریق تماس های متوالی بازیابی شوند ، بازیابی منابع در محدوده دیگری یا از نوع دیگری می تواند به طور همزمان انجام شود.
از فیلترها و سفارشات با پارامترهای موجود در لیست خود استفاده کنید تا فقط منابع مربوطه را بازیابی کنید. به عنوان مثال ، اگر شما فقط به موارد خطی که در روز گذشته به روز شده اید علاقه مند هستید ، می توانید از پارامتر filter advertisers.lineItems.list استفاده کنید. LineItems.List فقط موارد خط را با یک updateTime بیشتر از یک زمان بندی خاص نشان دهید. این می تواند تعداد درخواستهایی را که باید انجام شود به میزان قابل توجهی کاهش دهد.
حافظه نهان به طور مرتب از شناسه ها برای جلوگیری از درخواست های غیر ضروری API استفاده می کرد . برخی از اطلاعات مرجع ، مانند شناسه گزینه های هدفمند و شناسه مخاطبان Google ، نسبتاً پایدار هستند و می توانند با خیال راحت ذخیره شوند تا از نیاز به بازیابی در هر استفاده جلوگیری شود. با این حال ، مقادیر ذخیره شده باید به صورت هفتگی بررسی شود تا تغییرات یا استهلاک های نادر را به خود اختصاص دهد.

برای اطلاعات بیشتر در مورد نحوه دسترسی به نمایشگر و فیلم 360 API به طور کارآمد به راهنمای بهینه سازی سهمیه ما مراجعه کنید.

وارد کردن به BigQuery

Connector Display & Video 360 API BigQuery به شما امکان می دهد به طور خودکار تنظیمات منبع نمایش و فیلم 360 را مستقیماً وارد BigQuery کنند. پیکربندی ها با استفاده از طراحی منابع Display & Video 360 API در BigQuery ذخیره می شوند. زیر مجموعه ای از منابع API پشتیبانی می شود.

برای اطلاعات بیشتر در مورد استفاده از اتصال Display & Video 360 API BigQuery به مستندات ابری زیر مراجعه کنید:

شکاف داده های API شناخته شده

شکاف های قابل توجهی وجود دارد که ممکن است هنگام مهاجرت از ERF به نمایش و فیلمبرداری 360 API با آنها روبرو شوید ، مانند:

سفارشات درج داستان. سفارشات درج داستان از طریق API قابل بازیابی نیست و باید از طریق نمایش و فیلم 360 UI بازیابی شود.
زیر مجموعه ای از زمینه های منابع. تعداد کمی از زمینه های منابع موجود در اشیاء ERF در منابع مربوطه که از طریق نمایش و فیلم 360 API بازیابی می شوند در دسترس نیستند.

پیوست: نقشه برداری از قسمتهای ERF به API

نقشه برداری جدول عمومی

جداول زیر زمینه های جداول عمومی ERF را به انواع هدفمند موجود و زمینه های هدفمند در نمایشگاه و فیلم 360 API نقشه می کند. اگرچه مقدار یک قسمت ممکن است به قسمت دیگری نقشه بکشد ، این تضمین نمی کند که از همان نوع داده ، مقادیر enum یا فضای شناسه استفاده کنند.

مجموعه برنامه

قابل بازیابی در زیر نوع هدف قرار دادن TARGETING_TYPE_APP_CATEGORY .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
نام	`TargetingOption.appCategoryDetails.displayName` Field.

مرورگر

قابل بازیابی در زیر نوع هدف قرار دادن TARGETING_TYPE_BROWSER .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
is_mobile	در دسترس نیست.
نام	`TargetingOption.browserDetails.displayName` Field.

اطلاعات

هیچ منبع یا زمینه های معادل موجود در نمایش و فیلم 360 API وجود ندارد.

انحطاط

قابل بازیابی در زیر انواع هدف قرار دادن TARGETING_TYPE_OPERATING_SYSTEM ، TARGETING_TYPE_DEVICE_MAKE_MODEL ، و TARGETING_TYPE_DEVICE_TYPE .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` یا enum `DeviceType` .
is_mobile	در دسترس نیست.
نام	`TargetingOption.operatingSystemDetails.displayName` Field ، `TargetingOption.deviceMakeModelDetails.displayName` Field یا `DeviceType` Enum بسته به نوع هدفمند.
معیار_تایپ	قسمت `TargetingOption.targetingType` .
Operating_system_id	در دسترس نیست.
mobile_brand_name	در دسترس نیست.
mobile_model_name	در دسترس نیست.
mobile_make_model_id	در دسترس نیست.
نوع دستگاه	enum `DeviceType` .

جغرافیایی

قابل بازیابی در نوع هدفمند TARGETING_TYPE_GEO_REGION .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
canonical_name	`TargetingOption.geoRegionDetails.displayName` Field.
نام	در دسترس نیست.
کد_ کشور	در دسترس نیست.
کد_ منطقه	در دسترس نیست.
نام_نه شهر	در دسترس نیست.
postal_name	در دسترس نیست.
DMA_CODE	در دسترس نیست.

ISP

قابل بازیابی در نوع هدفمند TARGETING_TYPE_CARRIER_AND_ISP .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
is_mobile	در دسترس نیست.
نام	`TargetingOption.carrierAndIspDetails.displayName` Field.
secondary_criteria_id	میدان `TargetingOption.targetingOptionId` .

زبان

قابل بازیابی در نوع هدفمند TARGETING_TYPE_LANGUAGE .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	میدان `TargetingOption.targetingOptionId` .
نام	در دسترس نیست. نام نمایش کامل برای یک زبان در قسمت `TargetingOption.languageDetails.displayName` در دسترس است.

سیتوپلادیید

هیچ منبع یا زمینه های معادل موجود در نمایش و فیلم 360 API وجود ندارد.

پشتیبانی

قابل بازیابی در نوع هدفمند TARGETING_TYPE_EXCHANGE .

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`Exchange` Enum.
نام	`Exchange` Enum.

جهانی

نقشه برداری از زمینه میز خصوصی

تبلیغ کننده

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`Advertiser.advertiserId` Field.
common_data.name	`Advertiser.displayName` Field.
Common_Data.Active	`Advertiser.entityStatus` Field.
common_data.integration_code	`Advertiser.integrationDetails.integrationCode` Field.
شریک زندگی_	`Advertiser.partnerId` Field.
رمز	`Advertiser.generalConfig.currencyCode` Field.
منطقه timezone_code	`Advertiser.generalConfig.timeZone` Field.
landing_page_url	`Advertiser.generalConfig.domainUrl` Field.
در دسترس_ channel_ids	قابل بازیابی از طریق `advertisers.channels.list` روش.
Blacklist_Channel_Id	قابل بازیابی از طریق `advertisers.targetingTypes.assignedtargetingOptions.list` روش تحت نوع هدف قرار دادن `TARGETING_TYPE_CHANNEL` . اگر `AssignedTargetingOption.channelDetails.negative` درست است ، کانال از نظر منفی هدفمند است.
DCM_Configuration	در دسترس نیست.
dcm_network_id	`Advertiser.adServerConfig.cmHybridConfig.cmAccountId` .
dcm_advertiser_id	قسمت `Advertiser.adServerConfig.cmHybridConfig.cmAdvertiserIds` .
dcm_floodlight_group_id	`Advertiser.adServerConfig.cmHybridConfig.cmFloodlightConfigId` .
dcm_syncable_site_ids	`Advertiser.adServerConfig.cmHybridConfig.cmSyncableSiteIds` .
Enable_oba_tags	در دسترس نیست.

کمپین

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`Campaign.campaignId` . زمینه campaignid.
common_data.name	`Campaign.displayName` . DISPLAYNAME FIELD.
Common_Data.Active	`Campaign.entityStatus` Field.
common_data.integration_code	در دسترس نیست.
Admentiser_id	`Campaign.advertiserId` . زمینه advertiserid.
بودجه	`Campaign.campaignFlight` and `Campaign.campaignBudgets` Fields.
فرکانس_کپ	`Campaign.frequencyCap` زمینه.
default_target_list	قابل بازیابی از طریق `advertisers.campaigns.bulkListCampaignAssignedTargetingOptions` .
UseS_VIDEO_CREATIVES	در دسترس نیست.
UseS_DISPLAY_CREATIVE	در دسترس نیست.
use_audio_creatives	در دسترس نیست.
هدف	کمپین `Campaign.campaignGoal.campaignGoalType` .
متریک	`Campaign.campaignGoal.performanceGoal.performanceGoalType` .
شرح هدف_	`Campaign.campaignGoal.performanceGoal.performanceGoalString` .
metric_amount_micros	`Campaign.campaignGoal.performanceGoal.performanceGoalAmountMicros` .

خلاق

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`Creative.creativeId` Field.
common_data.name	`Creative.displayName` Field.
Common_Data.Active	`Creative.entityStatus` Field.
common_data.integration_code	`Creative.integrationCode` Field.
Admentiser_id	`Creative.advertiserId` Field.
dcm_plaction_id	`Creative.cmPlacementId` Field.
width_pixels	`Creative.dimensions.widthPixels` Field.
پیکسل ارتفاع	`Creative.dimensions.heightPixels` Field.
تأیید_ استاتوس	`Creative.reviewStatus` Field.
گسترش	`Creative.expandingDirection` Field.
نوع خلاقانه_	`Creative.creativeType` Field.

سفارشی

نام فیلد ERF	در دسترس بودن API DV360
شناسه	زمینه `CustomList.customListId` .
نام	فیلد `CustomList.displayName` .
توضیحات	در دسترس نیست.
Admentiser_id	در دسترس نیست.

نور چراغ برق

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`FloodlightActivity.floodlightActivityId` .
common_data.name	`FloodlightActivity.displayName` Field.
Common_Data.Active	`FloodlightActivity.servingStatus` Field.
common_data.integration_code	در دسترس نیست.
Admentiser_id	قسمت `FloodlightActivity.advertiserIds` همه تبلیغ کنندگان را با دسترسی به فعالیت های روشن در زیر شریک داده شده لیست می کند.
شریک زندگی_	ارائه شده توسط کاربر هنگام درخواست به سرویس `floodlightGroups.floodlightActivities` .
leareting_enabled	قسمت `FloodlightActivity.remarketingConfigs` این پیکربندی را برای هر تبلیغ کننده با دسترسی به فعالیت نوری در زیر شریک داده شده لیست می کند.
ssl_required	`FloodlightActivity.sslRequired` Field.

درج

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	`InsertionOrder.insertionOrderId` Field.
common_data.name	`InsertionOrder.displayName` فیلد.
Common_Data.Active	`InsertionOrder.entityStatus` Field.
common_data.integration_code	`InsertionOrder.integrationDetails.integrationCode` .
Admentiser_id	`InsertionOrder.advertiserId` Field.
تبلیغات_ید	`InsertionOrder.campaignId` Field.
به طور کلی_تجت	در دسترس نیست. می توان با استفاده از محتویات قسمت `InsertionOrder.budget.budgetSegments` محاسبه کرد.
برنامه ریزی شده_	قسمت `InsertionOrder.budget.budgetSegments` .
فرکانس_کپ	زمینه `InsertionOrder.frequencyCap` .
Default_Partner_costs	`InsertionOrder.partnerCosts` Field.
default_target_list	قابل بازیابی از طریق `advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions` .

منبع

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`InventorySource.inventorySourceId` FIELD.
طبقه بندی نشده	در دسترس نیست.
موجودی_ نام	Field `InventorySource.displayName` .
Exchange_id	`InventorySource.exchange` Field.
دسترسی به_ادولرز	`InventorySource.readWriteAccessors` و `InventorySource.readAdvertiserIds` زمینه ها.
ide ideud_id	FIELD `InventorySource.dealId` .
min_cpm_micros	`InventorySource.rateDetails.rate.nanos` ، بسته به ارزش `InventorySource.rateDetails.inventorySourceRateType` .
min_cpm_currency_code	`InventorySource.rateDetails.rate.currencyCode` FIELD.

خط

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	زمینه `LineItem.lineItemId` .
common_data.name	فیلد `LineItem.displayName` .
Common_Data.Active	زمینه `LineItem.entityStatus` .
common_data.integration_code	قسمت `LineItem.integrationDetails.integrationCode` .
line_item_type	قسمت `LineItem.lineItemType` .
insertion_order_id	زمینه `LineItem.insertionOrderId` .
IDS خلاق	زمینه `LineItem.creativeIds` .
max_cpm_advertiser_micros	`LineItem.bidStrategy.maximizeSpendAutoBid.maxAverageCpmBidAmountMicros` یا `LineItem.bidStrategy.performanceGoalAutoBid.maxAverageCpmBidAmountMicros` ، بسته به طرح استراتژی مورد استفاده.
عملکرد_	بسته به طرح استراتژی مورد استفاده ، بسته به طرح استراتژی مورد استفاده ، `LineItem.bidStrategy.maximizeSpendAutoBid.performanceGoalType` یا `LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalType` .
هدف_ادورتر_میکروس	`LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalAmountMicros` .
partner_revenue_model	قسمت `LineItem.partnerRevenueModel` .
COST_TRACKING_PIXELS	زمینه `LineItem.conversionCounting.floodlightActivityConfigs` .
بودجه. start_time_usec	زمینه `LineItem.flight.dateRange.startDate` .
بودجه. end_time_usec	زمینه `LineItem.flight.dateRange.endDate` .
بودجه. max_impressions	زمینه `LineItem.budget.maxAmount` if `LineItem.budget.budgetUnit` `BUDGET_UNIT_IMPRESSIONS` است.
بودجه. max_spend_advertiser_micros	زمینه `LineItem.budget.maxAmount` if `LineItem.budget.budgetUnit` `BUDGET_UNIT_CURRENCY` است.
بودجه. pacing_type	زمینه `LineItem.pacing.pacingPeriod` .
بودجه. pacing_max_impressions	قسمت `LineItem.pacing.dailyMaxImpressions` .
بودجه. pacing_max_spend_advertiser_micros	زمینه `LineItem.pacing.dailyMaxMicros` .
بودجه. pacing_distribution	قسمت `LineItem.pacing.pacingType` .
فرکانس_کپ	زمینه `LineItem.frequencyCap` .
CANTER_COSTS	فیلد `LineItem.partnerCosts` .
لیست	قابل بازیابی از طریق `advertisers.lineItems.bulkListLineItemAssignedTargetingOptions` .

لیست کلید واژه

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`NegativeKeywordList.negativeKeywordListId` .
نام	فیلد `NegativeKeywordList.displayName` .
Admentiser_id	قسمت `NegativeKeywordList.advertiserId` .

شریک

نام فیلد ERF	در دسترس بودن API DV360
Common_data.id	زمینه `Partner.partnerId` .
common_data.name	`Partner.displayName` Field.
Common_Data.Active	`Partner.entityStatus` Field.
common_data.integration_code	در دسترس نیست.
رمز	قسمت `Partner.generalConfig.currencyCode` .
Exchange_settings	`Partner.exchangeConfig.enabledExchanges` FIELD.
Default_Partner_costs	در دسترس نیست.
Default_Partner_Revenue	در دسترس نیست.
default_target_list	در دسترس نیست.

پیکسل

هیچ منبع یا زمینه های معادل موجود در نمایش و فیلم 360 API وجود ندارد.

کانال جهانی

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`Channel.channelId` .
نام	فیلد `Channel.displayName` .
ids_ids	بسته به نوع `owner` ، از طریق `advertisers.channels.sites.list` . channels.sites.List and `partners.channels.sites.list` قابل بازیابی است.
دسترسی به_ادولرز	در دسترس نیست.
is_deleted	در دسترس نیست.
is_brand_safe_channel	در دسترس نیست.

لیست کاربر

نام فیلد ERF	در دسترس بودن API DV360
شناسه	`FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId` .
نام	`FirstAndThirdPartyAudience.displayName` Field.
data_partner_id	در دسترس نیست.
دسترسی به_ادولرز	در دسترس نیست.
شریک زندگی	در دسترس نیست.
Advertiser_Pricings	در دسترس نیست.

این راهنما در مورد نحوه مهاجرت از فایل های خواندن نهاد به API Display & Video 360 توسط:

Giving an overview of the differences between the two interfaces
Comparing ERF tables to API services
Providing guidance on entity retrieval through the API
Acknowledging existing data gaps
Presenting a mapping of all ERF fields to comparable API resource fields

نمای کلی

When migrating from ERFs to the Display & Video 360 API, there are a number of key differences to consider, including:

Data freshness. ERFs are generated daily and in bulk while the API retrieves the most up-to-date version of a resource.
Resource structure. The API uses different JSON structures than ERF to represent the same resource types. Some resources, such as public targeting settings, may use a different ID space.
Retrieval method. The Display & Video 360 API only enables the retrieval of resources individually, in paginated lists, or through BigQuery data transfers, in contrast to the raw JSON files provided by ERF.
دامنه. As opposed to ERFs, which are scoped by partner ID, most API resources are scoped by advertiser ID. Resources included in responses are limited to resources within that scope.

ERF data representation in the API

Entity Read Files are separated into "Public" and "Private" tables. Public tables provide information that is available and applicable to all users, such as targeting values. Private tables provide data that is specific to a partner, such as creative or line item resources.

The Display & Video 360 API does not use this dichotomy, instead making all of this information retrievable through various services and using different JSON structures. This section compares the information provided through public and private ERF tables to that made available through Display & Video 360 API resources and services.

اطلاعات عمومی

ERF public tables provide reference materials for users to use when interpreting the targeting settings of their retrieved private resources and assigning targeting through a subset of Structured Data Files (SDFs) versions uploaded through the UI . These reference materials are the same for all users and consist of a numeric ID, used for mapping, and more descriptive details, such as a display name.

When using the Display & Video 360 API, targeting reference information can be retrieved through the targetingTypes.targetingOptions service. Similar to the public tables, this service provides the IDs and details of targeting options for a specific targeting type. Refer to our existing Set Targeting page for a code example demonstrating targeting option ID retrieval.

Public tables and SDFs

Before SDF v7 , Entity Read Files and Structured Data Files use the same ID space for targeting settings. If you are an SDF user using ERF public tables for interpreting or assigning targeting settings using SDF, you can instead download this reference material in CSV format through the Display & Video 360 UI.

Starting with v7 , the ID spaces used by a subset of Structured Data Files columns have been updated to decouple SDF from the ERFs and further align with Display & Video 360 API. See the v7 migration guide and reference documentation for more information.

Private resources

ERF private tables provide a daily snapshot of the current settings of private resources owned by a partner. Due to the sheer volume of resources that can be created under a single partner, these files can grow to be very large and difficult to download and process.

In the API, each private table has a corresponding service that provides endpoints for retrieval and management of that resource type. Resources can be retrieved in bulk using each service's respective list method. The JSON structure for each resource is different in the API compared to ERF, utilizing different field names and shared resources.

Certain information available in the ERF representation of a resource, such as a resource's assigned targeting settings or a channel's sites , are represented in the API as children of the original resource and must be retrieved through additional API requests.

Entity retrieval in the API

Display & Video 360 resources can either be retrieved through direct API requests or automatic imports into BigQuery .

Direct API requests

Each resource type is retrievable through a different API service. Resources can be retrieved individually or in bulk using the appropriate service's get or list method, respectively. Important properties of Display & Video 360 API list methods include:

Required scope. Unlike ERFs, which are scoped by partner , most resources in the API are scoped by advertiser . Retrieving all of a resource type, such as line items, under a partner may require an individual list request for each child advertiser of that partner. Exceptions include direct children of a partner, such as advertisers and partner-owned channels.
Pagination. API list methods employ pagination to guarantee that responses are within a reasonable size, limiting most individual request responses, or pages, to 100 resources. If the number of relevant resources is larger than the page size, consecutive list calls are required to retrieve subsequent pages of the full list response. A code example paging a list response is provided in a section of our Targeting guide page regarding retrieving available targeting options .
Additional requests required for targeting retrieval. A resource's targeting settings are not included in its API JSON object, but are instead child resources known as assigned targeting options . These child resources must be retrieved through a separate request. For example, for each line item retrieved through an advertisers.lineItems.list request, a separate advertisers.lineItems.bulkListAssignedTargetingOptions request must be made to retrieve all targeting information.

Optimize resource retrieval

The Display & Video 360 API may require multiple requests to retrieve the same amount of information that is available in a single Entity Read File. Optimizing how you retrieve resources can help retrieve the data you need more efficiently:

Make concurrent requests to the API. The Display & Video 360 API protects infrastructure using requests per advertiser per project rate limits . This quota structure lets you implement a multithreaded solution across multiple advertisers that will reduce the total time it takes to retrieve all necessary resources. Although pagination requires that all resources of a type within a certain scope are retrieved through consecutive calls, retrieval of resources within another scope or of another type can be done concurrently.
Utilize filters and order by parameters in your list calls to retrieve only relevant resources. For example, if you are only interested in line items that have been updated in the last day, you can use the filter parameter of the advertisers.lineItems.list method to only return line items with an updateTime greater than a given timestamp. This can significantly reduce the number of requests that need to be made.
Cache regularly used IDs to avoid unnecessary API requests. Certain reference information, such as targeting options IDs and Google Audience IDs, are relatively stable and can be safely stored to avoid the need for retrieval upon every use. However, cached values should be checked on a weekly basis to account for infrequent changes or deprecations.

See our Quota Optimization guide for more information on how to access the Display & Video 360 API efficiently.

Import into BigQuery

The Display & Video 360 API BigQuery Connector lets you automatically import Display & Video 360 resource configurations directly into BigQuery on a daily basis. The configurations are stored in BigQuery using Display & Video 360 API resource design. A subset of API resources are supported.

See the following cloud documentation for more information about using the Display & Video 360 API BigQuery Connector:

Known API data gaps

There are notable data gaps you might encounter when migrating from ERF to Display & Video 360 API, such as:

Story insertion orders. Story insertion orders are not retrievable through the API and must be retrieved through the Display & Video 360 UI.
A subset of resource fields. A small number of resource fields present in ERF objects are not available in the corresponding resources retrieved through the Display & Video 360 API.

Appendix: Mapping ERF Fields to API

Public table mapping

The tables below map the fields of ERF public tables to existing targeting types and targeting option fields in the Display & Video 360 API. Although the value of one field might map to another, that does not guarantee that they utilize the same data type, enum values, or ID space.

App Collection

Retrievable under targeting type TARGETING_TYPE_APP_CATEGORY .

ERF Field Name	DV360 API Availability
شناسه	`TargetingOption.targetingOptionId` field.
نام	`TargetingOption.appCategoryDetails.displayName` field.

مرورگر

Retrievable under targeting type TARGETING_TYPE_BROWSER .

ERF Field Name	DV360 API Availability
شناسه	`TargetingOption.targetingOptionId` field.
is_mobile	در دسترس نیست.
نام	`TargetingOption.browserDetails.displayName` field.

DataPartner

There is no equivalent resource or fields available in Display & Video 360 API.

DeviceCriteria

Retrievable under targeting types TARGETING_TYPE_OPERATING_SYSTEM , TARGETING_TYPE_DEVICE_MAKE_MODEL , and TARGETING_TYPE_DEVICE_TYPE .

ERF Field Name	DV360 API Availability
شناسه	`TargetingOption.targetingOptionId` field or `DeviceType` enum.
is_mobile	در دسترس نیست.
نام	`TargetingOption.operatingSystemDetails.displayName` field, `TargetingOption.deviceMakeModelDetails.displayName` field, or `DeviceType` enum, depending on targeting type.
criteria_type	`TargetingOption.targetingType` field.
operating_system_id	در دسترس نیست.
mobile_brand_name	در دسترس نیست.
mobile_model_name	در دسترس نیست.
mobile_make_model_id	در دسترس نیست.
device_type	`DeviceType` enum.

GeoLocation

Retrievable under targeting type TARGETING_TYPE_GEO_REGION .

ERF Field Name	DV360 API Availability
شناسه	`TargetingOption.targetingOptionId` field.
canonical_name	`TargetingOption.geoRegionDetails.displayName` field.
geo_name	در دسترس نیست.
country_code	در دسترس نیست.
region_code	در دسترس نیست.
city_name	در دسترس نیست.
postal_name	در دسترس نیست.
dma_code	در دسترس نیست.

ISP

Retrievable under targeting type TARGETING_TYPE_CARRIER_AND_ISP .

ERF Field Name	DV360 API Availability
شناسه	`TargetingOption.targetingOptionId` field.
is_mobile	در دسترس نیست.
نام	`TargetingOption.carrierAndIspDetails.displayName` field.
secondary_criteria_id	`TargetingOption.targetingOptionId` field.

زبان

Retrievable under targeting type TARGETING_TYPE_LANGUAGE .

ERF Field Name	DV360 API Availability
شناسه	`TargetingOption.targetingOptionId` field.
نام	در دسترس نیست. Full display name for a language is available at `TargetingOption.languageDetails.displayName` field.

SiteToPlacementId

There is no equivalent resource or fields available in Display & Video 360 API.

SupportedExchange

Retrievable under targeting type TARGETING_TYPE_EXCHANGE .

ERF Field Name	DV360 API Availability
شناسه	`Exchange` enum.
نام	`Exchange` enum.

UniversalSite

There is no equivalent resource or fields available in Display & Video 360 API. Individual sites and apps can be targeted directly under targeting types TARGETING_TYPE_URL and TARGETING_TYPE_APP , respectively. In Display & Video 360, any app or URL can be targeted, but not every app or URL can be reported on. If you would like to remove non-reportable apps and URLs from spending, follow the instructions on the DV360 Help Center .

Private table field mapping

The tables below map the fields of ERF private tables to existing fields or services in the Display & Video 360 API. Although the value of one field may map to another, that does not guarantee that they utilize the same data type, enum values or ID space.

تبلیغ کننده

ERF Field Name	DV360 API Availability
common_data.id	`Advertiser.advertiserId` field.
common_data.name	`Advertiser.displayName` field.
common_data.active	`Advertiser.entityStatus` field.
common_data.integration_code	`Advertiser.integrationDetails.integrationCode` field.
partner_id	`Advertiser.partnerId` field.
currency_code	`Advertiser.generalConfig.currencyCode` field.
timezone_code	`Advertiser.generalConfig.timeZone` field.
landing_page_url	`Advertiser.generalConfig.domainUrl` field.
available_channel_ids	Retrievable through `advertisers.channels.list` method.
blacklist_channel_id	Retrievable through `advertisers.targetingTypes.assignedtargetingOptions.list` method under targeting type `TARGETING_TYPE_CHANNEL` . If `AssignedTargetingOption.channelDetails.negative` is true, the channel is negatively-targeted.
dcm_configuration	در دسترس نیست.
dcm_network_id	`Advertiser.adServerConfig.cmHybridConfig.cmAccountId` field.
dcm_advertiser_id	The `Advertiser.adServerConfig.cmHybridConfig.cmAdvertiserIds` field lists the CM360 Advertiser IDs that share the CM360 Floodlight configuration.
dcm_floodlight_group_id	`Advertiser.adServerConfig.cmHybridConfig.cmFloodlightConfigId` field.
dcm_syncable_site_ids	`Advertiser.adServerConfig.cmHybridConfig.cmSyncableSiteIds` field.
enable_oba_tags	در دسترس نیست.

کمپین

ERF Field Name	DV360 API Availability
common_data.id	`Campaign.campaignId` field.
common_data.name	`Campaign.displayName` field.
common_data.active	`Campaign.entityStatus` field.
common_data.integration_code	در دسترس نیست.
advertiser_id	`Campaign.advertiserId` field.
بودجه	`Campaign.campaignFlight` and `Campaign.campaignBudgets` fields.
frequency_cap	`Campaign.frequencyCap` field.
default_target_list	Retrievable through `advertisers.campaigns.bulkListCampaignAssignedTargetingOptions` method.
uses_video_creatives	در دسترس نیست.
uses_display_creatives	در دسترس نیست.
uses_audio_creatives	در دسترس نیست.
هدف	`Campaign.campaignGoal.campaignGoalType` field.
متریک	`Campaign.campaignGoal.performanceGoal.performanceGoalType` field.
objective_description	`Campaign.campaignGoal.performanceGoal.performanceGoalString` field.
metric_amount_micros	`Campaign.campaignGoal.performanceGoal.performanceGoalAmountMicros` field.

خلاق

ERF Field Name	DV360 API Availability
common_data.id	`Creative.creativeId` field.
common_data.name	`Creative.displayName` field.
common_data.active	`Creative.entityStatus` field.
common_data.integration_code	`Creative.integrationCode` field.
advertiser_id	`Creative.advertiserId` field.
dcm_placement_id	`Creative.cmPlacementId` field.
width_pixels	`Creative.dimensions.widthPixels` field.
height_pixels	`Creative.dimensions.heightPixels` field.
approval_status	`Creative.reviewStatus` field.
expanding_direction	`Creative.expandingDirection` field.
creative_type	`Creative.creativeType` field.

CustomAffinity

ERF Field Name	DV360 API Availability
شناسه	`CustomList.customListId` field.
نام	`CustomList.displayName` field.
توضیحات	در دسترس نیست.
advertiser_id	در دسترس نیست.

FloodlightActivity

ERF Field Name	DV360 API Availability
common_data.id	`FloodlightActivity.floodlightActivityId` field.
common_data.name	`FloodlightActivity.displayName` field.
common_data.active	`FloodlightActivity.servingStatus` field.
common_data.integration_code	در دسترس نیست.
advertiser_id	The `FloodlightActivity.advertiserIds` field lists all advertisers with access to the floodlight activity under the given partner.
partner_id	Provided by the user when making a request to the `floodlightGroups.floodlightActivities` service.
remarketing_enabled	The `FloodlightActivity.remarketingConfigs` field lists this configuration for each advertiser with access to the floodlight activity under the given partner.
ssl_required	`FloodlightActivity.sslRequired` field.

InsertionOrder

ERF Field Name	DV360 API Availability
common_data.id	`InsertionOrder.insertionOrderId` field.
common_data.name	`InsertionOrder.displayName` field.
common_data.active	`InsertionOrder.entityStatus` field.
common_data.integration_code	`InsertionOrder.integrationDetails.integrationCode` field.
advertiser_id	`InsertionOrder.advertiserId` field.
campaign_id	`InsertionOrder.campaignId` field.
overall_budget	در دسترس نیست. Can be calculated using contents of the `InsertionOrder.budget.budgetSegments` field.
scheduled_segments	`InsertionOrder.budget.budgetSegments` field.
frequency_cap	`InsertionOrder.frequencyCap` field.
default_partner_costs	`InsertionOrder.partnerCosts` field.
default_target_list	Retrievable through `advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions` method.

InventorySource

ERF Field Name	DV360 API Availability
شناسه	`InventorySource.inventorySourceId` field.
طبقه بندی نشده	در دسترس نیست.
inventory_name	`InventorySource.displayName` field.
exchange_id	`InventorySource.exchange` field.
accessing_advertisers	`InventorySource.readWriteAccessors` and `InventorySource.readAdvertiserIds` fields.
external_id	`InventorySource.dealId` field.
min_cpm_micros	`InventorySource.rateDetails.rate.nanos` field, depending on the value of the `InventorySource.rateDetails.inventorySourceRateType` field.
min_cpm_currency_code	`InventorySource.rateDetails.rate.currencyCode` field.

LineItem

ERF Field Name	DV360 API Availability
common_data.id	`LineItem.lineItemId` field.
common_data.name	`LineItem.displayName` field.
common_data.active	`LineItem.entityStatus` field.
common_data.integration_code	`LineItem.integrationDetails.integrationCode` field.
line_item_type	`LineItem.lineItemType` field.
insertion_order_id	`LineItem.insertionOrderId` field.
creative_ids	`LineItem.creativeIds` field.
max_cpm_advertiser_micros	`LineItem.bidStrategy.maximizeSpendAutoBid.maxAverageCpmBidAmountMicros` or `LineItem.bidStrategy.performanceGoalAutoBid.maxAverageCpmBidAmountMicros` fields, depending on the strategy scheme used.
performance_goal	`LineItem.bidStrategy.maximizeSpendAutoBid.performanceGoalType` or `LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalType` fields, depending on the strategy scheme used.
goal_advertiser_micros	`LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalAmountMicros` field.
partner_revenue_model	`LineItem.partnerRevenueModel` field.
cost_tracking_pixels	`LineItem.conversionCounting.floodlightActivityConfigs` field.
budget.start_time_usec	`LineItem.flight.dateRange.startDate` field.
budget.end_time_usec	`LineItem.flight.dateRange.endDate` field.
budget.max_impressions	`LineItem.budget.maxAmount` field if `LineItem.budget.budgetUnit` is `BUDGET_UNIT_IMPRESSIONS` .
budget.max_spend_advertiser_micros	`LineItem.budget.maxAmount` field if `LineItem.budget.budgetUnit` is `BUDGET_UNIT_CURRENCY` .
budget.pacing_type	`LineItem.pacing.pacingPeriod` field.
budget.pacing_max_impressions	`LineItem.pacing.dailyMaxImpressions` field.
budget.pacing_max_spend_advertiser_micros	`LineItem.pacing.dailyMaxMicros` field.
budget.pacing_distribution	`LineItem.pacing.pacingType` field.
frequency_cap	`LineItem.frequencyCap` field.
partner_costs	`LineItem.partnerCosts` field.
target_list	Retrievable through `advertisers.lineItems.bulkListLineItemAssignedTargetingOptions` method.

NegativeKeywordList

ERF Field Name	DV360 API Availability
شناسه	`NegativeKeywordList.negativeKeywordListId` field.
نام	`NegativeKeywordList.displayName` field.
advertiser_id	`NegativeKeywordList.advertiserId` field.

شریک

ERF Field Name	DV360 API Availability
common_data.id	`Partner.partnerId` field.
common_data.name	`Partner.displayName` field.
common_data.active	`Partner.entityStatus` field.
common_data.integration_code	در دسترس نیست.
currency_code	`Partner.generalConfig.currencyCode` field.
exchange_settings	`Partner.exchangeConfig.enabledExchanges` field.
default_partner_costs	Not available.
default_partner_revenue	Not available.
default_target_list	Not available.

پیکسل

There is no equivalent resource or fields available in Display & Video 360 API.

UniversalChannel

ERF Field Name	DV360 API Availability
شناسه	`Channel.channelId` field.
نام	`Channel.displayName` field.
site_ids	Retrievable through `advertisers.channels.sites.list` and `partners.channels.sites.list` methods, depending on the type of `owner` .
accessing_advertisers	Not available.
is_deleted	Not available.
is_brand_safe_channel	Not available.

UserList

ERF Field Name	DV360 API Availability
شناسه	`FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId` field.
نام	`FirstAndThirdPartyAudience.displayName` field.
data_partner_id	Not available.
accessing_advertisers	Not available.
partner_pricing	Not available.
advertiser_pricings	Not available.