Миграция из файлов чтения сущностей

Файлы чтения объектов (ERF) — это JSON-представления объектов кампании партнера, которые по запросу генерируются ежедневно и становятся доступными через Google Cloud Storage .

Поддержка ERF была прекращена в июне 2021 года . С 31 октября 2024 года поддержка ERF официально прекратится и больше не будет создаваться. Всем существующим пользователям файла чтения объекта рекомендуется перейти на API Display & Video 360 , чтобы продолжить получение ресурсов Display & Video 360.

В этом руководстве описывается, как перейти с файлов Entity Read Files на API Display & Video 360, выполнив следующие действия:

  • Обзор различий между двумя интерфейсами
  • Сравнение таблиц ERF со службами API
  • Предоставление рекомендаций по извлечению объектов через API
  • Признание существующих пробелов в данных
  • Представление сопоставления всех полей ERF с сопоставимыми полями ресурсов API.

Обзор

При переходе с ERF на Display & Video 360 API необходимо учитывать ряд ключевых отличий, в том числе:

  • Свежесть данных. ERF генерируются ежедневно и массово, пока API получает самую последнюю версию ресурса.
  • Структура ресурса. API использует структуры JSON, отличные от ERF, для представления тех же типов ресурсов. Некоторые ресурсы, например настройки общедоступного таргетинга, могут использовать другое пространство идентификаторов.
  • Метод поиска. API Display & Video 360 позволяет извлекать ресурсы только по отдельности, в виде списков с разбивкой на страницы или посредством передачи данных BigQuery, в отличие от необработанных файлов JSON, предоставляемых ERF.
  • Объем. В отличие от ERF, область действия которых определяется идентификатором партнера, большинство ресурсов API ограничены идентификатором рекламодателя. Ресурсы, включенные в ответы, ограничены ресурсами в пределах этой области.

Представление данных ERF в API

Файлы чтения сущностей разделены на «Общедоступные» и «Частные» таблицы. Общедоступные таблицы предоставляют информацию, доступную и применимую для всех пользователей, например значения таргетинга. Частные таблицы предоставляют данные, специфичные для партнера, например ресурсы креативов или позиций.

API Display & Video 360 не использует эту дихотомию, вместо этого предоставляя возможность получения всей этой информации через различные сервисы и используя разные структуры JSON. В этом разделе сравнивается информация, предоставляемая через общедоступные и частные таблицы ERF, с информацией, доступной через ресурсы и сервисы API Display & Video 360.

Общественная информация

Публичные таблицы ERF предоставляют пользователям справочные материалы, которые они могут использовать при интерпретации настроек таргетинга полученных ими частных ресурсов и назначении таргетинга с помощью подмножества версий файлов структурированных данных (SDF) , загруженных через пользовательский интерфейс . Эти справочные материалы одинаковы для всех пользователей и состоят из числового идентификатора, используемого для сопоставления, и более описательных сведений, таких как отображаемое имя.

При использовании API Display & Video 360 справочную информацию о таргетинге можно получить через сервис targetingTypes.targetingOptions . Подобно общедоступным таблицам, этот сервис предоставляет идентификаторы и подробную информацию о параметрах таргетинга для определенного типа таргетинга. На нашей существующей странице «Настройка таргетинга» приведен пример кода, демонстрирующий получение идентификатора параметра таргетинга.

Публичные таблицы и SDF-файлы

До версии SDF v7 файлы чтения сущностей и файлы структурированных данных использовали одно и то же пространство идентификаторов для настроек таргетинга. Если вы являетесь пользователем SDF и используете общедоступные таблицы ERF для интерпретации или назначения настроек таргетинга с помощью SDF, вместо этого вы можете загрузить этот справочный материал в формате CSV через пользовательский интерфейс Display & Video 360.

Начиная с версии 7 , пространства идентификаторов, используемые подмножеством столбцов файлов структурированных данных, были обновлены, чтобы отделить SDF от ERF и обеспечить дальнейшее согласование с API Display & Video 360. Дополнительную информацию см. в руководстве по миграции на версию 7 и справочной документации .

Частные ресурсы

Частные таблицы ERF предоставляют ежедневный снимок текущих настроек частных ресурсов, принадлежащих партнеру. Из-за огромного объема ресурсов, которые могут быть созданы одним партнером, эти файлы могут стать очень большими, и их будет сложно загружать и обрабатывать.

В API каждой частной таблице соответствует соответствующий сервис, предоставляющий конечные точки для получения и управления этим типом ресурса. Ресурсы можно получить массово, используя соответствующий метод списка каждой службы. Структура JSON для каждого ресурса в API отличается от ERF, поскольку используются разные имена полей и общие ресурсы.

Определенная информация, доступная в представлении ресурса в формате ERF, например назначенные для ресурса настройки таргетинга или сайты канала, представлена ​​в API как дочерние элементы исходного ресурса и должна быть получена с помощью дополнительных запросов API.

Получение сущности в API

Ресурсы Display & Video 360 можно получить либо с помощью прямых запросов API, либо с помощью автоматического импорта в BigQuery .

Прямые запросы API

Каждый тип ресурса можно получить через отдельный сервис API. Ресурсы можно получать индивидуально или массово, используя метод get или list соответствующего сервиса соответственно. Важные свойства методов списка API Display & Video 360 включают в себя:

  • Требуемый объём. В отличие от ERF, область действия которых определяется партнером , большинство ресурсов в API регулируются рекламодателем . Для получения всех типов ресурсов, например позиций, в рамках партнера может потребоваться индивидуальный запрос списка для каждого дочернего рекламодателя этого партнера. Исключение составляют прямые дочерние элементы партнера, например рекламодатели и каналы, принадлежащие партнеру.
  • Пагинация. Методы списков API используют нумерацию страниц, чтобы гарантировать разумный размер ответов, ограничивая большинство отдельных ответов на запросы или страниц до 100 ресурсов. Если количество соответствующих ресурсов превышает размер страницы, требуются последовательные вызовы списка для получения последующих страниц ответа полного списка. Пример кода, разгружающий ответ списка, приведен в разделе нашей страницы руководства по таргетингу, посвященном получению доступных параметров таргетинга .
  • Для целевого извлечения требуются дополнительные запросы. Настройки таргетинга ресурса не включены в его объект API JSON, а являются дочерними ресурсами, известными как назначенные параметры таргетинга . Эти дочерние ресурсы необходимо получить с помощью отдельного запроса. Например, для каждой позиции, полученной с помощью запроса advertisers.lineItems.list , необходимо выполнить отдельный запрос advertisers.lineItems.bulkListAssignedTargetingOptions для получения всей информации о таргетинге.

Оптимизация извлечения ресурсов

API Display & Video 360 может потребовать несколько запросов для получения того же объема информации, который доступен в одном файле чтения объекта. Оптимизация способа получения ресурсов может помочь более эффективно извлекать нужные данные:

  • Выполняйте одновременные запросы к API. API Display & Video 360 защищает инфраструктуру, используя ограничения по ставкам для каждого рекламодателя и проекта . Эта структура квот позволяет реализовать многопоточное решение для нескольких рекламодателей, что сократит общее время, необходимое для получения всех необходимых ресурсов. Хотя разбиение на страницы требует, чтобы все ресурсы типа в определенной области извлекались посредством последовательных вызовов, извлечение ресурсов в другой области или другого типа может выполняться одновременно.
  • Используйте фильтры и упорядочивайте вызовы по параметрам в списке вызовов, чтобы получать только релевантные ресурсы. Например, если вас интересуют только те позиции, которые были обновлены за последний день, вы можете использовать параметр filter метода advertisers.lineItems.list , чтобы возвращать только те позиции, у которых значение updateTime превышает заданную временную метку. Это может значительно сократить количество запросов, которые необходимо сделать.
  • Кэшируйте регулярно используемые идентификаторы , чтобы избежать ненужных запросов к API. Определенная справочная информация, такая как идентификаторы параметров таргетинга и идентификаторы аудитории Google, относительно стабильна и может безопасно храниться, чтобы избежать необходимости ее извлечения при каждом использовании. Однако кэшированные значения следует проверять еженедельно, чтобы учесть нечастые изменения или устаревание.

Дополнительную информацию о том, как эффективно получить доступ к Display & Video 360 API, можно найти в нашем руководстве по оптимизации квот .

Импортировать в BigQuery

Коннектор BigQuery API Display & Video 360 позволяет ежедневно автоматически импортировать конфигурации ресурсов Display & Video 360 непосредственно в BigQuery . Конфигурации хранятся в BigQuery с использованием дизайна ресурсов API Display & Video 360. Поддерживается подмножество ресурсов API.

Дополнительную информацию об использовании коннектора BigQuery API Display & Video 360 см. в следующей облачной документации:

Известные пробелы в данных API

При переходе с ERF на API Display & Video 360 вы можете столкнуться с заметными пробелами в данных, например:

  • Заказы на размещение историй. Заказы на размещение историй невозможно получить через API, их необходимо получать через интерфейс Display & Video 360.
  • Подмножество полей ресурсов. Небольшое количество полей ресурсов, присутствующих в объектах ERF, недоступно в соответствующих ресурсах, полученных через API Display & Video 360.

Приложение. Сопоставление полей ERF с API

Сопоставление общедоступных таблиц

В таблицах ниже поля общедоступных таблиц ERF сопоставлены с существующими типами таргетинга и полями параметров таргетинга в Display & Video 360 API. Хотя значение одного поля может сопоставляться с другим, это не гарантирует, что они используют один и тот же тип данных, значения перечисления или пространство идентификаторов.

Коллекция приложений

Можно получить с типом таргетинга TARGETING_TYPE_APP_CATEGORY .

Имя поля ERF Доступность API DV360
идентификатор Поле TargetingOption.targetingOptionId .
имя Поле TargetingOption.appCategoryDetails.displayName .

Браузер

Можно получить с типом таргетинга TARGETING_TYPE_BROWSER .

Имя поля ERF Доступность API DV360
идентификатор Поле 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 Доступность API DV360
идентификатор Поле TargetingOption.targetingOptionId или перечисление DeviceType .
is_mobile Нет в наличии.
имя Поле TargetingOption.operatingSystemDetails.displayName , поле TargetingOption.deviceMakeModelDetails.displayName или перечисление DeviceType , в зависимости от типа таргетинга.
критерий_тип Поле TargetingOption.targetingType .
операционная_система_id Нет в наличии.
mobile_brand_name Нет в наличии.
mobile_model_name Нет в наличии.
mobile_make_model_id Нет в наличии.
тип_устройства Перечисление DeviceType .

Геолокация

Можно получить с типом таргетинга TARGETING_TYPE_GEO_REGION .

Имя поля ERF Доступность API DV360
идентификатор Поле TargetingOption.targetingOptionId .
каноническое_имя Поле TargetingOption.geoRegionDetails.displayName .
географическое_имя Нет в наличии.
код_страны Нет в наличии.
код_региона Нет в наличии.
название_города Нет в наличии.
почтовое_имя Нет в наличии.
dma_code Нет в наличии.

Интернет-провайдер

Можно получить с типом таргетинга TARGETING_TYPE_CARRIER_AND_ISP .

Имя поля ERF Доступность API DV360
идентификатор Поле TargetingOption.targetingOptionId .
is_mobile Нет в наличии.
имя Поле TargetingOption.carrierAndIspDetails.displayName .
Secondary_criteria_id Поле TargetingOption.targetingOptionId .

Язык

Можно получить с типом таргетинга TARGETING_TYPE_LANGUAGE .

Имя поля ERF Доступность API DV360
идентификатор Поле TargetingOption.targetingOptionId .
имя Нет в наличии. Полное отображаемое имя языка доступно в поле TargetingOption.languageDetails.displayName .

SiteToPlacementId

В API Display & Video 360 нет эквивалентного ресурса или полей.

ПоддерживаетсяExchange

Можно получить с типом таргетинга TARGETING_TYPE_EXCHANGE .

Имя поля ERF Доступность API DV360
идентификатор Exchange .
имя Exchange .

Универсальный сайт

В Display & Video 360 API нет эквивалентного ресурса или полей. На отдельные сайты и приложения можно настроить таргетинг непосредственно с помощью типов таргетинга TARGETING_TYPE_URL и TARGETING_TYPE_APP соответственно. В Display & Video 360 таргетингом можно настроить любое приложение или URL-адрес, но не о каждом приложении или URL-адресе можно сообщить. Если вы хотите исключить приложения и URL-адреса, не подлежащие отчетности, из расходов, следуйте инструкциям в Справочном центре DV360 .

Сопоставление полей частной таблицы

В таблицах ниже поля частных таблиц ERF сопоставлены с существующими полями или сервисами в API Display & Video 360. Хотя значение одного поля может сопоставляться с другим, это не гарантирует, что они используют один и тот же тип данных, значения перечисления или пространство идентификаторов.

Рекламодатель

Имя поля ERF Доступность API DV360
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 .
доступные_channel_ids Доступно с помощью метода advertisers.channels.list .
blacklist_channel_id Можно получить с помощью метода advertisers.targetingTypes.assignedtargetingOptions.list с типом таргетинга TARGETING_TYPE_CHANNEL . Если AssignedTargetingOption.channelDetails.negative имеет значение true, канал имеет отрицательную таргетинг.
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 Доступность API DV360
common_data.id Поле Campaign.campaignId .
common_data.name Поле Campaign.displayName .
common_data.active Поле Campaign.entityStatus .
common_data.integration_code Нет в наличии.
идентификатор_рекламодателя Поле Campaign.advertiserId .
бюджет Поля Campaign.campaignFlight и Campaign.campaignBudgets .
Frequency_cap Поле Campaign.frequencyCap . FrequencyCap.
default_target_list Можно получить с помощью метода advertisers.campaigns.bulkListCampaignAssignedTargetingOptions .
use_video_creatives Нет в наличии.
Uses_display_creatives Нет в наличии.
use_audio_creatives Нет в наличии.
цель Поле Campaign.campaignGoal.campaignGoalType .
метрика Поле Campaign.campaignGoal.performanceGoal.performanceGoalType . PerformanceGoalType.
Object_description Поле Campaign.campaignGoal.performanceGoal.performanceGoalString . PerformanceGoalString.
metric_amount_micros Поле Campaign.campaignGoal.performanceGoal.performanceGoalAmountMicros . PerformanceGoalAmountMicros.

Креатив

Имя поля ERF Доступность API DV360
common_data.id Поле Creative.creativeId .
common_data.name Поле Creative.displayName .
common_data.active Поле Creative.entityStatus .
common_data.integration_code Поле Creative.integrationCode .
идентификатор_рекламодателя Поле Creative.advertiserId .
dcm_placement_id Поле Creative.cmPlacementId .
ширина_пикселей Поле Creative.dimensions.widthPixels .
высота_пикселей Поле Creative.dimensions.heightPixels .
статус утверждения Поле Creative.reviewStatus .
расширяющееся_направление Поле Creative.expandingDirection .
творческий_тип Поле Creative.creativeType .

CustomAffinity

Имя поля ERF Доступность API DV360
идентификатор Поле CustomList.customListId .
имя Поле CustomList.displayName .
описание Нет в наличии.
идентификатор_рекламодателя Нет в наличии.

ПрожекторДеятельность

Имя поля ERF Доступность API DV360
common_data.id Поле FloodlightActivity.floodlightActivityId .
common_data.name Поле FloodlightActivity.displayName .
common_data.active Поле FloodlightActivity.servingStatus .
common_data.integration_code Нет в наличии.
идентификатор_рекламодателя В поле FloodlightActivity.advertiserIds перечислены все рекламодатели, имеющие доступ к действиям Floodlight под данным партнером.
Partner_id Предоставляется пользователем при запросе к сервису floodlightGroups.floodlightActivities .
ремаркетинг_включен В поле FloodlightActivity.remarketingConfigs указана эта конфигурация для каждого рекламодателя, имеющего доступ к действиям Floodlight под данным партнером.
ssl_required FloodlightActivity.sslRequired поле.

Порядок вставки

Имя поля ERF Доступность API DV360
common_data.id Поле InsertionOrder.insertionOrderId .
common_data.name Поле InsertionOrder.displayName .
common_data.active Поле InsertionOrder.entityStatus .
common_data.integration_code Поле InsertionOrder.integrationDetails.integrationCode .
идентификатор_рекламодателя Поле InsertionOrder.advertiserId .
идентификатор кампании Поле InsertionOrder.campaignId .
общий_бюджет Нет в наличии. Можно рассчитать, используя содержимое поля InsertionOrder.budget.budgetSegments .
запланированные_сегменты Поле InsertionOrder.budget.budgetSegments .
Frequency_cap Поле InsertionOrder.frequencyCap . FrequencyCap.
default_partner_costs Поле InsertionOrder.partnerCosts .
default_target_list Можно получить с помощью метода advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions .

Источник инвентаря

Имя поля ERF Доступность API DV360
идентификатор Поле InventorySource.inventorySourceId .
несекретный Нет в наличии.
имя_инвентаря Поле InventorySource.displayName .
обменный_ид Поле InventorySource.exchange .
accessing_advertisers Поля InventorySource.readWriteAccessors и InventorySource.readAdvertiserIds .
внешний_ид Поле InventorySource.dealId .
min_cpm_micros Поле InventorySource.rateDetails.rate.nanos в зависимости от значения поля InventorySource.rateDetails.inventorySourceRateType .
min_cpm_currency_code Поле InventorySource.rateDetails.rate.currencyCode .

Линейный элемент

Имя поля 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 .
вставка_order_id Поле LineItem.insertionOrderId .
Creative_ids Поле LineItem.creativeIds .
max_cpm_advertiser_micros Поля LineItem.bidStrategy.maximizeSpendAutoBid.maxAverageCpmBidAmountMicros или LineItem.bidStrategy.performanceGoalAutoBid.maxAverageCpmBidAmountMicros PerformanceGoalAutoBid.maxAverageCpmBidAmountMicros в зависимости от используемой схемы стратегии.
Performance_goal Поля LineItem.bidStrategy.maximizeSpendAutoBid.performanceGoalType PerformanceGoalType или LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalType PerformanceGoalAutoBid. PerformanceGoalType в зависимости от используемой схемы стратегии.
target_advertiser_micros Поле LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalAmountMicros . PerformanceGoalAmountMicros.
Partner_revenue_model Поле LineItem.partnerRevenueModel .
Cost_tracking_pixels Поле LineItem.conversionCounting.floodlightActivityConfigs .
Budget.start_time_usec Поле LineItem.flight.dateRange.startDate .
Budget.end_time_usec Поле LineItem.flight.dateRange.endDate .
Budget.max_impressions Поле LineItem.budget.maxAmount , если LineItem.budget.budgetUnit имеет значение BUDGET_UNIT_IMPRESSIONS .
Budget.max_spend_advertiser_micros Поле LineItem.budget.maxAmount , если LineItem.budget.budgetUnit имеет значение BUDGET_UNIT_CURRENCY .
Budget.pacing_type Поле LineItem.pacing.pacingPeriod .
Budget.pacing_max_impressions Поле LineItem.pacing.dailyMaxImpressions .
Budget.pacing_max_spend_advertiser_micros Поле LineItem.pacing.dailyMaxMicros .
Budget.pacing_distribution Поле LineItem.pacing.pacingType .
Frequency_cap Поле LineItem.frequencyCap . FrequencyCap.
Partner_costs Поле LineItem.partnerCosts .
целевой_список Можно получить с помощью метода advertisers.lineItems.bulkListLineItemAssignedTargetingOptions .

Список отрицательных ключевых слов

Имя поля ERF Доступность API DV360
идентификатор Поле NegativeKeywordList.negativeKeywordListId .
имя Поле NegativeKeywordList.displayName .
идентификатор_рекламодателя Поле NegativeKeywordList.advertiserId .

Партнер

Имя поля ERF Доступность API DV360
common_data.id Поле Partner.partnerId .
common_data.name Поле Partner.displayName .
common_data.active Поле Partner.entityStatus .
common_data.integration_code Нет в наличии.
код_валюты Поле Partner.generalConfig.currencyCode .
обмен_настройки Поле Partner.exchangeConfig.enabledExchanges .
default_partner_costs Нет в наличии.
default_partner_revenue Нет в наличии.
default_target_list Нет в наличии.

Пиксель

В API Display & Video 360 нет эквивалентного ресурса или полей.

Универсальный канал

Имя поля ERF Доступность API DV360
идентификатор Поле Channel.channelId .
имя Поле Channel.displayName .
site_ids Доступно для получения с помощью методов advertisers.channels.sites.list и partners.channels.sites.list , в зависимости от типа owner .
accessing_advertisers Нет в наличии.
is_deleted Нет в наличии.
is_brand_safe_channel Нет в наличии.

Список пользователей

Имя поля ERF Доступность API DV360
идентификатор Поле FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId .
имя Поле FirstAndThirdPartyAudience.displayName .
data_partner_id Нет в наличии.
accessing_advertisers Нет в наличии.
Partner_pricing Нет в наличии.
рекламодатель_цены Нет в наличии.
,

Файлы чтения объектов (ERF) — это JSON-представления объектов кампании партнера, которые по запросу генерируются ежедневно и становятся доступными через Google Cloud Storage .

Поддержка ERF прекращена в июне 2021 года . С 31 октября 2024 года поддержка ERF официально прекратится и больше не будет создаваться. Всем существующим пользователям файла чтения объекта рекомендуется перейти на API Display & Video 360 , чтобы продолжить получение ресурсов Display & Video 360.

В этом руководстве описывается, как перейти с файлов Entity Read Files на API Display & Video 360, выполнив следующие действия:

  • Обзор различий между двумя интерфейсами
  • Сравнение таблиц ERF со службами API
  • Предоставление рекомендаций по извлечению объектов через API
  • Признание существующих пробелов в данных
  • Представление сопоставления всех полей ERF с сопоставимыми полями ресурсов API.

Обзор

При переходе с ERF на Display & Video 360 API необходимо учитывать ряд ключевых отличий, в том числе:

  • Свежесть данных. ERF генерируются ежедневно и массово, пока API получает самую последнюю версию ресурса.
  • Структура ресурса. API использует структуры JSON, отличные от ERF, для представления тех же типов ресурсов. Некоторые ресурсы, например настройки общедоступного таргетинга, могут использовать другое пространство идентификаторов.
  • Метод поиска. API Display & Video 360 позволяет извлекать ресурсы только по отдельности, в виде списков с разбивкой на страницы или посредством передачи данных BigQuery, в отличие от необработанных файлов JSON, предоставляемых ERF.
  • Объем. В отличие от ERF, область действия которых определяется идентификатором партнера, большинство ресурсов API ограничены идентификатором рекламодателя. Ресурсы, включенные в ответы, ограничены ресурсами в пределах этой области.

Представление данных ERF в API

Файлы чтения сущностей разделены на «Общедоступные» и «Частные» таблицы. Публичные таблицы предоставляют информацию, доступную и применимую для всех пользователей, например значения таргетинга. Частные таблицы предоставляют данные, специфичные для партнера, например ресурсы креативов или позиций.

API Display & Video 360 не использует эту дихотомию, вместо этого предоставляя возможность получения всей этой информации через различные сервисы и используя разные структуры JSON. В этом разделе сравнивается информация, предоставляемая через общедоступные и частные таблицы ERF, с информацией, доступной через ресурсы и сервисы API Display & Video 360.

Общественная информация

Публичные таблицы ERF предоставляют пользователям справочные материалы, которые они могут использовать при интерпретации настроек таргетинга полученных ими частных ресурсов и назначении таргетинга с помощью подмножества версий файлов структурированных данных (SDF) , загруженных через пользовательский интерфейс . Эти справочные материалы одинаковы для всех пользователей и состоят из числового идентификатора, используемого для сопоставления, и более описательных сведений, таких как отображаемое имя.

При использовании API Display & Video 360 справочную информацию о таргетинге можно получить через сервис targetingTypes.targetingOptions . Подобно общедоступным таблицам, этот сервис предоставляет идентификаторы и подробную информацию о параметрах таргетинга для определенного типа таргетинга. На нашей существующей странице «Настройка таргетинга» приведен пример кода, демонстрирующий получение идентификатора параметра таргетинга.

Публичные таблицы и SDF-файлы

До версии SDF v7 файлы чтения сущностей и файлы структурированных данных использовали одно и то же пространство идентификаторов для настроек таргетинга. Если вы являетесь пользователем SDF и используете общедоступные таблицы ERF для интерпретации или назначения настроек таргетинга с помощью SDF, вместо этого вы можете загрузить этот справочный материал в формате CSV через пользовательский интерфейс Display & Video 360.

Начиная с версии 7 , пространства идентификаторов, используемые подмножеством столбцов файлов структурированных данных, были обновлены, чтобы отделить SDF от ERF и обеспечить дальнейшее согласование с API Display & Video 360. Дополнительную информацию см. в руководстве по миграции на версию 7 и справочной документации .

Частные ресурсы

Частные таблицы ERF предоставляют ежедневный снимок текущих настроек частных ресурсов, принадлежащих партнеру. Из-за огромного объема ресурсов, которые могут быть созданы одним партнером, эти файлы могут стать очень большими, и их будет сложно загружать и обрабатывать.

В API каждой частной таблице соответствует служба, предоставляющая конечные точки для получения и управления этим типом ресурса. Ресурсы можно получить массово, используя соответствующий метод списка каждой службы. Структура JSON для каждого ресурса в API отличается от ERF, поскольку используются разные имена полей и общие ресурсы.

Определенная информация, доступная в представлении ресурса в формате ERF, например назначенные для ресурса настройки таргетинга или сайты канала, представлена ​​в API как дочерние элементы исходного ресурса и должна быть получена с помощью дополнительных запросов API.

Получение сущности в API

Ресурсы Display & Video 360 можно получить либо с помощью прямых запросов API, либо с помощью автоматического импорта в BigQuery .

Прямые запросы API

Каждый тип ресурса можно получить через отдельный сервис API. Ресурсы можно получать индивидуально или массово, используя метод get или list соответствующего сервиса соответственно. Важные свойства методов списка API Display & Video 360 включают в себя:

  • Требуемый объем. В отличие от ERF, область действия которых определяется партнером , большинство ресурсов в API регулируются рекламодателем . Для получения всех типов ресурсов, например позиций, в рамках партнера может потребоваться индивидуальный запрос списка для каждого дочернего рекламодателя этого партнера. Исключение составляют прямые дочерние элементы партнера, например рекламодатели и каналы, принадлежащие партнеру.
  • Пагинация. Методы списков API используют нумерацию страниц, чтобы гарантировать разумный размер ответов, ограничивая большинство отдельных ответов на запросы или страниц до 100 ресурсов. Если количество соответствующих ресурсов превышает размер страницы, требуются последовательные вызовы списка для получения последующих страниц ответа полного списка. Пример кода для разбивки ответа по списку приведен в разделе нашей страницы руководства по таргетингу, посвященном получению доступных параметров таргетинга .
  • Для целевого извлечения требуются дополнительные запросы. Настройки таргетинга ресурса не включены в его объект API JSON, а являются дочерними ресурсами, известными как назначенные параметры таргетинга . Эти дочерние ресурсы необходимо получить с помощью отдельного запроса. Например, для каждой позиции, полученной с помощью запроса advertisers.lineItems.list , необходимо выполнить отдельный запрос advertisers.lineItems.bulkListAssignedTargetingOptions для получения всей информации о таргетинге.

Оптимизация извлечения ресурсов

API Display & Video 360 может потребовать несколько запросов для получения того же объема информации, который доступен в одном файле чтения объекта. Оптимизация способа получения ресурсов может помочь более эффективно извлекать нужные данные:

  • Выполняйте одновременные запросы к API. API Display & Video 360 защищает инфраструктуру, используя ограничения по ставкам для каждого рекламодателя и проекта . Эта структура квот позволяет реализовать многопоточное решение для нескольких рекламодателей, что сократит общее время, необходимое для получения всех необходимых ресурсов. Хотя разбиение на страницы требует, чтобы все ресурсы типа в определенной области извлекались посредством последовательных вызовов, извлечение ресурсов в другой области или другого типа может выполняться одновременно.
  • Используйте фильтры и упорядочивайте вызовы по параметрам в списке вызовов, чтобы получать только релевантные ресурсы. Например, если вас интересуют только те позиции, которые были обновлены за последний день, вы можете использовать параметр filter метода advertisers.lineItems.list , чтобы возвращать только те позиции, у которых значение updateTime превышает заданную временную метку. Это может значительно сократить количество запросов, которые необходимо сделать.
  • Кэшируйте регулярно используемые идентификаторы , чтобы избежать ненужных запросов к API. Определенная справочная информация, такая как идентификаторы параметров таргетинга и идентификаторы аудитории Google, относительно стабильна и может безопасно храниться, чтобы избежать необходимости ее извлечения при каждом использовании. Однако кэшированные значения следует проверять еженедельно, чтобы учесть нечастые изменения или устаревание.

Дополнительную информацию о том, как эффективно получить доступ к Display & Video 360 API, можно найти в нашем руководстве по оптимизации квот .

Импортировать в BigQuery

Коннектор BigQuery API Display & Video 360 позволяет ежедневно автоматически импортировать конфигурации ресурсов Display & Video 360 непосредственно в BigQuery . Конфигурации хранятся в BigQuery с использованием дизайна ресурсов API Display & Video 360. Поддерживается подмножество ресурсов API.

Дополнительную информацию об использовании коннектора BigQuery API Display & Video 360 см. в следующей облачной документации:

Известные пробелы в данных API

При переходе с ERF на API Display & Video 360 вы можете столкнуться с заметными пробелами в данных, например:

  • Заказы на размещение историй. Заказы на размещение историй невозможно получить через API, их необходимо получать через интерфейс Display & Video 360.
  • Подмножество полей ресурсов. Небольшое количество полей ресурсов, присутствующих в объектах ERF, недоступно в соответствующих ресурсах, полученных через API Display & Video 360.

Приложение. Сопоставление полей ERF с API

Сопоставление общедоступных таблиц

В таблицах ниже поля общедоступных таблиц ERF сопоставлены с существующими типами таргетинга и полями параметров таргетинга в Display & Video 360 API. Хотя значение одного поля может сопоставляться с другим, это не гарантирует, что они используют один и тот же тип данных, значения перечисления или пространство идентификаторов.

Коллекция приложений

Можно получить с типом таргетинга TARGETING_TYPE_APP_CATEGORY .

Имя поля ERF Доступность API DV360
идентификатор Поле TargetingOption.targetingOptionId .
имя Поле TargetingOption.appCategoryDetails.displayName .

Браузер

Можно получить с типом таргетинга TARGETING_TYPE_BROWSER .

Имя поля ERF Доступность API DV360
идентификатор Поле 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 Доступность API DV360
идентификатор Поле TargetingOption.targetingOptionId или перечисление DeviceType .
is_mobile Нет в наличии.
имя Поле TargetingOption.operatingSystemDetails.displayName , поле TargetingOption.deviceMakeModelDetails.displayName или перечисление DeviceType , в зависимости от типа таргетинга.
критерий_тип Поле TargetingOption.targetingType .
hoparing_system_id Нет в наличии.
mobile_brand_name Нет в наличии.
mobile_model_name Нет в наличии.
mobile_make_model_id Нет в наличии.
тип_устройства DeviceType enum.

Геолокация

Понимание при таргетинге типа TARGETING_TYPE_GEO_REGION .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
canonical_name TargetingOption.geoRegionDetails.displayName Field.
географическое_имя Нет в наличии.
код_страны Нет в наличии.
код_региона Нет в наличии.
название_города Нет в наличии.
postal_name Нет в наличии.
DMA_CODE Нет в наличии.

Интернет-провайдер

Понимание под целевым типом TARGETING_TYPE_CARRIER_AND_ISP .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
is_mobile Нет в наличии.
имя TargetingOption.carrierAndIspDetails.displayName Поле.
secondary_criteria_id TargetingOption.targetingOptionId Field.

Язык

Понимание под целевым типом TARGETING_TYPE_LANGUAGE .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
имя Нет в наличии. Полное отображающее имя для языка доступно на поле TargetingOption.languageDetails.displayName .

SiteToplehingId

Нет эквивалентных ресурсов или полей, доступных в API Display & Video 360.

Поддержка

Понимание при таргетировании типа TARGETING_TYPE_EXCHANGE .

Имя поля ERF Доступность API DV360
идентификатор Exchange enum.
имя Exchange enum.

Универсалит

Нет эквивалентных ресурсов или полей, доступных в API Display & Video 360. Отдельные сайты и приложения могут быть направлены непосредственно при таргетировании типов TARGETING_TYPE_URL и TARGETING_TYPE_APP , соответственно. В Display & Video 360 может быть представлено любое приложение или URL -адрес, но не все приложения или URL могут быть сообщены. Если вы хотите удалить не сообщаемые приложения и URL-адреса, следуйте инструкциям в справочном центре DV360 .

Частное картирование поля таблицы

Таблицы ниже картируют поля частных таблиц ERF в существующие поля или услуги в API Display & Video 360. Хотя значение одного поля может отображаться в другое, это не гарантирует, что они используют один и тот же тип данных, значения перечисления или идентификационное пространство.

Рекламодатель

Имя поля ERF Доступность API DV360
common_data.id Advertiser.advertiserId . Advertiserid Field.
common_data.name Advertiser.displayName Field.
common_data.active Advertiser.entityStatus Field.
common_data.integration_code Advertiser.integrationDetails.integrationCode .
Partner_id Advertiser.partnerId . Partnerid Field.
валюта_код Advertiser.generalConfig.currencyCode Поле.
timezone_code Advertiser.generalConfig.timeZone Field.
LANDING_PAGE_URL Advertiser.generalConfig.domainUrl Field.
Доступен_channel_ids Поиск через advertisers.channels.list .
blacklist_channel_id TARGETING_TYPE_CHANNEL через advertisers.targetingTypes.assignedtargetingOptions.list . Если AssignedTargetingOption.channelDetails.negative верно, канал негативно нацелен.
dcm_configuration Нет в наличии.
dcm_network_id Advertiser.adServerConfig.cmHybridConfig.cmAccountId Field.
dcm_advertiser_id В поле Advertiser.adServerConfig.cmHybridConfig.cmAdvertiserIds перечислены идентификаторы рекламодателя CM360, которые разделяют конфигурацию прожектора CM360.
dcm_floodlight_group_id Advertiser.adServerConfig.cmHybridConfig.cmFloodlightConfigId .
dcm_syncable_site_ids Advertiser.adServerConfig.cmHybridConfig.cmSyncableSiteIds Field.
enable_oba_tags Нет в наличии.

Кампания

Имя поля ERF Доступность API DV360
common_data.id Campaign.campaignId . Campainid Field.
common_data.name Campaign.displayName Field.
common_data.active Campaign.entityStatus Field.
common_data.integration_code Нет в наличии.
рекламодатель_ид Campaign.advertiserId . Advertiserid Field.
бюджет Campaign.campaignFlight и Campaign.campaignBudgets Поля.
частота_Кап Campaign.frequencyCap .
default_target_list Понимание через advertisers.campaigns.bulkListCampaignAssignedTargetingOptions Campaigns.bulklistcampaignassignedTargetingOptions Метод.
Использует_video_creatives Нет в наличии.
Использует_дисплей_CREATIVES Нет в наличии.
Использует_аудио_четтивы Нет в наличии.
цель Campaign.campaignGoal.campaignGoalType .
метрика Campaign.campaignGoal.performanceGoal.performanceGoalType .
Objective_description 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.
рекламодатель_ид Creative.advertiserId Field.
DCM_PLATICE_ID Creative.cmPlacementId Field.
width_pixels Creative.dimensions.widthPixels Field.
height_pixels Creative.dimensions.heightPixels Field.
approval_status Creative.reviewStatus Field.
Расширение Creative.expandingDirection Field.
creative_type Creative.creativeType Field.

Customaffinity

Имя поля ERF Доступность API DV360
идентификатор CustomList.customListId поле.
имя CustomList.displayName Поле.
описание Нет в наличии.
рекламодатель_ид Нет в наличии.

FlaylightActivity

Имя поля ERF Доступность API DV360
common_data.id FloodlightActivity.floodlightActivityId .
common_data.name FloodlightActivity.displayName Field.
common_data.active FloodlightActivity.servingStatus Field.
common_data.integration_code Нет в наличии.
рекламодатель_ид В поле FloodlightActivity.advertiserIds перечислены всех рекламодателей с доступом к активности прожектора в рамках данного партнера.
Partner_id Предоставлено пользователем при выполнении запроса на службу floodlightGroups.floodlightActivities .
ремонт_enabled Поле FloodlightActivity.remarketingConfigs перечисляет эту конфигурацию для каждого рекламодателя с доступом к деятельности по прожектору под руководством данного партнера.
ssl_required FloodlightActivity.sslRequired Field.

Вставка

Имя поля ERF Доступность API DV360
common_data.id InsertionOrder.insertionOrderId FIELD.
common_data.name InsertionOrder.displayName Field.
common_data.active InsertionOrder.entityStatus .
common_data.integration_code InsertionOrder.integrationDetails.integrationCode .
рекламодатель_ид InsertionOrder.advertiserId
идентификатор кампании InsertionOrder.campaignId FIELD.
over_budget Нет в наличии. Может быть рассчитано с использованием содержимого поля InsertionOrder.budget.budgetSegments .
graduled_segments InsertionOrder.budget.budgetSegments Field.
частота_Кап InsertionOrder.frequencyCap поле.
default_partner_costs InsertionOrder.partnerCosts FIELD.
default_target_list Понимание через advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions Метод.

Инвентарь

Имя поля ERF Доступность API DV360
идентификатор InventorySource.inventorySourceId Field.
несекретный Нет в наличии.
inventory_name InventorySource.displayName Field.
Exchange_id InventorySource.exchange Field.
accessing_advertisers InventorySource.readWriteAccessors и InventorySource.readAdvertiserIds .
внешний_ид InventorySource.dealId Field.
min_cpm_micros InventorySource.rateDetails.rate.nanos Field, в зависимости от значения InventorySource.rateDetails.inventorySourceRateType .
min_cpm_currency_code InventorySource.rateDetails.rate.currencyCode Поле.

LineItem

Имя поля ERF Доступность API DV360
common_data.id LineItem.lineItemId поле.
common_data.name LineItem.displayName Поле.
common_data.active LineItem.entityStatus field.
common_data.integration_code LineItem.integrationDetails.integrationCode .
line_item_type LineItem.lineItemType ПОЛЕ.
insertion_order_id LineItem.insertionOrderId Field.
Creative_ids LineItem.creativeIds Field.
max_cpm_advertiser_micros LineItem.bidStrategy.maximizeSpendAutoBid.maxAverageCpmBidAmountMicros или LineItem.bidStrategy.performanceGoalAutoBid.maxAverageCpmBidAmountMicros , в зависимости от используемой стратегической схемы.
performance_goal LineItem.bidStrategy.maximizeSpendAutoBid.performanceGoalType или LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalType , в зависимости от используемой стратегической схемы.
goot_advertiser_micros LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalAmountMicros Field.
partner_revenue_model LineItem.partnerRevenueModel Field.
COST_TRACKING_PIXELS LineItem.conversionCounting.floodlightActivityConfigs .
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 .
Бюджет.pacing_type LineItem.pacing.pacingPeriod Field.
Budget.pacing_max_impressions LineItem.pacing.dailyMaxImpressions Поле.
Budget.pacing_max_spend_advertiser_micros LineItem.pacing.dailyMaxMicros Field.
Бюджет.pacing_distribution LineItem.pacing.pacingType Поле.
частота_Кап LineItem.frequencyCap Field.
partner_costs LineItem.partnerCosts FIELD.
целевой_список Поиск через advertisers.lineItems.bulkListLineItemAssignedTargetingOptions LineItems.bulklistlineitemassignedTargetingOptions Метод.

OTEDKEENKIRDLIST

Имя поля ERF Доступность API DV360
идентификатор NegativeKeywordList.negativeKeywordListId поле.
имя NegativeKeywordList.displayName FEELD.
рекламодатель_ид NegativeKeywordList.advertiserId Field.

Партнер

Имя поля ERF Доступность API DV360
common_data.id Partner.partnerId Field.
common_data.name Partner.displayName Field.
common_data.active Partner.entityStatus Field.
common_data.integration_code Нет в наличии.
валюта_код Partner.generalConfig.currencyCode Поле.
Exchange_settings Partner.exchangeConfig.enabledExchanges Поле.
default_partner_costs Нет в наличии.
default_partner_revenue Нет в наличии.
default_target_list Нет в наличии.

Пиксель

Нет эквивалентных ресурсов или полей, доступных в API Display & Video 360.

UniversalChannel

Имя поля ERF Доступность API DV360
идентификатор Channel.channelId .
имя Channel.displayName .
site_ids Поиск через advertisers.channels.sites.list и partners.channels.sites.list Методы, в зависимости от типа owner .
accessing_advertisers Нет в наличии.
is_deleted Нет в наличии.
is_brand_safe_channel Нет в наличии.

Список пользователей

Имя поля ERF Доступность API DV360
идентификатор FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId Field.
имя FirstAndThirdPartyAudience.displayName Field.
data_partner_id Нет в наличии.
accessing_advertisers Нет в наличии.
partner_pricing Нет в наличии.
Advertiser_Pricings Нет в наличии.
,

Файлы чтения объектов (ERF) являются представлениями JSON об объектах кампании партнера, которые по запросу генерируются ежедневно и предоставляются через Google Cloud Storage .

ERF были устарели в июне 2021 года . Начиная с 31 октября 2024 года ERF официально будет закат и больше не генерируется. Всем существующим пользователям файлов считывания объектов рекомендуется перейти на API Display & Video 360 , чтобы продолжить поиск ресурсов Display & Video 360.

В этом руководстве обсуждается, как мигрировать из объекта чтения файлов на API Display & Video 360 by:

  • Давая обзор различий между двумя интерфейсами
  • Сравнение таблиц ERF с услугами API
  • Предоставление руководства по поиску сущности через API
  • Признание существующих пробелов данных
  • Представление картирования всех полей ERF с сопоставимыми областями ресурсов API

Обзор

При переходе из ERF на API Display & Video 360 существует ряд ключевых различий, в том числе:

  • Свежесть данных. ERF генерируются ежедневно и массовом, в то время как API извлекает самую современную версию ресурса.
  • Структура ресурсов. API использует различные структуры JSON, чем ERF, чтобы представлять одни и те же типы ресурсов. Некоторые ресурсы, такие как общедоступные настройки таргетирования, могут использовать другое пространство идентификатора.
  • Метод поиска. API Display & Video 360 позволяет только извлекать ресурсы в отдельности, в лицензионных списках или с помощью передачи данных BigQuery, в отличие от необработанных файлов JSON, предоставленных ERF.
  • Объем. В отличие от ERF, которые оцениваются идентификатором партнера, большинство ресурсов API оцениваются идентификатором рекламодателя. Ресурсы, включенные в ответы, ограничены ресурсами в рамках этой области.

Представление данных ERF в API

Файлы чтения объекта разделены на «общедоступные» и «частные» таблицы. Общественные таблицы предоставляют информацию, которая доступна и применима ко всем пользователям, например, таргетинг. Частные таблицы предоставляют данные, характерные для партнера, такие как креативные ресурсы или ресурсы.

API Display & Video 360 не использует эту дихотомию, вместо этого делает всю эту информацию, получая полученные через различные службы и используя различные структуры JSON. В этом разделе сравнивается информация, предоставленная с помощью государственных и частных таблиц ERF с тем, что предоставлена ​​с помощью ресурсов и услуг API Display & Video 360.

Общественная информация

Общественные таблицы ERF предоставляют пользователям справочные материалы для использования при интерпретации настроек таргетинга их полученных частных ресурсов и назначения таргетинга через подмножество структурированных файлов данных (SDFS) , загруженных через пользовательский интерфейс . Эти справочные материалы одинаковы для всех пользователей и состоят из числового идентификатора, используемого для отображения, и более описательных деталей, таких как имя отображения.

При использовании API Display & Video 360, таргетирование справочной информации может быть получена через службу targetingTypes.targetingOptions . Подобно общественным таблицам, эта служба предоставляет идентификаторы и детали вариантов таргетинга для конкретного типа таргетинга. Обратитесь к нашей существующей странице таргетинга SET для примера кода, демонстрирующего поиск параметра таргетинга.

Общественные таблицы и SDF

Перед SDF V7 файлы чтения объектов и структурированные файлы данных используют одно и то же пространство идентификатора для настройки нацеливания. Если вы являетесь пользователем SDF, использующим общественные таблицы ERF для интерпретации или назначения настройки таргетинга с использованием SDF, вы можете вместо этого загрузить этот справочный материал в формате CSV через пользовательский интерфейс Display & Video 360.

Начиная с V7 , были обновлены идентификационные пространства, используемые подмножеством столбцов структурированных файлов данных, были обновлены, чтобы отделить SDF от ERFS и дополнительно выровнять с API Display & Video 360. См. Руководство по миграции V7 и справочная документация для получения дополнительной информации.

Частные ресурсы

Частные таблицы ERF обеспечивают ежедневный снимок текущих настроек частных ресурсов, принадлежащих партнеру. Из -за огромного объема ресурсов, которые могут быть созданы под одним партнером, эти файлы могут стать очень большими и трудными для загрузки и обработки.

В API каждая частная таблица имеет соответствующую услугу, которая предоставляет конечные точки для поиска и управления этим типом ресурса. Ресурсы могут быть извлечены в объеме, используя соответствующий метод списка каждой службы. Структура JSON для каждого ресурса отличается в API по сравнению с ERF, используя различные имена поля и общие ресурсы.

Определенная информация, доступная в представлении ERF ресурса, такого как присвоенные настройки таргетинга ресурса или сайты канала, представлена ​​в API в качестве детей исходного ресурса и должна быть получена с помощью дополнительных запросов API.

Поиск объекта в API

Ресурсы Display & Video 360 могут быть извлечены либо с помощью прямых запросов API, либо автоматического импорта в BigQuery .

Прямые запросы API

Каждый тип ресурса получен через разные услуги API. Ресурсы могут быть извлечены индивидуально или объемом объемом, используя соответствующий метод получения или списка услуг соответственно. Важные свойства методов Display & Video 360 API включают в себя:

  • Требуется область применения. В отличие от ERF, которые подходят для партнера , большинство ресурсов в API охватывают рекламодатель . Получение всего типа ресурса, такого как элементы строки, в соответствии с партнером может потребоваться отдельный запрос на список для каждого ребенка рекламодателя этого партнера. Исключения включают прямых детей партнера, таких как рекламодатели и принадлежащие партнерам каналы.
  • Пагинация. Методы списка API Используют лиц, чтобы гарантировать, что ответы находятся в пределах разумного размера, ограничивая большинство отдельных ответов на запрос или страниц, до 100 ресурсов. Если количество соответствующих ресурсов больше, чем размер страницы, для извлечения последующих страниц полного ответа списка необходимы последовательные вызовы списков. Пример кода Paging Ответ списка предоставляется в разделе нашей страницы руководства по таргетированию, касающееся получения доступных вариантов таргетинга .
  • Дополнительные запросы, требуемые для нацеливания на поиск. Настройки таргетинга ресурса не включены в свой объект API JSON, а вместо этого являются дочерними ресурсами, известными как назначенные параметры таргетинга . Эти дочерние ресурсы должны быть извлечены по отдельному запросу. Например, для каждой строки, полученной через advertisers.lineItems.list LineItems.list, должен быть сделан отдельные advertisers.lineItems.bulkListAssignedTargetingOptions .

Оптимизировать поиск ресурсов

API Display & Video 360 может потребовать нескольких запросов для получения того же количества информации, которая доступна в одном файле чтения. Оптимизация того, как вы получаете ресурсы, может помочь получить данные, которые вам нужны более эффективно:

  • Сделайте параллельные запросы в API. API Display & Video 360 защищает инфраструктуру с использованием запросов на рекламодатель на лимиты проекта . Эта структура квот позволяет вам реализовать многопоточное решение для нескольких рекламодателей, которое сократит общее время, необходимое для получения всех необходимых ресурсов. Хотя страниц требует, чтобы все ресурсы типа в определенной области были получены с помощью последовательных вызовов, поиск ресурсов в другой сфере или другого типа может быть выполнен одновременно.
  • Используйте фильтры и заказ по параметрам в ваших списках, чтобы получить только соответствующие ресурсы. Например, если вы заинтересованы только в позициях, которые были обновлены в последний день, вы можете использовать параметр filter advertisers.lineItems.list Метод для возврата линейки только с помощью updateTime , превышающего данную временную метку. Это может значительно сократить количество запросов, которые необходимо сделать.
  • Кэш регулярно использует идентификаторы , чтобы избежать ненужных запросов API. Некоторая справочная информация, такая как идентификаторы вариантов нацеливания и идентификаторы аудитории Google, являются относительно стабильными и могут быть безопасно храниться, чтобы избежать необходимости поиска при каждом использовании. Тем не менее, кэшированные значения должны проводиться еженедельно для учета нечастых изменений или детективаций.

См. Наше руководство по оптимизации квот для получения дополнительной информации о том, как эффективно получить доступ к API Display & Video 360.

Импортировать в BigQuery

Connector API BigQuery Display и Video 360 позволяет автоматически импортировать конфигурации ресурсов Display & Video 360 непосредственно в BigQuery ежедневно. Конфигурации хранятся в BigQuery с использованием дизайна ресурсов API Display & Video 360. Подмножество ресурсов API поддерживается.

См. Следующую облачную документацию для получения дополнительной информации об использовании разъема Display & Video 360 BigQuery:

Известные пробелы данных API

Существуют заметные пробелы данных, с которыми вы можете столкнуться при переходе из ERF на отображение и видео 360, например:

  • Заказы в вставке истории. Заказы на введение истории не могут быть получены через API и должны быть извлечены через интерфейс и видео 360.
  • Подмножество полей ресурсов. Небольшое количество полей ресурсов, присутствующих в объектах ERF, недоступно в соответствующих ресурсах, полученных через API Display & Video 360.

Приложение: отображение поля ERF в API

Общественное картирование таблицы

Таблицы ниже картируют поля публичных таблиц ERF с существующими типами таргетинга и полями опции таргетинга в API Display & Video 360. Хотя значение одного поля может отображаться в другом, это не гарантирует, что они используют один и тот же тип данных, значения перечисления или идентификационное пространство.

Приложения коллекция

Понимание под целевым типом TARGETING_TYPE_APP_CATEGORY .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
имя TargetingOption.appCategoryDetails.displayName Поле.

Браузер

Понимание при таргетировании типа TARGETING_TYPE_BROWSER .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
is_mobile Нет в наличии.
имя TargetingOption.browserDetails.displayName Field.

DataPartner

Нет эквивалентных ресурсов или полей, доступных в API Display & Video 360.

Devicecriteria

Понимание при таргетировании TARGETING_TYPE_OPERATING_SYSTEM , TARGETING_TYPE_DEVICE_MAKE_MODEL и TARGETING_TYPE_DEVICE_TYPE .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field или DeviceType enum.
is_mobile Нет в наличии.
имя TargetingOption.operatingSystemDetails.displayName Поле, TargetingOption.deviceMakeModelDetails.displayName или DeviceType enum, в зависимости от типа таргетинга.
критерий_тип TargetingOption.targetingType Field.
hoping_system_id Нет в наличии.
mobile_brand_name Нет в наличии.
mobile_model_name Нет в наличии.
mobile_make_model_id Нет в наличии.
тип_устройства DeviceType enum.

Геолокация

Понимание при таргетинге типа TARGETING_TYPE_GEO_REGION .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
canonical_name TargetingOption.geoRegionDetails.displayName Field.
географическое_имя Нет в наличии.
код_страны Нет в наличии.
код_региона Нет в наличии.
название_города Нет в наличии.
postal_name Нет в наличии.
DMA_CODE Нет в наличии.

Интернет-провайдер

Понимание под целевым типом TARGETING_TYPE_CARRIER_AND_ISP .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
is_mobile Нет в наличии.
имя TargetingOption.carrierAndIspDetails.displayName Поле.
secondary_criteria_id TargetingOption.targetingOptionId Field.

Язык

Понимание под целевым типом TARGETING_TYPE_LANGUAGE .

Имя поля ERF Доступность API DV360
идентификатор TargetingOption.targetingOptionId Field.
имя Нет в наличии. Полное отображающее имя для языка доступно на поле TargetingOption.languageDetails.displayName .

SiteToplehingId

Нет эквивалентных ресурсов или полей, доступных в API Display & Video 360.

Поддержка

Понимание при таргетировании типа TARGETING_TYPE_EXCHANGE .

Имя поля ERF Доступность API DV360
идентификатор Exchange enum.
имя Exchange enum.

Универсалит

Нет эквивалентных ресурсов или полей, доступных в API Display & Video 360. Отдельные сайты и приложения могут быть направлены непосредственно при таргетировании типов TARGETING_TYPE_URL и TARGETING_TYPE_APP , соответственно. В Display & Video 360 может быть представлено любое приложение или URL -адрес, но не все приложения или URL могут быть сообщены. Если вы хотите удалить не сообщаемые приложения и URL-адреса, следуйте инструкциям в справочном центре DV360 .

Частное картирование поля таблицы

Таблицы ниже картируют поля частных таблиц ERF в существующие поля или услуги в API Display & Video 360. Хотя значение одного поля может отображаться в другое, это не гарантирует, что они используют один и тот же тип данных, значения перечисления или идентификационное пространство.

Рекламодатель

Имя поля ERF Доступность API DV360
common_data.id Advertiser.advertiserId . Advertiserid Field.
common_data.name Advertiser.displayName Field.
common_data.active Advertiser.entityStatus Field.
common_data.integration_code Advertiser.integrationDetails.integrationCode .
Partner_id Advertiser.partnerId . Partnerid Field.
валюта_код Advertiser.generalConfig.currencyCode Поле.
timezone_code Advertiser.generalConfig.timeZone Field.
LANDING_PAGE_URL Advertiser.generalConfig.domainUrl Field.
Доступен_channel_ids Поиск через advertisers.channels.list .
blacklist_channel_id TARGETING_TYPE_CHANNEL через advertisers.targetingTypes.assignedtargetingOptions.list . Если AssignedTargetingOption.channelDetails.negative верно, канал негативно нацелен.
dcm_configuration Нет в наличии.
dcm_network_id Advertiser.adServerConfig.cmHybridConfig.cmAccountId Field.
dcm_advertiser_id В поле Advertiser.adServerConfig.cmHybridConfig.cmAdvertiserIds перечислены идентификаторы рекламодателя CM360, которые разделяют конфигурацию прожектора CM360.
dcm_floodlight_group_id Advertiser.adServerConfig.cmHybridConfig.cmFloodlightConfigId .
dcm_syncable_site_ids Advertiser.adServerConfig.cmHybridConfig.cmSyncableSiteIds Field.
enable_oba_tags Нет в наличии.

Кампания

Имя поля ERF Доступность API DV360
common_data.id Campaign.campaignId . Campainid Field.
common_data.name Campaign.displayName Field.
common_data.active Campaign.entityStatus Field.
common_data.integration_code Нет в наличии.
рекламодатель_ид Campaign.advertiserId . Advertiserid Field.
бюджет Campaign.campaignFlight и Campaign.campaignBudgets Поля.
частота_Кап Campaign.frequencyCap .
default_target_list Понимание через advertisers.campaigns.bulkListCampaignAssignedTargetingOptions Campaigns.bulklistcampaignassignedTargetingOptions Метод.
Использует_video_creatives Нет в наличии.
Использует_дисплей_CREATIVES Нет в наличии.
Использует_аудио_четтивы Нет в наличии.
цель Campaign.campaignGoal.campaignGoalType .
метрика Campaign.campaignGoal.performanceGoal.performanceGoalType .
Objective_description 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.
рекламодатель_ид Creative.advertiserId Field.
DCM_PLATICE_ID Creative.cmPlacementId Field.
width_pixels Creative.dimensions.widthPixels Field.
height_pixels Creative.dimensions.heightPixels Field.
approval_status Creative.reviewStatus Field.
Расширение Creative.expandingDirection Field.
creative_type Creative.creativeType Field.

Customaffinity

Имя поля ERF Доступность API DV360
идентификатор CustomList.customListId поле.
имя CustomList.displayName Поле.
описание Нет в наличии.
рекламодатель_ид Нет в наличии.

FlaylightActivity

Имя поля ERF Доступность API DV360
common_data.id FloodlightActivity.floodlightActivityId .
common_data.name FloodlightActivity.displayName Field.
common_data.active FloodlightActivity.servingStatus Field.
common_data.integration_code Нет в наличии.
рекламодатель_ид В поле FloodlightActivity.advertiserIds перечислены всех рекламодателей с доступом к активности прожектора в рамках данного партнера.
Partner_id Предоставлено пользователем при выполнении запроса на службу floodlightGroups.floodlightActivities .
ремонт_enabled Поле FloodlightActivity.remarketingConfigs перечисляет эту конфигурацию для каждого рекламодателя с доступом к деятельности по прожектору под руководством данного партнера.
ssl_required FloodlightActivity.sslRequired Field.

Вставка

Имя поля ERF Доступность API DV360
common_data.id InsertionOrder.insertionOrderId FIELD.
common_data.name InsertionOrder.displayName Field.
common_data.active InsertionOrder.entityStatus .
common_data.integration_code InsertionOrder.integrationDetails.integrationCode .
рекламодатель_ид InsertionOrder.advertiserId
идентификатор кампании InsertionOrder.campaignId FIELD.
over_budget Нет в наличии. Может быть рассчитано с использованием содержимого поля InsertionOrder.budget.budgetSegments .
graduled_segments InsertionOrder.budget.budgetSegments Field.
частота_Кап InsertionOrder.frequencyCap поле.
default_partner_costs InsertionOrder.partnerCosts FIELD.
default_target_list Понимание через advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions Метод.

Инвентарь

Имя поля ERF Доступность API DV360
идентификатор InventorySource.inventorySourceId Field.
несекретный Нет в наличии.
inventory_name InventorySource.displayName Field.
Exchange_id InventorySource.exchange Field.
accessing_advertisers InventorySource.readWriteAccessors и InventorySource.readAdvertiserIds .
внешний_ид InventorySource.dealId Field.
min_cpm_micros InventorySource.rateDetails.rate.nanos Field, в зависимости от значения InventorySource.rateDetails.inventorySourceRateType .
min_cpm_currency_code InventorySource.rateDetails.rate.currencyCode Поле.

LineItem

Имя поля ERF Доступность API DV360
common_data.id LineItem.lineItemId поле.
common_data.name LineItem.displayName Поле.
common_data.active LineItem.entityStatus field.
common_data.integration_code LineItem.integrationDetails.integrationCode .
line_item_type LineItem.lineItemType ПОЛЕ.
insertion_order_id LineItem.insertionOrderId Field.
Creative_ids LineItem.creativeIds Field.
max_cpm_advertiser_micros LineItem.bidStrategy.maximizeSpendAutoBid.maxAverageCpmBidAmountMicros или LineItem.bidStrategy.performanceGoalAutoBid.maxAverageCpmBidAmountMicros , в зависимости от используемой стратегической схемы.
performance_goal LineItem.bidStrategy.maximizeSpendAutoBid.performanceGoalType или LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalType , в зависимости от используемой стратегической схемы.
goot_advertiser_micros LineItem.bidStrategy.performanceGoalAutoBid.performanceGoalAmountMicros Field.
partner_revenue_model LineItem.partnerRevenueModel Field.
COST_TRACKING_PIXELS LineItem.conversionCounting.floodlightActivityConfigs .
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 .
Бюджет.pacing_type LineItem.pacing.pacingPeriod Field.
Budget.pacing_max_impressions LineItem.pacing.dailyMaxImpressions Поле.
Budget.pacing_max_spend_advertiser_micros LineItem.pacing.dailyMaxMicros Field.
Бюджет.pacing_distribution LineItem.pacing.pacingType Поле.
частота_Кап LineItem.frequencyCap Field.
partner_costs LineItem.partnerCosts FIELD.
целевой_список Поиск через advertisers.lineItems.bulkListLineItemAssignedTargetingOptions LineItems.bulklistlineitemassignedTargetingOptions Метод.

OTEDKEENKIRDLIST

Имя поля ERF Доступность API DV360
идентификатор NegativeKeywordList.negativeKeywordListId поле.
имя NegativeKeywordList.displayName FEELD.
рекламодатель_ид NegativeKeywordList.advertiserId Field.

Партнер

Имя поля ERF Доступность API DV360
common_data.id Partner.partnerId Field.
common_data.name Partner.displayName Field.
common_data.active Partner.entityStatus Field.
common_data.integration_code Нет в наличии.
валюта_код Partner.generalConfig.currencyCode Поле.
Exchange_settings Partner.exchangeConfig.enabledExchanges Поле.
default_partner_costs Нет в наличии.
default_partner_revenue Нет в наличии.
default_target_list Нет в наличии.

Пиксель

Нет эквивалентных ресурсов или полей, доступных в API Display & Video 360.

UniversalChannel

Имя поля ERF Доступность API DV360
идентификатор Channel.channelId .
имя Channel.displayName .
site_ids Поиск через advertisers.channels.sites.list и partners.channels.sites.list Методы, в зависимости от типа owner .
accessing_advertisers Нет в наличии.
is_deleted Нет в наличии.
is_brand_safe_channel Нет в наличии.

Список пользователей

Имя поля ERF Доступность API DV360
идентификатор FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId Field.
имя FirstAndThirdPartyAudience.displayName Field.
data_partner_id Нет в наличии.
accessing_advertisers Нет в наличии.
partner_pricing Нет в наличии.
Advertiser_Pricings Нет в наличии.
,

Файлы чтения объектов (ERF) являются представлениями JSON об объектах кампании партнера, которые по запросу генерируются ежедневно и предоставляются через Google Cloud Storage .

ERF были устарели в июне 2021 года . Начиная с 31 октября 2024 года ERF официально будет закат и больше не генерируется. Всем существующим пользователям файлов считывания объектов рекомендуется перейти на API Display & Video 360 , чтобы продолжить поиск ресурсов Display & Video 360.

В этом руководстве обсуждается, как мигрировать из объекта чтения файлов на API Display & Video 360 by:

  • Давая обзор различий между двумя интерфейсами
  • Сравнение таблиц ERF с услугами API
  • Предоставление руководства по поиску сущности через API
  • Признание существующих пробелов данных
  • Представление картирования всех полей ERF с сопоставимыми областями ресурсов API

Обзор

При переходе из ERF на API Display & Video 360 существует ряд ключевых различий, в том числе:

  • Свежесть данных. ERF генерируются ежедневно и массовом, в то время как API извлекает самую современную версию ресурса.
  • Структура ресурсов. 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.
  • Пагинация. 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.
критерий_тип TargetingOption.targetingType field.
operating_system_id Нет в наличии.
mobile_brand_name Нет в наличии.
mobile_model_name Нет в наличии.
mobile_make_model_id Нет в наличии.
тип_устройства 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.
географическое_имя Нет в наличии.
код_страны Нет в наличии.
код_региона Нет в наличии.
название_города Нет в наличии.
postal_name Нет в наличии.
dma_code Нет в наличии.

Интернет-провайдер

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.
идентификатор кампании 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.
внешний_ид 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.
целевой_список 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 Нет в наличии.
default_partner_revenue Нет в наличии.
default_target_list Нет в наличии.

Пиксель

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 Нет в наличии.
is_deleted Нет в наличии.
is_brand_safe_channel Нет в наличии.

Список пользователей

ERF Field Name DV360 API Availability
идентификатор FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId field.
имя FirstAndThirdPartyAudience.displayName field.
data_partner_id Нет в наличии.
accessing_advertisers Нет в наличии.
partner_pricing Нет в наличии.
advertiser_pricings Нет в наличии.